ArangoDB Server Options

Usage: arangod [<options>]

The database directory can be specified as positional (unnamed) first parameter:

arangod /path/to/datadir

Or explicitly as named parameter:

arangod --database.directory /path/to/datadir

All other parameters need to be passed as named parameters. That is two hyphens followed by the option name, an equals sign or a space and finally the parameter value. The value needs to be wrapped in double quote marks if the value contains whitespace. Extra whitespace around = is allowed:

arangod --database.directory = "/path with spaces/to/datadir"

See Configuration if you want to translate startup parameters to configuration files or learn more about startup options in general.

See Fetch Current Configuration Options if you want to query the arangod server for the current settings at runtime.

Global Options

Also see Global details.

NameTypeDescription
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
configstring The configuration file or 'none'.
Default: ""
configurationstring The configuration file or 'none'.
Default: ""
consoleboolean Start a JavaScript emergency console.
This option can be specified without value to enable it.
Default: false
daemonboolean Background the server, running it as daemon.
This option can be specified without value to enable it.
Default: false
default-languagestring ISO-639 language code.
Default: ""
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
fortuneboolean Show fortune cookie on startup.
This option can be specified without value to enable it.
Default: false
gidstring Switch to group-id after reading config files.
Default: ""
hundboolean Make ArangoDB bark on startup.
This option can be specified without value to enable it.
Default: false
logstring... The global or topic-specific log level.
Default: ["info", "info"]
pid-filestring Pid-file in daemon mode.
Default: ""
supervisorboolean Background the server, starts a supervisor.
This option can be specified without value to enable it.
Default: false
uidstring Switch to user-id after reading config files.
Default: ""
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
working-directorystring Working directory in daemon mode.
Default: "/var/tmp"

Agency Options

Also see Agency details.

