Arangorestore Options

Usage: arangorestore [<options>]

Global

NameTypeDescription
all-databasesbooleanRestore data to all databasesThis option can be specified without value to enable it.Default: falseIntroduced in: v3.5.0
batch-sizeuint64Maximum size for individual data batches (in bytes)Default: 8388608
check-configurationbooleanCheck the configuration and exitThis 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 failThis option can be specified without value to enable it.Default: falseIntroduced 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: ""
create-collectionbooleanCreate collection structureThis option can be specified without value to enable it.Default: true
create-databasebooleanCreate the target database if it does not existThis option can be specified without value to enable it.Default: false
default-number-of-shardsuint64Default value for numberOfShards if not specified in dumpDefault: 1Deprecated in: v3.3.22, v3.4.2
default-replication-factoruint64Default value for replicationFactor if not specified in dumpDefault: 1Deprecated in: v3.3.22, v3.4.2
definestring…Define key=value for a @key@ entry in config fileDefault: []
dump-dependenciesbooleanDump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command.
dump-optionsbooleanDump configuration options in JSON formatThis is a command, no value needs to be specified. The process terminates after executing the command.
forcebooleanContinue restore even in the face of some server-side errorsThis 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 fileThis option can be specified without value to enable it.Default: false
ignore-distribute-shards-like-errorsbooleanContinue restore even if sharding prototype collection is missingThis option can be specified without value to enable it.Default: false
import-databooleanImport data into collectionThis option can be specified without value to enable it.Default: true
include-system-collectionsbooleanInclude system collectionsThis option can be specified without value to enable it.Default: false
input-directorystringInput directoryDefault: "/work/ArangoDB/dump"
logstring…The global or topic-specific log levelDefault: ["info"]Deprecated in: v3.5.0
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
overwritebooleanOverwrite collections if they existThis option can be specified without value to enable it.Default: true
progressbooleanShow progressThis 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
threadsuint32Maximum number of collections to process in parallelDefault: 2Introduced in: v3.4.0
versionbooleanReports the version and exitsThis 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-generatorstring_Enterprise Edition only_Program providing the encryption key on stdout. If set, encryption will be enabled.Default: ""
encryption.keyfilestring_Enterprise Edition only_File containing the encryption key. If set, encryption will be enabled.Default: ""

Log

NameTypeDescription
log.colorbooleanUse colors for TTY loggingThis option can be specified without value to enable it.Default: dynamic (e.g. true)
log.escapebooleanEscape characters when loggingThis option can be specified without value to enable it.Default: true
log.filestringShortcut for ‘—log.output file://'Default: &#34;-&#34;
log.file-groupstringGroup to use for new log file, user must be a member of this groupDefault: ""Introduced in: v3.4.5, v3.5.0
log.file-modestringMode to use for new log file, umask will be applied as wellDefault: ""Introduced in: v3.4.5, v3.5.0
log.force-directbooleanDo not start a seperate thread for loggingThis option can be specified without value to enable it.Default: false
log.foreground-ttybooleanAlso log to tty if backgroundedThis option can be specified without value to enable it.Default: dynamic (e.g. false)
log.idsbooleanLog unique message idsThis option can be specified without value to enable it.Default: trueIntroduced in: v3.5.0
log.keep-logrotatebooleanKeep the old log file after receiving a sighupThis option can be specified without value to enable it.Default: false
log.levelstring…The global or topic-specific log levelDefault: ["info"]
log.line-numberbooleanAppend line number and file nameThis option can be specified without value to enable it.Default: false
log.outputstring…Log destination(s), e.g. file:///path/to/file (Linux, macOS) or file://C:\path\to\file (Windows)Default: []
log.performancebooleanShortcut for ‘—log.level performance=trace’This option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.prefixstringPrefix log message with this stringDefault: ""
log.request-parametersbooleanInclude full URLs and HTTP request parameters in trace logsThis option can be specified without value to enable it.Default: true
log.rolebooleanLog server roleThis 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 messageThis option can be specified without value to enable it.Default: false
log.thread-namebooleanShow thread name in log messageThis option can be specified without value to enable it.Default: false
log.time-formatstringTime format to use in logsDefault: "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-local-timebooleanUse local timezone instead of UTCThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.use-microtimebooleanUse microtime insteadThis option can be specified without value to enable it.Default: falseDeprecated 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: 1Possible values: 1, 2, 3, 4

Server

NameTypeDescription
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 secondsDefault: 5
server.databasestringDatabase name to use when connectingDefault: "_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 debuggingThis option can be specified without value to enable it.Default: falseIntroduced in: v3.6.0
server.max-packet-sizeuint64Maximum packet size (in bytes) for client/server communicationDefault: 1073741824
server.passwordstringPassword to use when connecting. If not specified and authentication is required, the user will be prompted for a passwordDefault: ""
server.request-timeoutdoubleRequest timeout in secondsDefault: 1200
server.usernamestringUsername to use when connectingDefault: "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: 5Possible values: 1, 2, 3, 4, 5, 6, 9

Temp

NameTypeDescription
temp.pathstringPath for temporary filesDefault: ""