ArangoDB v3.10 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent stable version.

arangodump Options

The startup options of the arangodump executable

arangodump Options

Usage: arangodump [<options>]

General

--all-databases

Introduced in: v3.5.0

Type: boolean

Whether to dump all databases.

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


--batch-size

Type: uint64

The 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 the dump to this collection name (can be specified multiple times).


--compress-output

Introduced in: v3.4.6

Type: boolean

Compress files containing collection contents using the 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”.


--configuration

Type: string

The configuration file or “none”.


--dbserver-prefetch-batches

Introduced in: v3.10.8

Type: uint64

Number of batches to prefetch on each DB-Server.

Default: 5


--dbserver-worker-threads

Introduced in: v3.10.8

Type: uint64

Number of worker threads on each DB-Server.

Default: 5


--define

Type: string…

Define a value for a @key@ entry in the configuration file using the syntax "key=value".


--dump-data

Type: boolean

Whether to dump collection data.

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

Default: true


--dump-dependencies

Type: boolean

Dump the dependency graph of the feature phases (internal) and exit.

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


--dump-options

Type: boolean

Dump all available startup options in JSON format and exit.

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


--envelope

Introduced in: v3.8.0

Deprecated in: v3.10.11

Type: boolean

Wrap each document into a {type, data} envelope (this is required for compatibility with v3.7 and before).

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


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


--ignore-distribute-shards-like-errors

Type: boolean

Continue dumping even if a sharding prototype collection is not backed up, too.

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


--include-system-collections

Type: boolean

Include system collections.

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


--initial-batch-size

Type: uint64

The initial size for individual data batches (in bytes).

Default: 8388608


--local-network-threads

Introduced in: v3.10.8

Type: uint64

Number of local network threads, i.e. how many requests are sent in parallel.

Default: 5


--local-writer-threads

Introduced in: v3.10.8

Type: uint64

Number of local writer threads.

Default: 5


--log

Deprecated in: v3.5.0

Type: string…

Set the topic-specific log level, using --log level for the general topic or --log topic=level for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.

Default: info


--maskings

Introduced in: v3.3.22, v3.4.2

Type: string

A path to a file with masking definitions.


--output-directory

Type: string

The output directory.

Default: /dump


--overwrite

Type: boolean

Overwrite data in the output directory.

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


--progress

Type: boolean

Show the progress.

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

Default: true


--shard

Introduced in: v3.8.0

Type: string…

Restrict the dump to this shard (can be specified multiple times).


--split-files

Introduced in: v3.10.10

Experimental

Type: boolean

Split a collection in multiple files to increase throughput.

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

Show details

--threads

Introduced in: v3.4.0

Type: uint32

The maximum number of collections/shards to process in parallel.

Default: dynamic (e.g. 8)


--tick-end

Deprecated in: v3.10.11

Type: uint64

Last tick to be included in data dump.


--tick-start

Deprecated in: v3.10.11

Type: uint64

Only include data after this tick.


--use-experimental-dump

Introduced in: v3.10.8

Experimental

Type: boolean

Enable experimental dump behavior.

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


--use-splice-syscall

Introduced in: v3.9.4

Type: boolean

Use the splice() syscall for file copying (may not be supported on all filesystems).

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

Default: true

Available on Linux only.

Show details

--version

Type: boolean

Print the version and other related information, then exit.

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


--version-json

Introduced in: v3.9.0

Type: boolean

Print the version and other related information in JSON format, then exit.

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


encryption

--encryption.key-generator

Enterprise Edition

Type: string

A program providing the encryption key on stdout. If set, encryption at rest is enabled.

Show details

--encryption.keyfile

Enterprise Edition

Type: string

The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.

Show details

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-control-chars

Introduced in: v3.9.0

Type: boolean

Escape control characters in log messages.

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

Default: true

Show details

--log.escape-unicode-chars

Introduced in: v3.9.0

Type: boolean

Escape Unicode characters in log messages.

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

Show details

--log.file

Type: string

shortcut for ‘--log.output file://

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


--log.file-mode

Introduced in: v3.4.5

Type: string

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


--log.force-direct

Type: boolean

Do not start a separate thread for logging.

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

Show details

--log.foreground-tty

Type: boolean

Also log to TTY if backgrounded.

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


--log.hostname

Introduced in: v3.8.0

Type: string

The hostname to use in log message. Leave empty for none, use “auto” to automatically determine a hostname.

Show details

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

Show details

--log.level

Type: string…

Set the topic-specific log level, using --log.level level for the general topic or --log.level topic=level for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace. Available log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.

Default: info

Show details

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


--log.max-entry-length

Introduced in: v3.7.9

Type: uint32

The maximum length of a log entry (in bytes).

Default: 134217728

Show details

--log.max-queued-entries

Introduced in: v3.10.12

Type: uint32

Upper limit of log entries that are queued in a background thread.

Default: 10000

Show details

--log.output

Type: string…

Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).

Show details

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


--log.prefix

Type: string

Prefix log message with this string.

Show details

--log.process

Introduced in: v3.8.0

Type: boolean

Show the process identifier (PID) in log messages.

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 the server role.

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

Show details

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

Introduced in: v3.10.0

Type: string…

Toggle the usage of the log category parameter in structured log messages.

Show details

--log.thread

Type: boolean

Show the thread identifier in log messages.

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


--log.thread-name

Type: boolean

Show thread name in log messages.

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


--log.time-format

Introduced in: v3.5.0

Type: string

The 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-micros”, “utc-datestring-millis”

Show details

--log.use-json-format

Introduced in: v3.8.0

Type: boolean

Use JSON as output format for logging.

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

Show details

--log.use-local-time

Deprecated in: v3.5.0

Type: boolean

Use the local timezone instead of UTC.

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

Show details

--log.use-microtime

Deprecated in: v3.5.0

Type: boolean

Use Unix timestamps in seconds with microsecond precision.

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

Show details

random

--random.generator

Type: uint32

The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).

Default: 1

Possible values: 1, 2, 3, 4

Show details

server

--server.ask-jwt-secret

Type: boolean

If enabled, you are prompted for a JWT secret. This option is not compatible with --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.

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


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


--server.connection-timeout

Type: double

The connection timeout (in seconds).

Default: 5


--server.database

Type: string

The database name to use when connecting.

Default: _system


--server.endpoint

Type: string…

The 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: tcp://127.0.0.1:8529


--server.jwt-secret-keyfile

Type: string

If enabled, the JWT secret is loaded from the given file. This option is not compatible with --server.ask-jwt-secret, --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.


--server.max-packet-size

Type: uint64

The maximum packet size (in bytes) for client/server communication.

Default: 1073741824


--server.password

Type: string

The password to use when connecting. If not specified and authentication is required, the user is prompted for a password


--server.request-timeout

Type: double

The request timeout (in seconds).

Default: 1200


--server.username

Type: string

The username to use when connecting.

Default: root


ssl

--ssl.protocol

Type: uint64

The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))

Default: 5

Possible values: 1, 2, 3, 4, 5, 6, 9