NameTypeDescription
agency.activateboolean Activate agency.
This option can be specified without value to enable it.
Default: false
agency.compaction-keep-sizeuint64 Keep as many indices before compaction point.
Default: 50000
agency.compaction-step-sizeuint64 Step size between state machine compactions.
Default: 1000
agency.disaster-recovery-idstring Allows for specification of the id for this agent; dangerous option for disaster recover only!.
Default: ""
agency.election-timeout-maxdouble Maximum timeout before an agent calls for new election [s].
Default: 5
agency.election-timeout-mindouble Minimum timeout before an agent calls for new election [s].
Default: 1
agency.endpointstring... Agency endpoints.
Default: []
agency.max-append-sizeuint64 Maximum size of appendEntries document (# log entries).
Default: 250
agency.my-addressstring Which address to advertise to the outside.
Default: ""
agency.pool-sizeuint64 Number of agent pool.
Default: 1
agency.sizeuint64 Number of agents.
Default: 1
agency.supervisionboolean Perform arangodb cluster supervision.
This option can be specified without value to enable it.
Default: false
agency.supervision-frequencydouble Arangodb cluster supervision frequency [s].
Default: 1
agency.supervision-grace-perioddouble Supervision time, after which a server is considered to have failed [s].
Default: 10
agency.wait-for-syncboolean Wait for hard disk syncs on every persistence call (required in production).
This option can be specified without value to enable it.
Default: true

Arangosearch Options

Also see Arangosearch details.

NameTypeDescription
arangosearch.threadsuint64 The exact number of threads to use for asynchronous tasks (0 == autodetect).
Default: 0
arangosearch.threads-limituint64 Upper limit to the autodetected number of threads to use for asynchronous tasks (0 == use default).
Default: 0

Audit Options

Also see Audit details.

NameTypeDescription
audit.hostnamestringEnterprise Edition only
Hostname to use.
Default: ""
audit.outputstring...Enterprise Edition only
Audit destination(s).
Default: []

Cache Options

Also see Cache details.

NameTypeDescription
cache.rebalancing-intervaluint64 Microseconds between rebalancing attempts.
Default: 2000000
cache.sizeuint64 Size of cache in bytes.
Default: dynamic (e.g. 16341579776)

Cluster Options

Also see Cluster details.

NameTypeDescription
cluster.agency-endpointstring... Agency endpoint to connect to.
Default: []
cluster.agency-prefixstring Agency prefix.
Default: ""
cluster.create-waits-for-sync-replicationboolean Active coordinator will wait for all replicas to create collection.
This option can be specified without value to enable it.
Default: true
cluster.index-create-timeoutdouble Amount of time (in seconds) the coordinator will wait for an index to be created before giving up.
Default: 3600
cluster.my-addressstring This server's endpoint (cluster internal).
Default: ""
cluster.my-advertised-endpointstring This server's advertised endpoint (e.g. external IP address or load balancer, optional).
Default: ""
cluster.my-rolestring This server's role.
Default: ""
cluster.require-persisted-idboolean If set to true, then the instance will only start if a UUID file is found in the database on startup. Setting this option will make sure the instance is started using an already existing database directory and not a new one. For the first start, the UUID file must either be created manually or the option must be set to false for the initial startup.
This option can be specified without value to enable it.
Default: false
cluster.synchronous-replication-timeout-factordouble All synchronous replication timeouts are multiplied by this factor.
Default: 1
cluster.synchronous-replication-timeout-per-4kdouble All synchronous replication timeouts are increased by this amount per 4096 bytes (in seconds).
Default: 0.1
cluster.system-replication-factoruint32 Replication factor for system collections.
Default: 2

Compaction Options

Also see Compaction details.

NameTypeDescription
compaction.db-sleep-timedouble Sleep interval between two compaction runs (in s).
Default: 1
compaction.dead-documents-thresholduint64 Minimum unused count of documents in a datafile.
Default: 16384
compaction.dead-size-percent-thresholddouble How many percent of the source datafile should be unused at least.
Default: 0.1
compaction.dead-size-thresholduint64 How many bytes of the source data file are allowed to be unused at most.
Default: 131072
compaction.max-file-size-factoruint64 How large the resulting file may be in comparison to the collections '--database.maximal-journal-size' setting.
Default: 3
compaction.max-filesuint64 Maximum number of files to merge to one file.
Default: 3
compaction.max-result-file-sizeuint64 How large may the compaction result file become (in bytes).
Default: 134217728
compaction.min-intervaldouble Minimum sleep time between two compaction runs (in s).
Default: 10
compaction.min-small-data-file-sizeuint64 Minimal filesize threshhold original data files have to be below for a compaction.
Default: 131072

Database Options

Also see Database details.

NameTypeDescription
database.auto-upgradeboolean Perform a database upgrade if necessary.
This option can be specified without value to enable it.
Default: false
database.check-versionboolean Checks the versions of the database and exit.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
database.directorystring Path to the database directory.
Default: ""
database.force-sync-propertiesboolean Force syncing of collection properties to disk, will use waitForSync value of collection when turned off.
This option can be specified without value to enable it.
Default: true
database.ignore-datafile-errorsboolean Load collections even if datafiles may contain errors.
This option can be specified without value to enable it.
Default: false
database.init-databaseboolean Initializes an empty database.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
database.maximal-journal-sizeuint64 Default maximal journal size, can be overwritten when creating a collection.
Default: 33554432
database.passwordstring Initial password of root user.
Default: ""
database.required-directory-statestring Required state of database directory at startup (non-existing: database directory must not exist, existing: database directory must exist, empty: database directory must exist but be empty, populated: database directory must exist and contain specific files already, any: any state allowed).
Default: "any"
Possible values:
  • "any"
  • "empty"
  • "existing"
  • "non-existing"
  • "populated"
database.restore-adminboolean Resets the admin users and sets a new password.
This is a command, no value needs to be specified. The process terminates after executing the command.
Default: false
database.throw-collection-not-loaded-errorboolean Throw an error when accessing a collection that is still loading.
This option can be specified without value to enable it.
Default: false
database.upgrade-checkboolean Skip a database upgrade.
This option can be specified without value to enable it.
Default: true
database.wait-for-syncboolean Default wait-for-sync behavior, can be overwritten when creating a collection.
This option can be specified without value to enable it.
Default: false

Foxx Options

Also see Foxx details.

NameTypeDescription
foxx.queuesboolean Enable Foxx queues.
This option can be specified without value to enable it.
Default: true
foxx.queues-poll-intervaldouble Poll interval (in seconds) for Foxx queue manager.
Default: 1

Frontend Options

Also see Frontend details.

NameTypeDescription
frontend.proxy-request-checkboolean Enable proxy request checking.
This option can be specified without value to enable it.
Default: true
frontend.trusted-proxystring... List of proxies to trust (may be IP or network). Make sure --frontend.proxy-request-check is enabled.
Default: []
frontend.version-checkboolean Alert the user if new versions are available.
This option can be specified without value to enable it.
Default: true

Http Options

Also see Http details.

NameTypeDescription
http.allow-method-overrideboolean Allow HTTP method override using special headers.
This option can be specified without value to enable it.
Default: false
http.hide-product-headerboolean Do not expose "Server: ArangoDB" header in HTTP responses.
This option can be specified without value to enable it.
Default: false
http.keep-alive-timeoutdouble Keep-alive timeout in seconds.
Default: 300
http.trusted-originstring... Trusted origin URLs for CORS requests with credentials.
Default: []

Javascript Options

Also see Javascript details.

NameTypeDescription
javascript.allow-admin-executeboolean For testing purposes allow '_admin/execute', NEVER enable on production.
This option can be specified without value to enable it.
Default: false
javascript.app-pathstring Directory for Foxx applications.
Default: "./js/apps"
javascript.copy-installationboolean Copy contents of 'javascript.startup-directory' on first start.
This option can be specified without value to enable it.
Default: false
javascript.enabledboolean Enable the V8 JavaScript engine.
This option can be specified without value to enable it.
Default: true
javascript.gc-frequencydouble JavaScript time-based garbage collection frequency (each x seconds).
Default: 60
javascript.gc-intervaluint64 JavaScript request-based garbage collection interval (each x requests).
Default: 2000
javascript.module-directorystring... Additional paths containing JavaScript modules.
Default: ["./enterprise/js"]
javascript.scriptstring... Run scripts and exit.
Default: []
javascript.script-parameterstring... Script parameter.
Default: []
javascript.startup-directorystring Path to the directory containing JavaScript startup scripts.
Default: "./js"
javascript.v8-contextsuint64 Maximum number of V8 contexts that are created for executing JavaScript actions.
Default: 0
javascript.v8-contexts-max-agedouble Maximum age for each V8 context (in seconds) before it is disposed.
Default: 60
javascript.v8-contexts-max-invocationsuint64 Maximum number of invocations for each V8 context before it is disposed.
Default: 0
javascript.v8-contexts-minimumuint64 Minimum number of V8 contexts that keep available for executing JavaScript actions.
Default: 0
javascript.v8-max-heapuint64 Maximal heap size (in MB).
Default: 3072
javascript.v8-optionsstring... Options to pass to v8.
Default: []

Ldap Options

Also see Ldap details.

NameTypeDescription
ldap.async-connectbooleanEnterprise Edition only
Whether or not the connection to the LDAP library will be done asynchronously.
This option can be specified without value to enable it.
Default: false
ldap.basednstringEnterprise Edition only
Ldap basedn, eg. dc=example,dc=com.
Default: ""
ldap.binddnstringEnterprise Edition only
Ldap binddn, eg. cn=admin,dc=example,dc=com.
Default: ""
ldap.bindpasswdstringEnterprise Edition only
Ldap bindpassword, eg. admin.
Default: ""
ldap.debugbooleanEnterprise Edition only
Turn on internal OpenLDAP library output (warning: will print to stdout).
This option can be specified without value to enable it.
Default: false
ldap.enabledbooleanEnterprise Edition only
Enable LDAP.
This option can be specified without value to enable it.
Default: false
ldap.network-timeoutdoubleEnterprise Edition only
Timeout value (in seconds) after which network operations following the initial connection return in case of no activity (a value of 0 means default timeout).
Default: 0
ldap.portuint16Enterprise Edition only
Port to use.
Default: 389
ldap.prefixstringEnterprise Edition only
Ldap prefix, eg. uid= xor dn= xor cn=.
Default: ""
ldap.referralsbooleanEnterprise Edition only
Whether or not the LDAP library should implicitly chase referrals.
This option can be specified without value to enable it.
Default: false
ldap.refresh-ratedoubleEnterprise Edition only
Refresh user settings after this time (in seconds).
Default: 300
ldap.restartbooleanEnterprise Edition only
Whether or not the LDAP library should implicitly restart connections.
This option can be specified without value to enable it.
Default: false
ldap.retriesuint32Enterprise Edition only
Number of tries to attempt connecting to the LDAP server. Setting it to values greater than one will retry connecting in case the LDAP server is unavailable or denies the connection.
Default: 1
ldap.roles-attribute-namestringEnterprise Edition only
Ldap attributename where the role are located.
Default: ""
ldap.roles-excludestringEnterprise Edition only
Regexp to exclude groups. Leave empty to exclude none.
Default: ""
ldap.roles-includestringEnterprise Edition only
Regexp to include groups. Leave empty to include all.
Default: ""
ldap.roles-searchstringEnterprise Edition only
Ldap search for roles; '{USER}' is replaced by the 'dn' of the user.
Default: ""
ldap.roles-transformationstring...Enterprise Edition only
Regexp to normalizer role name, e.g. '/^ *(.*[^ ]])*/$2/'.
Default: []
ldap.search-attributestringEnterprise Edition only
Ldap search attribute, eg. uid.
Default: "uid"
ldap.search-filterstringEnterprise Edition only
Ldap search filter, eg. (objectClass=simpleSecurityObject).
Default: "objectClass=*"
ldap.search-scopestringEnterprise Edition only
Ldap search scope, one of base, one, sub.
Default: "sub"
ldap.serialize-timeoutdoubleEnterprise Edition only
Maximum amount of time (in seconds) that will be waited for the serialization mutex.
Default: 5
ldap.serializedbooleanEnterprise Edition only
Whether or not calls into the LDAP library should be serialized. This option can be used to work around thread-unsafe LDAP library functionality.
This option can be specified without value to enable it.
Default: false
ldap.serverstringEnterprise Edition only
Server to use.
Default: ""
ldap.suffixstringEnterprise Edition only
Ldap suffix, eg. ,dc=example,dc=com.
Default: ""
ldap.superuser-rolestringEnterprise Edition only
Role mapping to the super-users.
Default: ""
ldap.timeoutdoubleEnterprise Edition only
Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout).
Default: 0
ldap.tlsbooleanEnterprise Edition only
Enable TLS.
This option can be specified without value to enable it.
Default: false
ldap.tls-cacert-dirstringEnterprise Edition only
Ldap tls cacert dir.
Default: ""
ldap.tls-cacert-filestringEnterprise Edition only
Ldap tls cacert file.
Default: ""
ldap.tls-cert-check-strategystringEnterprise Edition only
Ldap tls cert check strategy, one of never, hard, demand, allow, try.
Default: "hard"
ldap.tls-versionstringEnterprise Edition only
Ldap tls version, one of 1.0, 1.1, 1.2.
Default: "1.2"
ldap.urlstringEnterprise Edition only
Ldap url, eg. ldap://example.com:389/dc=example,dc=com?uid?sub.
Default: ""

