arangorestore Options

Usage: arangorestore [<options>]

General

NameTypeDescription
all-databasesbooleanRestore data to all databases
This option can be specified without value to enable it.
Default: false
Introduced in: v3.5.0
batch-sizeuint64Maximum size for individual data batches (in bytes)
Default: 8388608
check-configurationbooleanCheck the configuration and exit
This is a command, no value needs to be specified. The process terminates after executing the command.
cleanup-duplicate-attributesbooleanClean 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: []
configstringThe configuration file or ‘none’
Default: “”
configurationstringThe configuration file or ‘none’
Default: “”
continuebooleanContinue restore operation
This option can be specified without value to enable it.
Default: false
create-collectionbooleanCreate collection structure
This option can be specified without value to enable it.
Default: true
create-databasebooleanCreate the target database if it does not exist
This option can be specified without value to enable it.
Default: false
default-number-of-shardsuint64Default value for numberOfShards if not specified in dump
Default: 1
Deprecated in: v3.3.22, v3.4.2
default-replication-factoruint64Default 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-dependenciesbooleanDump dependency graph
This is a command, no value needs to be specified. The process terminates after executing the command.
dump-optionsbooleanDump configuration options in JSON format
This is a command, no value needs to be specified. The process terminates after executing the command.
envelopebooleanWrap each document into a {type, data} envelope (this is required from compatibility with v3.7 and before)
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.0
forcebooleanContinue restore even in the face of some server-side errors
This option can be specified without value to enable it.
Default: false
force-same-databasebooleanForce 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-errorsbooleanContinue restore even if sharding prototype collection is missing
This option can be specified without value to enable it.
Default: false
import-databooleanImport data into collection
This option can be specified without value to enable it.
Default: true
include-system-collectionsbooleanInclude system collections
This option can be specified without value to enable it.
Default: false
initial-connect-retriesuint32Number of connect retries for initial connection
Default: 3
Introduced in: v3.7.13, v3.8.1
input-directorystringInput directory
Default: “/work/ArangoDB/dump”
logstring…The global or topic-specific log level
Default: [“info”]
Deprecated in: v3.5.0
number-of-shardsstring…Override value for numberOfShards (can be specified multiple times, e.g. —number-of-shards 2 —number-of-shards myCollection=3)
Default: []
Introduced in: v3.3.22, v3.4.2
overwritebooleanOverwrite collections if they exist
This option can be specified without value to enable it.
Default: true
progressbooleanShow 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. —replication-factor 2 —replication-factor myCollection=3)
Default: []
Introduced in: v3.3.22, v3.4.2
threadsuint32Maximum number of collections to process in parallel
Default: 2
Introduced in: v3.4.0
versionbooleanReports the version and exits
This is a command, no value needs to be specified. The process terminates after executing the command.
viewstring…Restrict to view name (can be specified multiple times)
Default: []

Encryption

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

NameTypeDescription
log.colorbooleanUse colors for TTY logging
This option can be specified without value to enable it.
Default: dynamic (e.g. true)
log.escapebooleanEscape characters when logging
This option can be specified without value to enable it.
Default: true
log.filestringShortcut for ‘—log.output file://‘
Default: “-“
log.file-groupstringGroup to use for new log file, user must be a member of this group
Default: “”
Introduced in: v3.4.5
log.file-modestringMode to use for new log file, umask will be applied as well
Default: “”
Introduced in: v3.4.5
log.force-directbooleanDo not start a seperate thread for logging
This option can be specified without value to enable it.
Default: false
log.foreground-ttybooleanAlso log to tty if backgrounded
This option can be specified without value to enable it.
Default: dynamic (e.g. false)
log.hostnamestringHostname to use in log message (empty for none, use ‘auto’ to automatically figure out hostname)
Default: “”
Introduced in: v3.8.0
log.idsbooleanLog unique message ids
This option can be specified without value to enable it.
Default: true
Introduced in: v3.5.0
log.levelstring…The global or topic-specific log level
Default: [“info”]
log.line-numberbooleanInclude 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 value to enable it.
Default: false
log.max-entry-lengthuint32Maximum length of a log entry (in bytes)
Default: 134217728
Introduced in: v3.7.9
log.outputstring…Log destination(s), e.g. file:///path/to/file (any ‘$PID’ will be replaced with the process id)
Default: []
log.performancebooleanShortcut for ‘—log.level performance=trace’
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0
log.prefixstringPrefix log message with this string
Default: “”
log.processbooleanShow process identifier (pid) in log message
This option can be specified without value to enable it.
Default: true
Introduced in: v3.8.0
log.request-parametersbooleanInclude full URLs and HTTP request parameters in trace logs
This option can be specified without value to enable it.
Default: true
log.rolebooleanLog server role
This option can be specified without value to enable it.
Default: false
log.shorten-filenamesbooleanShorten filenames in log output (use with —log.line-number)
This option can be specified without value to enable it.
Default: true
log.threadbooleanShow thread identifier in log message
This option can be specified without value to enable it.
Default: false
log.thread-namebooleanShow thread name in log message
This option can be specified without value to enable it.
Default: false
log.time-formatstringTime 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”
Introduced in: v3.5.0
log.use-json-formatbooleanUse json output format
This option can be specified without value to enable it.
Default: false
Introduced in: v3.8.0
log.use-local-timebooleanUse local timezone instead of UTC
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0
log.use-microtimebooleanUse microtime instead
This option can be specified without value to enable it.
Default: false
Deprecated in: v3.5.0

Random

NameTypeDescription
random.generatoruint32Random 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

NameTypeDescription
server.ask-jwt-secretbooleanIf 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 value to enable it.
Default: false
server.authenticationbooleanRequire 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-timeoutdoubleConnection timeout in seconds
Default: 5
server.databasestringDatabase name to use when connecting
Default: “_system”
server.endpointstringEndpoint 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-jsonbooleanForce to not use VelocyPack for easier debugging
This option can be specified without value to enable it.
Default: false
Introduced in: v3.6.0
server.jwt-secret-keyfilestringIf 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-sizeuint64Maximum packet size (in bytes) for client/server communication
Default: 1073741824
server.passwordstringPassword to use when connecting. If not specified and authentication is required, the user will be prompted for a password
Default: “”
server.request-timeoutdoubleRequest timeout in seconds
Default: 1200
server.usernamestringUsername to use when connecting
Default: “root”

SSL

NameTypeDescription
ssl.protocoluint64Ssl 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

Temp

NameTypeDescription
temp.pathstringPath for temporary files
Default: “”