Arangorestore Options

Usage: arangorestore [<options>]

Global Options

NameTypeDescription
batch-sizeuint64 Maximum size for individual data batches (in bytes).
Default: 8388608
check-configurationboolean Check the configuration and exit.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
cleanup-duplicate-attributesboolean Clean up duplicate attributes (use first specified value) in input documents instead of making the restore operation fail.
This option can be specified without value to enable it.
Default: false
Introduced in: v3.3.22, v3.4.2
collectionstring... Restrict to collection name (can be specified multiple times).
Default: []
configstring The configuration file or 'none'.
Default: ""
configurationstring The configuration file or 'none'.
Default: ""
create-collectionboolean Create collection structure.
This option can be specified without value to enable it.
Default: true
create-databaseboolean Create the target database if it does not exist.
This option can be specified without value to enable it.
Default: false
default-number-of-shardsuint64 Default value for numberOfShards if not specified in dump.
Default: 1
Deprecated in: v3.3.22, v3.4.2
default-replication-factoruint64 Default value for replicationFactor if not specified in dump.
Default: 1
Deprecated in: v3.3.22, v3.4.2
definestring... Define key=value for a @key@ entry in config file.
Default: []
dump-dependenciesboolean Dump dependency graph.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
dump-optionsboolean Dump configuration options in JSON format.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: true
forceboolean Continue restore even in the face of some server-side errors.
This option can be specified without value to enable it.
Default: false
force-same-databaseboolean Force usage of the same database name as in the source dump.json file.
This option can be specified without value to enable it.
Default: false
ignore-distribute-shards-like-errorsboolean Continue restore even if sharding prototype collection is missing.
This option can be specified without value to enable it.
Default: false
import-databoolean Import data into collection.
This option can be specified without value to enable it.
Default: true
include-system-collectionsboolean Include system collections.
This option can be specified without value to enable it.
Default: false
input-directorystring Input directory.
Default: "/home/fceller/ArangoDB-3.4/dump"
logstring... The global or topic-specific log level.
Default: ["info"]
number-of-shardsstring... Override value for numberOfShards (can be specified multiple times, e.g. --numberOfShards 2 --numberOfShards myCollection=3).
Default: []
Introduced in: v3.3.22, v3.4.2
overwriteboolean Overwrite collections if they exist.
This option can be specified without value to enable it.
Default: true
progressboolean Show progress.
This option can be specified without value to enable it.
Default: true
replication-factorstring... Override value for replicationFactor (can be specified multiple times, e.g. --replicationFactor 2 --replicationFactor myCollection=3).
Default: []
Introduced in: v3.3.22, v3.4.2
threadsuint32 Maximum number of collections to process in parallel.
Default: 2
Introduced in: v3.4.0
versionboolean Reports the version and exits.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
viewstring... Restrict to view name (can be specified multiple times).
Default: []

Log Options

NameTypeDescription
log.colorboolean Use colors for TTY logging.
This option can be specified without value to enable it.
Default: true
log.escapeboolean Escape characters when logging.
This option can be specified without value to enable it.
Default: true
log.filestring Shortcut for '--log.output file://<filename>'.
Default: "-"
log.force-directboolean Do not start a seperate thread for logging.
This option can be specified without value to enable it.
Default: false
log.foreground-ttyboolean Also log to tty if backgrounded.
This option can be specified without value to enable it.
Default: false
log.keep-logrotateboolean Keep the old log file after receiving a sighup.
This option can be specified without value to enable it.
Default: false
log.levelstring... The global or topic-specific log level.
Default: ["info"]
log.line-numberboolean Append line number and file name.
This option can be specified without value to enable it.
Default: false
log.outputstring... Log destination(s).
Default: []
log.performanceboolean Shortcut for '--log.level performance=trace'.
This option can be specified without value to enable it.
Default: false
log.prefixstring Prefix log message with this string.
Default: ""
log.request-parametersboolean Include full URLs and HTTP request parameters in trace logs.
This option can be specified without value to enable it.
Default: true
log.roleboolean Log server role.
This option can be specified without value to enable it.
Default: false
log.shorten-filenamesboolean Shorten filenames in log output (use with --log.line-number).
This option can be specified without value to enable it.
Default: true
log.threadboolean Show thread identifier in log message.
This option can be specified without value to enable it.
Default: false
log.thread-nameboolean Show thread name in log message.
This option can be specified without value to enable it.
Default: false
log.use-local-timeboolean Use local timezone instead of UTC.
This option can be specified without value to enable it.
Default: false
log.use-microtimeboolean Use microtime instead.
This option can be specified without value to enable it.
Default: false

Random Options

NameTypeDescription
random.generatoruint32 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 Options

NameTypeDescription
server.authenticationboolean 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-timeoutdouble Connection timeout in seconds.
Default: 5
server.databasestring Database name to use when connecting.
Default: "_system"
server.endpointstring Endpoint to connect to, use 'none' to start without a server.
Default: "http+tcp://127.0.0.1:8529"
server.max-packet-sizeuint64 Maximum packet size (in bytes) for client/server communication.
Default: 1073741824
server.passwordstring Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password.
Default: ""
server.request-timeoutdouble Request timeout in seconds.
Default: 1200
server.usernamestring Username to use when connecting.
Default: "root"

Ssl Options

NameTypeDescription
ssl.protocoluint64 Ssl protocol (1 = SSLv2, 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2).
Default: 5
Possible values:
  • 1
  • 2
  • 3
  • 4
  • 5

Temp Options

NameTypeDescription
temp.pathstring Path for temporary files.
Default: ""