Log Options

Also see Log details.

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.file-groupstring Group to use for new log file, user must be a member of this group.
Default: ""
Introduced in: v3.4.5, v3.5.0
log.file-modestring Mode to use for new log file, umask will be applied as well.
Default: ""
Introduced in: v3.4.5, v3.5.0
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", "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

Nonce Options

Also see Nonce details.

NameTypeDescription
nonce.sizeuint64 The size of the hash array for nonces.
Default: 4194304

Query Options

Also see Query details.

NameTypeDescription
query.cache-entriesuint64 Maximum number of results in query result cache per database.
Default: 128
query.cache-entries-max-sizeuint64 Maximum cumulated size of results in query result cache per database.
Default: 268435456
query.cache-entry-max-sizeuint64 Maximum size of an invidiual result entry in query result cache.
Default: 16777216
query.cache-include-system-collectionsboolean Whether or not to include system collection queries in the query result cache.
This option can be specified without value to enable it.
Default: false
query.cache-modestring Mode for the AQL query result cache (on, off, demand).
Default: "off"
query.fail-on-warningboolean Whether AQL queries should fail with errors even for recoverable warnings.
This option can be specified without value to enable it.
Default: false
query.memory-limituint64 Memory threshold for AQL queries (in bytes).
Default: 0
query.optimizer-max-plansuint64 Maximum number of query plans to create for a query.
Default: 128
query.registry-ttldouble Default time-to-live of query snippets (in seconds).
Default: 600
query.slow-streaming-thresholddouble Threshold for slow streaming AQL queries (in seconds).
Default: 10
query.slow-thresholddouble Threshold for slow AQL queries (in seconds).
Default: 10
query.smart-joinsbooleanEnterprise Edition only
Enable smart joins query optimization.
This option can be specified without value to enable it.
Default: false
Introduced in: v3.4.5, v3.5.0
query.trackingboolean Whether to track slow AQL queries.
This option can be specified without value to enable it.
Default: true
query.tracking-with-bindvarsboolean Whether to track bind vars with AQL queries.
This option can be specified without value to enable it.
Default: true

