ArangoDB v3.4 reached End of Life (EOL) and is no longer supported.
This documentation is outdated. Please see the most recent version here: Latest Docs
Arangodump Options
Usage: arangodump [<options>]
General
| Name | Type | Description |
|---|---|---|
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 This option can be specified without value to enable it. Default: falseIntroduced in: v3.4.6, v3.5.0 |
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. |
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"] |
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 |
threads |
uint32 | Maximum number of collections to process in parallel. From v3.4.0 Default: 2 |
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. |
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.api-enabled |
string | Whether the log api is enabled (true) or not (false), or only enabled for superuser JWT (jwt) Default: "true"Introduced in: v3.4.11, v3.5.6, v3.6.5 |
log.color |
boolean | Use colors for TTY logging This option can be specified without value to enable it. Default: true |
log.escape |
boolean | Escape characters when logging This option can be specified without value to enable it. Default: true |
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, v3.5.0 |
log.file-mode |
string | Mode to use for new log file, umask will be applied as well Default: ""Introduced in: v3.4.5, v3.5.0 |
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: false |
log.keep-logrotate |
boolean | Keep the old log file after receiving a sighup This option can be specified without value to enable it. Default: false |
log.level |
string… | The global or topic-specific log level Default: ["info"] |
log.line-number |
boolean | Append line number and file name This option can be specified without value to enable it. Default: false |
log.output |
string… | Log destination(s) Default: [] |
log.performance |
boolean | Shortcut for ‘--log.level performance=trace’ This option can be specified without value to enable it. Default: false |
log.prefix |
string | Prefix log message with this string Default: "" |
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.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.use-local-time |
boolean | Use local timezone instead of UTC This option can be specified without value to enable it. Default: false |
log.use-microtime |
boolean | Use microtime instead This option can be specified without value to enable it. Default: false |
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: 1Possible values: 1, 2, 3, 4 |
Server
| Name | Type | Description |
|---|---|---|
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:// 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.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, 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2) Default: 5Possible values: 1, 2, 3, 4, 5 |
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 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.