Arangorestore Options

Usage: arangorestore [<options>]

Global Options

NameTypeDescription
batch-sizeuint64 Maximum size for individual data batches (in bytes).
Default: 8388608
collectionstring... Restrict to collection name (can be specified multiple times).
Default: []
configurationstring The configuration file or 'none'.
Default: ""
create-collectionboolean Create collection structure.
Default: true
create-databaseboolean Create the target database if it does not exist.
Default: false
default-number-of-shardsuint64 Default value for numberOfShards if not specified.
Default: 1
default-replication-factoruint64 Default value for replicationFactor if not specified.
Default: 1
forceboolean Continue restore even in the face of some server-side errors.
Default: false
force-same-databaseboolean Force usage of the same database name as in the source dump.json file.
Default: false
ignore-distribute-shards-like-errorsboolean Continue restore even if sharding prototype collection is missing.
Default: false
import-databoolean Import data into collection.
Default: true
include-system-collectionsboolean Include system collections.
Default: false
input-directorystring Input directory.
Default: "/oskar/work/ArangoDB/dump"
overwriteboolean Overwrite collections if they exist.
Default: true
progressboolean Show progress.
Default: true
threadsuint32 Maximum number of collections to process in parallel.
Default: 2
versionboolean Reports the version and exits.
Default: false
viewstring... Restrict to view name (can be specified multiple times).
Default: []

Encryption Options

NameTypeDescription
encryption.key-generatorstringEnterprise Edition only
Program providing the encryption key on stdout. If set, encryption will be enabled.
Default: ""
encryption.keyfilestringEnterprise Edition only
File containing the encryption key. If set, encryption will be enabled.
Default: ""

Log Options

NameTypeDescription
log.colorboolean Use colors for TTY logging.
Default: true
log.escapeboolean Escape characters when logging.
Default: true
log.levelstring... The global or topic-specific log level.
Default: ["info"]
log.outputstring... Log destination(s).
Default: []
log.roleboolean Log server role.
Default: false
log.use-local-timeboolean Use local timezone instead of UTC.
Default: false
log.use-microtimeboolean Use microtime instead.
Default: false

Server Options

NameTypeDescription
server.authenticationboolean Require authentication credentials when connecting (does not affect the server-side authentication settings).
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.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: ""