Random Options

Also see Random details.

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

Replication Options

Also see Replication details.

NameTypeDescription
replication.active-failoverboolean Enable active-failover during asynchronous replication.
This option can be specified without value to enable it.
Default: false
replication.auto-startboolean Switch to enable or disable the automatic start of replication appliers.
This option can be specified without value to enable it.
Default: true
replication.automatic-failoverboolean Please use `--replication.active-failover` instead.
This option can be specified without value to enable it.
Default: false

Rocksdb Options

Also see Rocksdb details.

NameTypeDescription
rocksdb.allow-fallocateboolean If true, allow RocksDB to use fallocate calls. if false, fallocate calls are bypassed.
This option can be specified without value to enable it.
Default: true
Introduced in: v3.4.5, v3.5.0
rocksdb.block-align-data-blocksboolean If true, aligns data blocks on lesser of page size and block size.
This option can be specified without value to enable it.
Default: false
rocksdb.block-cache-shard-bitsint64 Number of shard bits to use for block cache (use -1 for default value).
Default: -1
rocksdb.block-cache-sizeuint64 Size of block cache in bytes.
Default: dynamic (e.g. 19609895731)
rocksdb.compaction-read-ahead-sizeuint64 If non-zero, we perform bigger reads when doing compaction. If you're running RocksDB on spinning disks, you should set this to at least 2MB. that way RocksDB's compaction is doing sequential instead of random reads.
Default: 2097152
rocksdb.debug-loggingboolean True to enable rocksdb debug logging.
This option can be specified without value to enable it.
Default: false
rocksdb.delayed_write_rateuint64 Limited write rate to DB (in bytes per second) if we are writing to the last mem-table allowed and we allow more than 3 mem-tables, or if we have surpassed a certain number of level-0 files and need to slowdown writes.
Default: 0
rocksdb.dynamic-level-bytesboolean If true, determine the number of bytes for each level dynamically to minimize space amplification.
This option can be specified without value to enable it.
Default: true
rocksdb.enable-pipelined-writeboolean If true, use a two stage write queue for WAL writes and memtable writes.
This option can be specified without value to enable it.
Default: false
rocksdb.enable-statisticsboolean Whether or not RocksDB statistics should be turned on.
This option can be specified without value to enable it.
Default: false
rocksdb.encryption-key-generatorstringEnterprise Edition only
Program providing the encryption key on stdout. If set, encryption will be enabled.
Default: ""
rocksdb.encryption-keyfilestringEnterprise Edition only
File containing encryption key. If set, encryption will be enabled.
Default: ""
rocksdb.enforce-block-cache-size-limitboolean If true, strictly enforces the block cache size limit.
This option can be specified without value to enable it.
Default: false
rocksdb.intermediate-commit-countuint64 An intermediate commit will be performed automatically when this number of operations is reached in a transaction.
Default: 1000000
rocksdb.intermediate-commit-sizeuint64 An intermediate commit will be performed automatically when a transaction has accumulated operations of this size (in bytes).
Default: 536870912
rocksdb.level0-compaction-triggerint64 Number of level-0 files that triggers a compaction.
Default: 2
rocksdb.level0-slowdown-triggerint64 Number of level-0 files that triggers a write slowdown.
Default: 20
rocksdb.level0-stop-triggerint64 Number of level-0 files that triggers a full write stall.
Default: 36
rocksdb.limit-open-files-at-startupboolean Limit the amount of .sst files RocksDB will inspect at startup, in order to startup reduce IO.
This option can be specified without value to enable it.
Default: false
Introduced in: v3.4.5, v3.5.0
rocksdb.max-background-jobsint32 Maximum number of concurrent background jobs (compactions and flushes).
Default: dynamic (e.g. 8)
rocksdb.max-bytes-for-level-baseuint64 If not using dynamic level sizes, this controls the maximum total data size for level-1.
Default: 268435456
rocksdb.max-bytes-for-level-multiplierdouble If not using dynamic level sizes, the maximum number of bytes for level L can be calculated as max-bytes-for-level-base * (max-bytes-for-level-multiplier ^ (L-1)).
Default: 10
rocksdb.max-subcompactionsuint64 Maximum number of concurrent subjobs for a background compaction.
Default: 1
rocksdb.max-total-wal-sizeuint64 Maximum total size of WAL files that will force flush stale column families.
Default: 83886080
rocksdb.max-transaction-sizeuint64 Transaction size limit (in bytes).
Default: 18446744073709551615
rocksdb.max-write-buffer-numberuint64 Maximum number of write buffers that built up in memory.
Default: 2
rocksdb.min-write-buffer-number-to-mergeuint64 Minimum number of write buffers that will be merged together before writing to storage.
Default: 1
rocksdb.num-levelsuint64 Number of levels for the database.
Default: 7
rocksdb.num-threads-priority-highuint32 Number of threads for high priority operations (e.g. flush).
Default: 0
rocksdb.num-threads-priority-lowuint32 Number of threads for low priority operations (e.g. compaction).
Default: 0
rocksdb.num-uncompressed-levelsuint64 Number of uncompressed levels for the database.
Default: 2
rocksdb.optimize-filters-for-hitsboolean This flag specifies that the implementation should optimize the filters mainly for cases where keys are found rather than also optimize for keys missed. This would be used in cases where the application knows that there are very few misses or the performance in the case of misses is not important.
This option can be specified without value to enable it.
Default: false
rocksdb.recycle-log-file-numuint64 Number of log files to keep around for recycling.
Default: 0
rocksdb.sync-intervaluint64 Interval for automatic, non-requested disk syncs (in milliseconds, use 0 to turn automatic syncing off).
Default: 100
rocksdb.table-block-sizeuint64 Approximate size (in bytes) of user data packed per block.
Default: 16384
rocksdb.throttleboolean Enable write-throttling.
This option can be specified without value to enable it.
Default: true
rocksdb.total-write-buffer-sizeuint64 Maximum total size of in-memory write buffers (0 = unbounded).
Default: dynamic (e.g. 26146527641)
rocksdb.transaction-lock-timeoutint64 If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a document. A negative value is not recommended as it can lead to deadlocks (0 = no waiting, < 0 no timeout).
Default: 1000
rocksdb.use-direct-io-for-flush-and-compactionboolean Use O_DIRECT for flush and compaction.
This option can be specified without value to enable it.
Default: false
rocksdb.use-direct-readsboolean Use O_DIRECT for reading files.
This option can be specified without value to enable it.
Default: false
rocksdb.use-file-loggingboolean Use a file-base logger for RocksDB's own logs.
This option can be specified without value to enable it.
Default: false
rocksdb.use-fsyncboolean Issue an fsync when writing to disk (set to true for issuing fdatasync only).
This option can be specified without value to enable it.
Default: false
rocksdb.wal-archive-size-limituint64 Maximum total size (in bytes) of archived WAL files (0 = unlimited).
Default: 0
rocksdb.wal-directorystring Optional path to the RocksDB WAL directory. If not set, the WAL directory will be located inside the regular data directory.
Default: ""
rocksdb.wal-file-timeoutdouble Timeout after which unused WAL files are deleted.
Default: 10
rocksdb.wal-file-timeout-initialdouble Initial timeout after which unused WAL files deletion kicks in after server start.
Default: 180
rocksdb.wal-recovery-skip-corruptedboolean Skip corrupted records in WAL recovery.
This option can be specified without value to enable it.
Default: false
rocksdb.write-buffer-sizeuint64 Amount of data to build up in memory before converting to a sorted on-disk file (0 = disabled).
Default: 67108864

