Options | arangodump | Programs & Tools | Manual

arangodump Options

Usage: arangodump [<options>]

General

Name	Type	Description
`all-databases`	boolean	Dump data of all databases This option can be specified without value to enable it. Default: `false` Introduced in: v3.5.0
`batch-size`	uint64	Maximum size for individual data batches (in bytes) Default: `67108864`
`check-configuration`	boolean	Check the configuration and exit This is a command, no value needs to be specified. The process terminates after executing the command.
`collection`	string…	Restrict to collection name (can be specified multiple times) Default: `[]`
`compress-output`	boolean	Compress files containing collection contents using gzip format (not compatible with encryption) This option can be specified without value to enable it. Default: `true` Introduced in: v3.4.6
`config`	string	The configuration file or ‘none’ Default: `""`
`configuration`	string	The configuration file or ‘none’ Default: `""`
`define`	string…	Define key=value for a @key@ entry in config file Default: `[]`
`dump-data`	boolean	Dump collection data This option can be specified without value to enable it. Default: `true`
`dump-dependencies`	boolean	Dump dependency graph This is a command, no value needs to be specified. The process terminates after executing the command.
`dump-options`	boolean	Dump configuration options in JSON format This is a command, no value needs to be specified. The process terminates after executing the command.
`envelope`	boolean	Wrap each document into a {type, data} envelope (this is required from compatibility with v3.7 and before) This option can be specified without value to enable it. Default: `false` Introduced in: v3.8.0
`force`	boolean	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-errors`	boolean	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-collections`	boolean	Include system collections This option can be specified without value to enable it. Default: `false`
`initial-batch-size`	uint64	Initial size for individual data batches (in bytes) Default: `8388608`
`log`	string…	The global or topic-specific log level Default: `["info"]` Deprecated in: v3.5.0
`maskings`	string	File with maskings definition Default: `""` Introduced in: v3.3.22, v3.4.2
`output-directory`	string	Output directory Default: `"/work/ArangoDB/dump"`
`overwrite`	boolean	Overwrite data in output directory This option can be specified without value to enable it. Default: `false`
`progress`	boolean	Show progress This option can be specified without value to enable it. Default: `true`
`shard`	string…	Restrict dump to shard (can be specified multiple times) Default: `[]` Introduced in: v3.8.0
`threads`	uint32	Maximum number of collections/shards to process in parallel Default: dynamic (e.g. `36`) Introduced in: v3.4.0
`tick-end`	uint64	Last tick to be included in data dump Default: `0`
`tick-start`	uint64	Only include data after this tick Default: `0`
`version`	boolean	Reports the version and exits This is a command, no value needs to be specified. The process terminates after executing the command.
`version-json`	boolean	Reports the version as JSON and exits This is a command, no value needs to be specified. The process terminates after executing the command. Introduced in: v3.9.0

Encryption

Name	Type	Description
`encryption.key-generator`	string	Enterprise Edition only Program providing the encryption key on stdout. If set, encryption will be enabled. Default: `""`
`encryption.keyfile`	string	Enterprise Edition only File containing the encryption key. If set, encryption will be enabled. Default: `""`

Log

