arangodump Options

Usage: arangodump [<options>]

General

--all-databases

Introduced in: v3.5.0

Type: boolean

Dump data of all databases

This option can be specified without a value to enable it.

Default: false

--batch-size

Type: uint64

Maximum size for individual data batches (in bytes)

Default: 67108864

--check-configuration

Type: boolean

Check the configuration and exit

This is a command, no value needs to be specified. The process terminates after executing the command.

--collection

Type: string…

Restrict to collection name (can be specified multiple times)

Default: []

--compress-output

Introduced in: v3.4.6

Type: boolean

Compress files containing collection contents using gzip format (not compatible with encryption)

This option can be specified without a value to enable it.

Default: true

--config

Type: string

The configuration file or 'none'

Default: ""

--configuration

Type: string

The configuration file or 'none'

Default: ""

--define

Type: string…

Define key=value for a @key@ entry in config file

Default: []

--dump-data

Type: boolean

Dump collection data

This option can be specified without a value to enable it.

Default: true

--dump-dependencies

Type: boolean

Dump dependency graph

This is a command, no value needs to be specified. The process terminates after executing the command.

--dump-options

Type: 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

Introduced in: v3.8.0

Type: 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 a value to enable it.

Default: true

--force

Type: boolean

Continue dumping even in the face of some server-side errors

This option can be specified without a value to enable it.

Default: false

--ignore-distribute-shards-like-errors

Type: boolean

Continue dump even if sharding prototype collection is not backed up along

This option can be specified without a value to enable it.

Default: false

--include-system-collections

Type: boolean

Include system collections

This option can be specified without a value to enable it.

Default: false

--initial-batch-size

Type: uint64

Initial size for individual data batches (in bytes)

Default: 8388608

--log

Deprecated in: v3.5.0

Type: string…

The global or topic-specific log level

Default: ["info"]

--maskings

Introduced in: v3.3.22, v3.4.2

Type: string

File with maskings definition

Default: ""

--output-directory

Type: string

Output directory

Default: "/work/ArangoDB/dump"

--overwrite

Type: boolean

Overwrite data in output directory

This option can be specified without a value to enable it.

Default: false

--progress

Type: boolean

Show progress

This option can be specified without a value to enable it.

Default: true

--shard

Introduced in: v3.8.0

Type: string…

Restrict dump to shard (can be specified multiple times)

Default: []

--threads

Introduced in: v3.4.0

Type: uint32

Maximum number of collections/shards to process in parallel

Default: 2

--tick-end

Type: uint64

Last tick to be included in data dump

Default: 0

--tick-start

Type: uint64

Only include data after this tick

Default: 0

--version

Type: boolean

Reports the version and exits

This is a command, no value needs to be specified. The process terminates after executing the command.

Encryption

--encryption.key-generator

Enterprise Edition only

Type: string

Program providing the encryption key on stdout. If set, encryption will be enabled.

Default: ""

--encryption.keyfile

Enterprise Edition only

Type: string

File containing the encryption key. If set, encryption will be enabled.

Default: ""

Log

--log.color

Type: boolean

Use colors for TTY logging

This option can be specified without a value to enable it.

Default: dynamic (e.g. true)

--log.escape

Type: boolean

Escape characters when logging

This option can be specified without a value to enable it.

Default: true

--log.file

Type: string

Shortcut for '--log.output file://<filename>'

Default: "-"

--log.file-group

Introduced in: v3.4.5

Type: string

Group to use for new log file, user must be a member of this group

Default: ""

--log.file-mode

Introduced in: v3.4.5

Type: string

Mode to use for new log file, umask will be applied as well

Default: ""

--log.force-direct

Type: boolean

Do not start a seperate thread for logging

This option can be specified without a value to enable it.

Default: false

--log.foreground-tty

Type: boolean

Also log to tty if backgrounded

This option can be specified without a value to enable it.

Default: dynamic (e.g. false)

--log.hostname

Introduced in: v3.8.0

Type: string

Hostname to use in log message (empty for none, use 'auto' to automatically figure out hostname)

Default: ""

--log.ids

Introduced in: v3.5.0

Type: boolean

Log unique message ids

This option can be specified without a value to enable it.

Default: true

--log.level

Type: string…

The global or topic-specific log level

Default: ["info"]

--log.line-number

Type: 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 a value to enable it.

Default: false

--log.max-entry-length

Introduced in: v3.7.9

Type: uint32

Maximum length of a log entry (in bytes)

Default: 134217728

--log.output

Type: string…

Log destination(s), e.g. file:///path/to/file (any '$PID' will be replaced with the process id)

Default: []

--log.performance

Deprecated in: v3.5.0

Type: boolean

Shortcut for '--log.level performance=trace'

This option can be specified without a value to enable it.

Default: false

--log.prefix

Type: string

Prefix log message with this string

Default: ""

--log.process

Introduced in: v3.8.0

Type: boolean

Show process identifier (pid) in log message

This option can be specified without a value to enable it.

Default: true

--log.request-parameters

Type: boolean

Include full URLs and HTTP request parameters in trace logs

This option can be specified without a value to enable it.

Default: true

--log.role

Type: boolean

Log server role

This option can be specified without a value to enable it.

Default: false

--log.shorten-filenames

Type: boolean

Shorten filenames in log output (use with --log.line-number)

This option can be specified without a value to enable it.

Default: true

--log.thread

Type: boolean

Show thread identifier in log message

This option can be specified without a value to enable it.

Default: false

--log.thread-name

Type: boolean

Show thread name in log message

This option can be specified without a value to enable it.

Default: false

--log.time-format

Introduced in: v3.5.0

Type: 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”

--log.use-json-format

Introduced in: v3.8.0

Type: boolean

Use json output format

This option can be specified without a value to enable it.

Default: false

--log.use-local-time

Deprecated in: v3.5.0

Type: boolean

Use local timezone instead of UTC

This option can be specified without a value to enable it.

Default: false

--log.use-microtime

Deprecated in: v3.5.0

Type: boolean

Use microtime instead

This option can be specified without a value to enable it.

Default: false

Random

--random.generator

Type: 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

--server.ask-jwt-secret

Type: 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 a value to enable it.

Default: false

--server.authentication

Type: boolean

Require authentication credentials when connecting (does not affect the server-side authentication settings)

This option can be specified without a value to enable it.

Default: false

--server.connection-timeout

Type: double

Connection timeout in seconds

Default: 5

--server.database

Type: string

Database name to use when connecting

Default: "_system"

--server.endpoint

Type: 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.force-json

Introduced in: v3.6.0

Type: boolean

Force to not use VelocyPack for easier debugging

This option can be specified without a value to enable it.

Default: false

--server.jwt-secret-keyfile

Type: 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

Type: uint64

Maximum packet size (in bytes) for client/server communication

Default: 1073741824

--server.password

Type: 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

Type: double

Request timeout in seconds

Default: 1200

--server.username

Type: string

Username to use when connecting

Default: "root"

SSL

--ssl.protocol

Type: 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

--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.