Server Options

Also see Server details.

NameTypeDescription
server.allow-use-databaseboolean Allow change of database in REST actions, only needed for unittests.
This option can be specified without value to enable it.
Default: false
server.authenticationboolean Enable authentication for ALL client requests.
This option can be specified without value to enable it.
Default: true
server.authentication-system-onlyboolean Use HTTP authentication only for requests to /_api and /_admin.
This option can be specified without value to enable it.
Default: true
server.authentication-timeoutdouble Timeout for the authentication cache in seconds (0 = indefinitely).
Default: 0
server.authentication-unix-socketsboolean Authentication for requests via UNIX domain sockets.
This option can be specified without value to enable it.
Default: true
server.check-max-memory-mappingsboolean Check the maximum number of memory mappings at runtime.
This option can be specified without value to enable it.
Default: true
server.descriptors-minimumuint64 Minimum number of file descriptors needed to start.
Default: 0
server.endpointstring... Endpoint for client requests (e.g. 'http+tcp://127.0.0.1:8529', or 'vst+ssl://192.168.1.1:8529').
Default: ["tcp://0.0.0.0:8529"]
server.flush-intervaluint64 Interval (in microseconds) for flushing data.
Default: 1000000
server.gidstring Switch to group-id after reading config files.
Default: ""
server.jwt-secretstring Secret to use when doing jwt authentication.
Default: ""
Deprecated in: v3.3.22, v3.4.2
server.jwt-secret-keyfilestring File containing jwt secret to use when doing jwt authentication.
Default: ""
server.local-authenticationboolean Enable authentication using the local user database.
This option can be specified without value to enable it.
Default: true
server.maintenance-actions-blockint32 Minimum number of seconds finished Actions block duplicates.
Default: 2
server.maintenance-actions-lingerint32 Minimum number of seconds finished Actions remain in deque.
Default: 3600
server.maintenance-threadsuint32 Maximum number of threads available for maintenance actions.
Default: dynamic (e.g. 9)
server.maximal-queue-sizeuint64 Size of the priority 2 fifo.
Default: 4096
server.maximal-threadsuint64 Maximum number of request handling threads to run (0 = use system-specific default of 64).
Default: dynamic (e.g. 0)
server.minimal-threadsuint64 Minimum number of request handling threads to run.
Default: 2
server.prio1-sizeuint64 Size of the priority 1 fifo.
Default: 1048576
server.rest-serverboolean Start a rest-server.
This option can be specified without value to enable it.
Default: true
server.scheduler-queue-sizeuint64 Number of simultaneously queued requests inside the scheduler.
Default: 128
server.statisticsboolean Turn statistics gathering on or off.
This option can be specified without value to enable it.
Default: true
server.storage-enginestring Storage engine type.
Default: "auto"
Possible values:
  • "auto"
  • "mmfiles"
  • "rocksdb"