Name	Type	Description
`log.color`	boolean	Use colors for TTY logging This option can be specified without value to enable it. Default: dynamic (e.g. `true`)
`log.escape-control-chars`	boolean	Escape control characters when logging This option can be specified without value to enable it. Default: `true` Introduced in: v3.9.0
`log.escape-unicode-chars`	boolean	Escape unicode characters when logging This option can be specified without value to enable it. Default: `false` Introduced in: v3.9.0
`log.file`	string	Shortcut for ‘--log.output file://' Default: `"-"`
`log.file-group`	string	Group to use for new log file, user must be a member of this group Default: `""` Introduced in: v3.4.5
`log.file-mode`	string	Mode to use for new log file, umask will be applied as well Default: `""` Introduced in: v3.4.5
`log.force-direct`	boolean	Do not start a seperate thread for logging This option can be specified without value to enable it. Default: `false`
`log.foreground-tty`	boolean	Also log to tty if backgrounded This option can be specified without value to enable it. Default: dynamic (e.g. `false`)
`log.hostname`	string	Hostname to use in log message (empty for none, use ‘auto’ to automatically figure out hostname) Default: `""` Introduced in: v3.8.0
`log.ids`	boolean	Log unique message ids This option can be specified without value to enable it. Default: `true` Introduced in: v3.5.0
`log.level`	string…	The global or topic-specific log level Default: `["info"]`
`log.line-number`	boolean	Include the function name, file name and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]` This option can be specified without value to enable it. Default: `false`
`log.max-entry-length`	uint32	Maximum length of a log entry (in bytes) Default: `134217728` Introduced in: v3.7.9
`log.output`	string…	Log destination(s), e.g. file:///path/to/file (any ‘$PID’ will be replaced with the process id) Default: `[]`
`log.performance`	boolean	Shortcut for ‘--log.level performance=trace’ This option can be specified without value to enable it. Default: `false` Deprecated in: v3.5.0
`log.prefix`	string	Prefix log message with this string Default: `""`
`log.process`	boolean	Show process identifier (pid) in log message This option can be specified without value to enable it. Default: `true` Introduced in: v3.8.0
`log.request-parameters`	boolean	Include full URLs and HTTP request parameters in trace logs This option can be specified without value to enable it. Default: `true`
`log.role`	boolean	Log server role This option can be specified without value to enable it. Default: `false`
`log.shorten-filenames`	boolean	Shorten filenames in log output (use with --log.line-number) This option can be specified without value to enable it. Default: `true`
`log.structured-param`	string…	Toggle usage of log category parameter in structured log messages Default: `[]` Introduced in: v3.10.0
`log.thread`	boolean	Show thread identifier in log message This option can be specified without value to enable it. Default: `false`
`log.thread-name`	boolean	Show thread name in log message This option can be specified without value to enable it. Default: `false`
`log.time-format`	string	Time format to use in logs Default: `"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-json-format`	boolean	Use json output format This option can be specified without value to enable it. Default: `false` Introduced in: v3.8.0
`log.use-local-time`	boolean	Use local timezone instead of UTC This option can be specified without value to enable it. Default: `false` Deprecated in: v3.5.0
`log.use-microtime`	boolean	Use microtime instead This option can be specified without value to enable it. Default: `false` Deprecated in: v3.5.0

Random

Name	Type	Description
`random.generator`	uint32	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

Name	Type	Description
`server.ask-jwt-secret`	boolean	If this option is specified, the user will be prompted for a JWT secret. This option is not compatible with --server.username or --server.password. If specified, it will be used for all connections - even when a new connection to another server is created This option can be specified without value to enable it. Default: `false`
`server.authentication`	boolean	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-timeout`	double	Connection timeout in seconds Default: `5`
`server.database`	string	Database name to use when connecting Default: `"_system"`
`server.endpoint`	string…	Endpoint to connect to. Use ‘none’ to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix:// Default: `["http+tcp://127.0.0.1:8529"]`
`server.jwt-secret-keyfile`	string	If this option is specified, the jwt secret will be loaded from the given file. This option is not compatible with --server.ask-jwt-secret, --server.username or --server.password. If specified, it will be used for all connections - even when a new connection to another server is created Default: `""`
`server.max-packet-size`	uint64	Maximum packet size (in bytes) for client/server communication Default: `1073741824`
`server.password`	string	Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password Default: `""`
`server.request-timeout`	double	Request timeout in seconds Default: `1200`
`server.username`	string	Username to use when connecting Default: `"root"`

SSL

Name	Type	Description
`ssl.protocol`	uint64	Ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS) Default: `5` Possible values: 1, 2, 3, 4, 5, 6, 9

Notes

Encryption Option Details

Dump encryption is only available in the Enterprise Edition, including ArangoDB Oasis.

--encryption.keyfile path-of-keyfile

The file path-to-keyfile must contain the encryption key. This file must be secured, so that only arangodump, arangorestore, and arangod 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.

❮ Examples Maskings ❯