Arangodump Options

Usage: arangodump [<options>]

Global Options

NameTypeDescription
batch-sizeuint64 Maximum size for individual data batches (in bytes).
Default: 67108864
collectionstring... Restrict to collection name (can be specified multiple times).
Default: []
configurationstring The configuration file or 'none'.
Default: ""
dump-databoolean Dump collection data.
Default: true
forceboolean Continue dumping even in the face of some server-side errors.
Default: false
ignore-distribute-shards-like-errorsboolean Continue dump even if sharding prototype collection is not backed up along.
Default: false
include-system-collectionsboolean Include system collections.
Default: false
initial-batch-sizeuint64 Initial size for individual data batches (in bytes).
Default: 8388608
output-directorystring Output directory.
Default: "/oskar/work/ArangoDB/dump"
overwriteboolean Overwrite data in output directory.
Default: false
progressboolean Show progress.
Default: true
threadsuint32 Maximum number of collections to process in parallel.
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.
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.
Default: true
log.escapeboolean Escape characters when logging.
Default: true
log.levelstring... The global or topic-specific log level.
Default: ["info"]
log.outputstring... Log destination(s).
Default: []
log.roleboolean Log server role.
Default: false
log.use-local-timeboolean Use local timezone instead of UTC.
Default: false
log.use-microtimeboolean Use microtime instead.
Default: false

Server Options

NameTypeDescription
server.authenticationboolean Require authentication credentials when connecting (does not affect the server-side authentication settings).
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.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.