server.uidstring Switch to user-id after reading config files.
Default: ""

Ssl Options

Also see Ssl details.

NameTypeDescription
ssl.cafilestring Ca file used for secure connections.
Default: ""
ssl.cipher-liststring Ssl ciphers to use, see OpenSSL documentation.
Default: "HIGH:!EXPORT:!aNULL@STRENGTH"
ssl.ecdh-curvestring SSL ECDH Curve, see the output of "openssl ecparam -list_curves".
Default: "prime256v1"
ssl.keyfilestring Key-file used for secure connections.
Default: ""
ssl.optionsuint64 Ssl connection options, see OpenSSL documentation.
Default: 2147485780
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
ssl.require-peer-certificatebooleanEnterprise Edition only
Require a peer certificate when connecting.
This option can be specified without value to enable it.
Default: false
ssl.session-cacheboolean Enable the session cache for connections.
This option can be specified without value to enable it.
Default: false

Tcp Options

Also see Tcp details.

NameTypeDescription
tcp.backlog-sizeuint64 Listen backlog size.
Default: 64
tcp.reuse-addressboolean Try to reuse TCP port(s).
This option can be specified without value to enable it.
Default: true

Temp Options

Also see Temp details.

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

Vst Options

Also see Vst details.

NameTypeDescription
vst.maxsizeuint32 Maximal size (in bytes) for a VelocyPack chunk.
Default: 30720

