Arangodump Options

Usage: arangodump [<options>]

Global

NameTypeDescription
all-databasesbooleanDump data of all databasesThis option can be specified without value to enable it.Default: falseIntroduced in: v3.5.0
batch-sizeuint64Maximum size for individual data batches (in bytes)Default: 67108864
check-configurationbooleanCheck the configuration and exitThis is a command, no value needs to be specified. The process terminates after executing the command.
collectionstring…Restrict to collection name (can be specified multiple times)Default: []
compress-outputbooleanCompress files containing collection contents using gzip formatThis option can be specified without value to enable it.Default: trueIntroduced in: v3.4.6, v3.5.0
configstringThe configuration file or ‘none’Default: ""
configurationstringThe configuration file or ‘none’Default: ""
definestring…Define key=value for a @key@ entry in config fileDefault: []
dump-databooleanDump collection dataThis option can be specified without value to enable it.Default: true
dump-dependenciesbooleanDump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command.
dump-optionsbooleanDump configuration options in JSON formatThis is a command, no value needs to be specified. The process terminates after executing the command.
forcebooleanContinue dumping even in the face of some server-side errorsThis option can be specified without value to enable it.Default: false
ignore-distribute-shards-like-errorsbooleanContinue dump even if sharding prototype collection is not backed up alongThis option can be specified without value to enable it.Default: false
include-system-collectionsbooleanInclude system collectionsThis option can be specified without value to enable it.Default: false
initial-batch-sizeuint64Initial size for individual data batches (in bytes)Default: 8388608
logstring…The global or topic-specific log levelDefault: ["info"]Deprecated in: v3.5.0
maskingsstringFile with maskings definitionDefault: ""Introduced in: v3.3.22, v3.4.2
output-directorystringOutput directoryDefault: "/work/ArangoDB/dump"
overwritebooleanOverwrite data in output directoryThis option can be specified without value to enable it.Default: false
progressbooleanShow progressThis option can be specified without value to enable it.Default: true
threadsuint32Maximum number of collections to process in parallel. From v3.4.0Default: 2
tick-enduint64Last tick to be included in data dumpDefault: 0
tick-startuint64Only include data after this tickDefault: 0
versionbooleanReports the version and exitsThis is a command, no value needs to be specified. The process terminates after executing the command.

Encryption

NameTypeDescription
encryption.key-generatorstring_Enterprise Edition only_Program providing the encryption key on stdout. If set, encryption will be enabled.Default: ""
encryption.keyfilestring_Enterprise Edition only_File containing the encryption key. If set, encryption will be enabled.Default: ""

Log

NameTypeDescription
log.colorbooleanUse colors for TTY loggingThis option can be specified without value to enable it.Default: dynamic (e.g. true)
log.escapebooleanEscape characters when loggingThis option can be specified without value to enable it.Default: true
log.filestringShortcut for ‘—log.output file://'Default: &#34;-&#34;
log.file-groupstringGroup to use for new log file, user must be a member of this groupDefault: ""Introduced in: v3.4.5, v3.5.0
log.file-modestringMode to use for new log file, umask will be applied as wellDefault: ""Introduced in: v3.4.5, v3.5.0
log.force-directbooleanDo not start a seperate thread for loggingThis option can be specified without value to enable it.Default: false
log.foreground-ttybooleanAlso log to tty if backgroundedThis option can be specified without value to enable it.Default: dynamic (e.g. false)
log.idsbooleanLog unique message idsThis option can be specified without value to enable it.Default: trueIntroduced in: v3.5.0
log.keep-logrotatebooleanKeep the old log file after receiving a sighupThis option can be specified without value to enable it.Default: false
log.levelstring…The global or topic-specific log levelDefault: ["info"]
log.line-numberbooleanAppend line number and file nameThis option can be specified without value to enable it.Default: false
log.outputstring…Log destination(s), e.g. file:///path/to/file (Linux, macOS) or file://C:\path\to\file (Windows)Default: []
log.performancebooleanShortcut for ‘—log.level performance=trace’This option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.prefixstringPrefix log message with this stringDefault: ""
log.request-parametersbooleanInclude full URLs and HTTP request parameters in trace logsThis option can be specified without value to enable it.Default: true
log.rolebooleanLog server roleThis option can be specified without value to enable it.Default: false
log.shorten-filenamesbooleanShorten filenames in log output (use with —log.line-number)This option can be specified without value to enable it.Default: true
log.threadbooleanShow thread identifier in log messageThis option can be specified without value to enable it.Default: false
log.thread-namebooleanShow thread name in log messageThis option can be specified without value to enable it.Default: false
log.time-formatstringTime format to use in logsDefault: "utc-datestring"Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis”Introduced in: v3.5.0
log.use-local-timebooleanUse local timezone instead of UTCThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.use-microtimebooleanUse microtime insteadThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0

Random

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

Server

NameTypeDescription
server.authenticationbooleanRequire 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-timeoutdoubleConnection timeout in secondsDefault: 5
server.databasestringDatabase name to use when connectingDefault: "_system"
server.endpointstringEndpoint to connect to. Use ‘none’ to start without a server. Use http+ssl:// or vst+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp://, vst+tcp:// or unix://Default: "http+tcp://127.0.0.1:8529"
server.force-jsonbooleanForce to not use VelocyPack for easier debuggingThis option can be specified without value to enable it.Default: falseIntroduced in: v3.6.0
server.max-packet-sizeuint64Maximum packet size (in bytes) for client/server communicationDefault: 1073741824
server.passwordstringPassword to use when connecting. If not specified and authentication is required, the user will be prompted for a passwordDefault: ""
server.request-timeoutdoubleRequest timeout in secondsDefault: 1200
server.usernamestringUsername to use when connectingDefault: "root"

SSL

NameTypeDescription
ssl.protocoluint64Ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS)Default: 5Possible values: 1, 2, 3, 4, 5, 6, 9

Notes

Encryption Option Details

Dump encryption is only available in theEnterprise Edition,also available as managed service.

—encryption.keyfile path-of-keyfile

The file path-to-keyfile must contain the encryption key. Thisfile 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 beable to read the file. For example, by encrypting /mytmpfs orcreating 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 outputand exit. The encryption keyfile must contain 32 bytes of data.