Arangodump Options

Usage: arangodump [<options>]

Global Options

NameTypeDescription
batch-sizeuint64 Maximum size for individual data batches (in bytes).
Default: 67108864
check-configurationboolean Check the configuration and exit.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
collectionstring... Restrict to collection name (can be specified multiple times).
Default: []
configstring The configuration file or 'none'.
Default: ""
configurationstring The configuration file or 'none'.
Default: ""
definestring... Define key=value for a @key@ entry in config file.
Default: []
dump-databoolean Dump collection data.
This option can be specified without value to enable it.
Default: true
dump-dependenciesboolean Dump dependency graph.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
dump-optionsboolean Dump configuration options in JSON format.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: true
forceboolean Continue dumping even in the face of some server-side errors.
This option can be specified without value to enable it.
Default: false
ignore-distribute-shards-like-errorsboolean Continue dump even if sharding prototype collection is not backed up along.
This option can be specified without value to enable it.
Default: false
include-system-collectionsboolean Include system collections.
This option can be specified without value to enable it.
Default: false
initial-batch-sizeuint64 Initial size for individual data batches (in bytes).
Default: 8388608
logstring... The global or topic-specific log level.
Default: ["info"]
maskingsstring File with maskings definition.
Default: ""
Introduced in: v3.3.22, v3.4.2
output-directorystring Output directory.
Default: "/oskar/work/ArangoDB/dump"
overwriteboolean Overwrite data in output directory.
This option can be specified without value to enable it.
Default: false
progressboolean Show progress.
This option can be specified without value to enable it.
Default: true
threadsuint32 Maximum number of collections to process in parallel. From v3.4.0.
Default: 2
tick-enduint64 Last tick to be included in data dump.
Default: 0
tick-startuint64 Only include data after this tick.
Default: 0
versionboolean Reports the version and exits.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false

Encryption Options

NameTypeDescription
encryption.key-generatorstringEnterprise Edition only
Program providing the encryption key on stdout. If set, encryption will be enabled.
Default: ""
encryption.keyfilestringEnterprise Edition only
File containing the encryption key. If set, encryption will be enabled.
Default: ""

Log Options

NameTypeDescription
log.colorboolean Use colors for TTY logging.
This option can be specified without value to enable it.
Default: true
log.escapeboolean Escape characters when logging.
This option can be specified without value to enable it.
Default: true
log.filestring Shortcut for '--log.output file://<filename>'.
Default: "-"
log.force-directboolean Do not start a seperate thread for logging.
This option can be specified without value to enable it.
Default: false
log.foreground-ttyboolean Also log to tty if backgrounded.
This option can be specified without value to enable it.
Default: false
log.keep-logrotateboolean Keep the old log file after receiving a sighup.
This option can be specified without value to enable it.
Default: false
log.levelstring... The global or topic-specific log level.
Default: ["info"]
log.line-numberboolean Append line number and file name.
This option can be specified without value to enable it.
Default: false
log.outputstring... Log destination(s).
Default: []
log.performanceboolean Shortcut for '--log.level performance=trace'.
This option can be specified without value to enable it.
Default: false
log.prefixstring Prefix log message with this string.
Default: ""
log.request-parametersboolean Include full URLs and HTTP request parameters in trace logs.
This option can be specified without value to enable it.
Default: true
log.roleboolean Log server role.
This option can be specified without value to enable it.
Default: false
log.shorten-filenamesboolean Shorten filenames in log output (use with --log.line-number).
This option can be specified without value to enable it.
Default: true
log.threadboolean Show thread identifier in log message.
This option can be specified without value to enable it.
Default: false
log.thread-nameboolean Show thread name in log message.
This option can be specified without value to enable it.
Default: false
log.use-local-timeboolean Use local timezone instead of UTC.
This option can be specified without value to enable it.
Default: false
log.use-microtimeboolean Use microtime instead.
This option can be specified without value to enable it.
Default: false

Random Options

NameTypeDescription
random.generatoruint32 Random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only).
Default: 1
Possible values:
  • 1
  • 2
  • 3
  • 4

Server Options

NameTypeDescription
server.authenticationboolean Require authentication credentials when connecting (does not affect the server-side authentication settings).
This option can be specified without value to enable it.
Default: false
server.connection-timeoutdouble Connection timeout in seconds.
Default: 5
server.databasestring Database name to use when connecting.
Default: "_system"
server.endpointstring Endpoint to connect to, use 'none' to start without a server.
Default: "http+tcp://127.0.0.1:8529"
server.max-packet-sizeuint64 Maximum packet size (in bytes) for client/server communication.
Default: 1073741824
server.passwordstring Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password.
Default: ""
server.request-timeoutdouble Request timeout in seconds.
Default: 1200
server.usernamestring Username to use when connecting.
Default: "root"

Ssl Options

NameTypeDescription
ssl.protocoluint64 Ssl protocol (1 = SSLv2, 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2).
Default: 5
Possible values:
  • 1
  • 2
  • 3
  • 4
  • 5

Notes

Encryption Option Details

This feature is only available in the Enterprise Edition

--encryption.keyfile path-of-keyfile

The file path-to-keyfile must contain the encryption key. This file must be secured, so that only arangodump or arangorestore can access it. You should also ensure that in case someone steals your hardware, they will not be able to read the file. For example, by encrypting /mytmpfs or creating an in-memory file-system under /mytmpfs. The encryption keyfile must contain 32 bytes of data.

--encryption.key-generator path-to-my-generator

This output is used if you want to use the program to generate your encryption key. The program path-to-my-generator must output the encryption on standard output and exit. The encryption keyfile must contain 32 bytes of data.