Wal Options

Also see Wal details.

NameTypeDescription
wal.allow-oversize-entriesboolean Allow entries that are bigger than '--wal.logfile-size'.
This option can be specified without value to enable it.
Default: true
wal.directorystring Logfile directory.
Default: ""
wal.flush-timeoutuint64 Flush timeout (in milliseconds).
Default: 15000
wal.historic-logfilesuint32 Maximum number of historic logfiles to keep after collection.
Default: 10
wal.ignore-logfile-errorsboolean Ignore logfile errors. this will read recoverable data from corrupted logfiles but ignore any unrecoverable data.
This option can be specified without value to enable it.
Default: false
wal.ignore-recovery-errorsboolean Continue recovery even if re-applying operations fails.
This option can be specified without value to enable it.
Default: false
wal.logfile-sizeuint32 Size of each logfile (in bytes).
Default: 33554432
wal.open-logfilesuint32 Maximum number of parallel open logfiles.
Default: 0
wal.reserve-logfilesuint32 Maximum number of reserve logfiles to maintain.
Default: 3
wal.slotsuint32 Number of logfile slots to use.
Default: 1048576
wal.sync-intervaluint64 Interval for automatic, non-requested disk syncs (in milliseconds).
Default: 100
wal.throttle-waituint64 Maximum wait time per operation when write-throttled (in milliseconds).
Default: 15000
wal.throttle-when-pendinguint64 Throttle writes when at least this many operations are waiting for collection (set to 0 to deactivate write-throttling).
Default: 0
wal.use-mlockboolean Mlock WAL logfiles in memory (may require elevated privileges or limits).
This option can be specified without value to enable it.
Default: false