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 andfinally the parameter value. The value needs to be wrapped in double quote marksif the value contains whitespace. Extra whitespace around =
is allowed:
arangod --database.directory = "/path with spaces/to/datadir"
See Configurationif you want to translate startup parameters to configuration filesor learn more about startup options in general.
SeeFetch Current Configuration Optionsif you want to query the arangod
server for the current settings at runtime.
Global
Also see Global details.
Name | Type | Description |
---|---|---|
check-configuration | boolean | Check the configuration and exitThis is a command, no value needs to be specified. The process terminates after executing the command. |
config | string | The configuration file or ‘none’Default: "" |
configuration | string | The configuration file or ‘none’Default: "" |
console | boolean | Start a JavaScript emergency consoleThis option can be specified without value to enable it.Default: false |
daemon | boolean | Background the server, running it as daemonThis option can be specified without value to enable it.Default: false |
default-language | string | ISO-639 language codeDefault: "" |
define | string… | Define key=value for a @key@ entry in config fileDefault: [] |
dump-dependencies | boolean | Dump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command. |
dump-options | boolean | Dump configuration options in JSON formatThis is a command, no value needs to be specified. The process terminates after executing the command. |
fortune | boolean | Show fortune cookie on startupThis option can be specified without value to enable it.Default: false |
gid | string | Switch to group-id after reading config filesDefault: "" |
hund | boolean | Make ArangoDB bark on startupThis option can be specified without value to enable it.Default: false |
log | string… | The global or topic-specific log levelDefault: ["info","info"] Deprecated in: v3.5.0 |
pid-file | string | Pid-file in daemon modeDefault: "" |
supervisor | boolean | Background the server, starts a supervisorThis option can be specified without value to enable it.Default: false |
uid | string | Switch to user-id after reading config filesDefault: "" |
version | boolean | Reports the version and exitsThis is a command, no value needs to be specified. The process terminates after executing the command. |
working-directory | string | Working directory in daemon modeDefault: "/var/tmp" |
Agency
Also see Agency details.
Name | Type | Description |
---|---|---|
agency.activate | boolean | Activate agencyThis option can be specified without value to enable it.Default: false |
agency.compaction-keep-size | uint64 | Keep as many indices before compaction pointDefault: 50000 |
agency.compaction-step-size | uint64 | Step size between state machine compactionsDefault: 1000 |
agency.disaster-recovery-id | string | Allows for specification of the id for this agent; dangerous option for disaster recover only!Default: "" |
agency.election-timeout-max | double | Maximum timeout before an agent calls for new election (in seconds)Default: 5 |
agency.election-timeout-min | double | Minimum timeout before an agent calls for new election (in seconds)Default: 1 |
agency.endpoint | string… | Agency endpointsDefault: [] |
agency.max-append-size | uint64 | Maximum size of appendEntries document (# log entries)Default: 250 |
agency.my-address | string | Which address to advertise to the outsideDefault: "" |
agency.pool-size | uint64 | Number of agent poolDefault: 1 |
agency.size | uint64 | Number of agentsDefault: 1 |
agency.supervision | boolean | Perform arangodb cluster supervisionThis option can be specified without value to enable it.Default: false |
agency.supervision-frequency | double | Arangodb cluster supervision frequency (in seconds)Default: 1 |
agency.supervision-grace-period | double | Supervision time, after which a server is considered to have failed (in seconds)Default: 10 |
agency.wait-for-sync | boolean | 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
Also see ArangoSearch details.
Name | Type | Description |
---|---|---|
arangosearch.threads | uint64 | The exact number of threads to use for asynchronous tasks (0 == autodetect)Default: 0 |
arangosearch.threads-limit | uint64 | Upper limit to the autodetected number of threads to use for asynchronous tasks (0 == use default)Default: 0 |
Audit
Also see Audit details.
Name | Type | Description |
---|---|---|
audit.hostname | string | _Enterprise Edition only_Hostname to useDefault: "" |
audit.output | string… | _Enterprise Edition only_Audit destination(s)Default: [] |
Backup
Also see Backup details.
Name | Type | Description |
---|---|---|
backup.api-enabled | string | Whether the backup api is enabled (true) or not (false), or only enabled for superuser JWT (jwt)Default: "true" |
backup.local-path-prefix | string | This option restricts any backup target to a given path prefixDefault: "/" |
Cache
Also see Cache details.
Name | Type | Description |
---|---|---|
cache.rebalancing-interval | uint64 | Microseconds between rebalancing attemptsDefault: 2000000 |
cache.size | uint64 | Size of cache in bytesDefault: dynamic (e.g. 16341597184 ) |
Cluster
Also see Cluster details.
Name | Type | Description |
---|---|---|
cluster.agency-endpoint | string… | Agency endpoint to connect toDefault: [] |
cluster.agency-prefix | string | Agency prefixDefault: "" |
cluster.create-waits-for-sync-replication | boolean | Active coordinator will wait for all replicas to create collectionThis option can be specified without value to enable it.Default: true |
cluster.default-replication-factor | uint32 | Default replication factor for non-system collectionsDefault: 0 Introduced in: v3.6.0 |
cluster.force-one-shard | boolean | Force one-shard mode for all new collectionsThis option can be specified without value to enable it.Default: false Introduced in: v3.6.0 |
cluster.index-create-timeout | double | Amount of time (in seconds) the coordinator will wait for an index to be created before giving upDefault: 3600 |
cluster.max-number-of-shards | uint32 | Maximum number of shards when creating new collections (0 = unrestricted)Default: 1000 Introduced in: v3.5.1 |
cluster.max-replication-factor | uint32 | Maximum replication factor for new collections (0 = unrestricted)Default: 10 Introduced in: v3.6.0 |
cluster.min-replication-factor | uint32 | Minimum replication factor for new collectionsDefault: 1 Introduced in: v3.6.0 |
cluster.my-address | string | This server’s endpoint (cluster internal)Default: "" |
cluster.my-advertised-endpoint | string | This server’s advertised endpoint (e.g. external IP address or load balancer, optional)Default: "" |
cluster.my-role | string | This server’s roleDefault: "" |
cluster.require-persisted-id | boolean | 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 startupThis option can be specified without value to enable it.Default: false |
cluster.resign-leadership-on-shutdown | boolean | Create resign leader ship job for this dbsever on shutdownThis option can be specified without value to enable it.Default: false |
cluster.synchronous-replication-timeout-factor | double | All synchronous replication timeouts are multiplied by this factorDefault: 1 |
cluster.synchronous-replication-timeout-minimum | double | All synchronous replication timeouts will be at least this value (in seconds)Default: 30 |
cluster.synchronous-replication-timeout-per-4k | double | All synchronous replication timeouts are increased by this amount per 4096 bytes (in seconds)Default: 0.1 |
cluster.system-replication-factor | uint32 | Default replication factor for system collectionsDefault: 2 |
cluster.upgrade | string | Perform a cluster upgrade if necessary (auto = perform upgrade and shut down only if —database.auto-upgrade true is set, disable = never perform upgrade, force = always perform an upgrade and shut down, online = always perform an upgrade but don’t shut down)Default: "auto" Possible values: “auto”, “disable”, “force”, “online” |
cluster.write-concern | uint32 | Write concern used for writes to new collectionsDefault: 1 Introduced in: v3.6.0 |
Compaction
Also see Compaction details.
Name | Type | Description |
---|---|---|
compaction.db-sleep-time | double | Sleep interval between two compaction runs (in s)Default: 1 |
compaction.dead-documents-threshold | uint64 | Minimum unused count of documents in a datafileDefault: 16384 |
compaction.dead-size-percent-threshold | double | How many percent of the source datafile should be unused at leastDefault: 0.1 |
compaction.dead-size-threshold | uint64 | How many bytes of the source data file are allowed to be unused at mostDefault: 131072 |
compaction.max-file-size-factor | uint64 | How large the resulting file may be in comparison to the collections ‘—database.maximal-journal-size’ settingDefault: 3 |
compaction.max-files | uint64 | Maximum number of files to merge to one fileDefault: 3 |
compaction.max-result-file-size | uint64 | How large may the compaction result file become (in bytes)Default: 134217728 |
compaction.min-interval | double | Minimum sleep time between two compaction runs (in s)Default: 10 |
compaction.min-small-data-file-size | uint64 | Minimal filesize threshold original data files have to be below for a compactionDefault: 131072 |
Database
Also see Database details.
Name | Type | Description |
---|---|---|
database.auto-upgrade | boolean | Perform a database upgrade if necessaryThis option can be specified without value to enable it.Default: false |
database.check-version | boolean | Checks the versions of the database and exitThis is a command, no value needs to be specified. The process terminates after executing the command. |
database.directory | string | Path to the database directoryDefault: "" |
database.force-sync-properties | boolean | Force syncing of collection properties to disk, will use waitForSync value of collection when turned offThis option can be specified without value to enable it.Default: true |
database.ignore-datafile-errors | boolean | Load collections even if datafiles may contain errorsThis option can be specified without value to enable it.Default: false |
database.init-database | boolean | Initializes an empty databaseThis is a command, no value needs to be specified. The process terminates after executing the command. |
database.maximal-journal-size | uint64 | Default maximal journal size, can be overwritten when creating a collectionDefault: 33554432 |
database.password | string | Initial password of root userDefault: "" |
database.required-directory-state | string | 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-admin | boolean | Resets the admin users and sets a new passwordThis is a command, no value needs to be specified. The process terminates after executing the command. |
database.throw-collection-not-loaded-error | boolean | Throw an error when accessing a collection that is still loadingThis option can be specified without value to enable it.Default: false |
database.upgrade-check | boolean | Skip a database upgradeThis option can be specified without value to enable it.Default: true |
database.wait-for-sync | boolean | Default wait-for-sync behavior, can be overwritten when creating a collectionThis option can be specified without value to enable it.Default: false |
Foxx
Also see Foxx details.
Name | Type | Description |
---|---|---|
foxx.api | boolean | Enables Foxx management REST APIsThis option can be specified without value to enable it.Default: true Introduced in: v3.5.0 |
foxx.queues | boolean | Enable Foxx queuesThis option can be specified without value to enable it.Default: true |
foxx.queues-poll-interval | double | Poll interval (in seconds) for Foxx queue managerDefault: 1 |
foxx.store | boolean | Enables Foxx store in web interfaceThis option can be specified without value to enable it.Default: true Introduced in: v3.5.0 |
Frontend
Also see Frontend details.
Name | Type | Description |
---|---|---|
frontend.proxy-request-check | boolean | Enable proxy request checkingThis option can be specified without value to enable it.Default: true |
frontend.trusted-proxy | string… | List of proxies to trust (may be IP or network). Make sure —frontend.proxy-request-check is enabledDefault: [] |
frontend.version-check | boolean | Alert the user if new versions are availableThis option can be specified without value to enable it.Default: true |
HTTP
Also see HTTP details.
Name | Type | Description |
---|---|---|
http.allow-method-override | boolean | Allow HTTP method override using special headersThis option can be specified without value to enable it.Default: false |
http.hide-product-header | boolean | Do not expose “Server: ArangoDB” header in HTTP responsesThis option can be specified without value to enable it.Default: false |
http.keep-alive-timeout | double | Keep-alive timeout in secondsDefault: 300 |
http.trusted-origin | string… | Trusted origin URLs for CORS requests with credentialsDefault: [] |
JavaScript
Also see JavaScript details.
Name | Type | Description |
---|---|---|
javascript.allow-admin-execute | boolean | For testing purposes allow ‘_admin/execute’, NEVER enable on productionThis option can be specified without value to enable it.Default: false |
javascript.allow-external-process-control | boolean | Allow execution and control of external processes from within JavaScript actionsThis option can be specified without value to enable it.Default: false Introduced in: v3.5.0 |
javascript.allow-port-testing | boolean | Allow testing of ports from within JavaScript actionsThis option can be specified without value to enable it.Default: false Introduced in: v3.5.0 |
javascript.app-path | string | Directory for Foxx applicationsDefault: "./js/apps" |
javascript.copy-installation | boolean | Copy contents of ‘javascript.startup-directory’ on first startThis option can be specified without value to enable it.Default: false |
javascript.enabled | boolean | Enable the V8 JavaScript engineThis option can be specified without value to enable it.Default: true |
javascript.endpoints-blacklist | string… | Endpoints that cannot be connected to via @arangodb/request module in JavaScript actions if not whitelistedDefault: [] Introduced in: v3.5.0 |
javascript.endpoints-whitelist | string… | Endpoints that can be connected to via @arangodb/request module in JavaScript actionsDefault: [] Introduced in: v3.5.0 |
javascript.environment-variables-blacklist | string… | Environment variables that will be inaccessible in JavaScript if not whitelistedDefault: [] Introduced in: v3.5.0 |
javascript.environment-variables-whitelist | string… | Environment variables that will be accessible in JavaScriptDefault: [] Introduced in: v3.5.0 |
javascript.files-whitelist | string… | Filesystem paths that will be accessible from within JavaScript actionsDefault: [] Introduced in: v3.5.0 |
javascript.gc-frequency | double | JavaScript time-based garbage collection frequency (each x seconds)Default: 60 |
javascript.gc-interval | uint64 | JavaScript request-based garbage collection interval (each x requests)Default: 2000 |
javascript.harden | boolean | Disables access to JavaScript functions in the internal module: getPid() and logLevel()This option can be specified without value to enable it.Default: false Introduced in: v3.5.0 |
javascript.module-directory | string… | Additional paths containing JavaScript modulesDefault: ["./enterprise/js"] |
javascript.script | string… | Run scripts and exitDefault: [] |
javascript.script-parameter | string… | Script parameterDefault: [] |
javascript.startup-directory | string | Path to the directory containing JavaScript startup scriptsDefault: "./js" |
javascript.startup-options-blacklist | string… | Startup options whose names match this regular expression will not be exposed (if not whitelisted) to JavaScript actionsDefault: [] Introduced in: v3.5.0 |
javascript.startup-options-whitelist | string… | Startup options whose names match this regular expression will be whitelisted and exposed to JavaScriptDefault: [] Introduced in: v3.5.0 |
javascript.v8-contexts | uint64 | Maximum number of V8 contexts that are created for executing JavaScript actionsDefault: 0 |
javascript.v8-contexts-max-age | double | Maximum age for each V8 context (in seconds) before it is disposedDefault: 60 |
javascript.v8-contexts-max-invocations | uint64 | Maximum number of invocations for each V8 context before it is disposedDefault: 0 |
javascript.v8-contexts-minimum | uint64 | Minimum number of V8 contexts that keep available for executing JavaScript actionsDefault: 0 |
javascript.v8-max-heap | uint64 | Maximal heap size (in MB)Default: 3072 |
javascript.v8-options | string… | Options to pass to v8Default: [] |
LDAP
Also see LDAP details.
Name | Type | Description |
---|---|---|
ldap.async-connect | boolean | Enterprise Edition only_Whether or not the connection to the LDAP library will be done asynchronouslyThis option can be specified without value to enable it.Default: false |
ldap.basedn | string | _Enterprise Edition only_Ldap basedn, eg. dc=example,dc=comDefault: "" |
ldap.binddn | string | _Enterprise Edition only_Ldap binddn, eg. cn=admin,dc=example,dc=comDefault: "" |
ldap.bindpasswd | string | _Enterprise Edition only_Ldap bindpassword, eg. adminDefault: "" |
ldap.debug | boolean | _Enterprise 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.enabled | boolean | _Enterprise Edition only_Enable LDAPThis option can be specified without value to enable it.Default: false |
ldap.network-timeout | double | _Enterprise 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.port | uint16 | _Enterprise Edition only_Port to useDefault: 389 |
ldap.prefix | string | _Enterprise Edition only_Ldap prefix, eg. uid= xor dn= xor cn=Default: "" |
ldap.referrals | boolean | _Enterprise Edition only_Whether or not the LDAP library should implicitly chase referralsThis option can be specified without value to enable it.Default: false |
ldap.refresh-rate | double | _Enterprise Edition only_Refresh user settings after this time (in seconds)Default: 300 |
ldap.restart | boolean | _Enterprise Edition only_Whether or not the LDAP library should implicitly restart connectionsThis option can be specified without value to enable it.Default: false |
ldap.retries | uint32 | _Enterprise 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 connectionDefault: 1 |
ldap.roles-attribute-name | string | _Enterprise Edition only_Ldap attributename where the role are located.Default: "" |
ldap.roles-exclude | string | _Enterprise Edition only_Regexp to exclude groups. Leave empty to exclude none.Default: "" |
ldap.roles-include | string | _Enterprise Edition only_Regexp to include groups. Leave empty to include all.Default: "" |
ldap.roles-search | string | _Enterprise Edition only_Ldap search for roles; ‘{USER}’ is replaced by the ‘dn’ of the user.Default: "" |
ldap.roles-transformation | string… | _Enterprise Edition only_Regexp to normalizer role name, e.g. ‘/^ (._[^ ]])/$2/’Default: [] |
ldap.search-attribute | string | _Enterprise Edition only_Ldap search attribute, eg. uidDefault: "uid" |
ldap.search-filter | string | _Enterprise Edition only_Ldap search filter, eg. (objectClass=simpleSecurityObject)Default: "objectClass=" |
ldap.search-scope | string | _Enterprise Edition only_Ldap search scope, one of base, one, subDefault: "sub" |
ldap.serialize-timeout | double | _Enterprise Edition only_Maximum amount of time (in seconds) that will be waited for the serialization mutexDefault: 5 |
ldap.serialized | boolean | _Enterprise 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 functionalityThis option can be specified without value to enable it.Default: false |
ldap.server | string | _Enterprise Edition only_Server to useDefault: "" |
ldap.suffix | string | _Enterprise Edition only_Ldap suffix, eg. ,dc=example,dc=comDefault: "" |
ldap.superuser-role | string | _Enterprise Edition only_Role mapping to the super-usersDefault: "" |
ldap.timeout | double | _Enterprise Edition only_Timeout value (in seconds) for synchronous LDAP API calls (a value of 0 means default timeout)Default: 0 |
ldap.tls | boolean | _Enterprise Edition only_Enable TLSThis option can be specified without value to enable it.Default: false |
ldap.tls-cacert-dir | string | _Enterprise Edition only_Ldap tls cacert dirDefault: "" |
ldap.tls-cacert-file | string | _Enterprise Edition only_Ldap tls cacert fileDefault: "" |
ldap.tls-cert-check-strategy | string | _Enterprise Edition only_Ldap tls cert check strategy, one of never, hard, demand, allow, tryDefault: "hard" |
ldap.tls-version | string | _Enterprise Edition only_Ldap tls version, one of 1.0, 1.1, 1.2Default: "1.2" |
ldap.url | string | _Enterprise Edition only_Ldap url, eg. ldap://example.com:389/dc=example,dc=com?uid?subDefault: "" |
Log
Also see Log details.
Name | Type | Description |
---|---|---|
log.color | boolean | Use colors for TTY loggingThis option can be specified without value to enable it.Default: dynamic (e.g. true ) |
log.escape | boolean | Escape characters when loggingThis option can be specified without value to enable it.Default: true |
log.file | string | Shortcut for ‘—log.output file://"" |
log.file-group | string | Group to use for new log file, user must be a member of this groupDefault: "" Introduced in: v3.4.5, v3.5.0 |
log.file-mode | string | Mode to use for new log file, umask will be applied as wellDefault: "" Introduced in: v3.4.5, v3.5.0 |
log.force-direct | boolean | Do not start a seperate thread for loggingThis option can be specified without value to enable it.Default: false |
log.foreground-tty | boolean | Also log to tty if backgroundedThis option can be specified without value to enable it.Default: dynamic (e.g. false ) |
log.ids | boolean | Log unique message idsThis option can be specified without value to enable it.Default: true Introduced in: v3.5.0 |
log.keep-logrotate | boolean | Keep the old log file after receiving a sighupThis option can be specified without value to enable it.Default: false |
log.level | string… | The global or topic-specific log levelDefault: ["info","info"] |
log.line-number | boolean | Append line number and file nameThis option can be specified without value to enable it.Default: false |
log.output | string… | Log destination(s), e.g. file:///path/to/file (Linux, macOS) or file://C:\path\to\file (Windows)Default: [] |
log.performance | boolean | Shortcut for ‘—log.level performance=trace’This option can be specified without value to enable it.Default: false Deprecated in: v3.5.0 |
log.prefix | string | Prefix log message with this stringDefault: "" |
log.request-parameters | boolean | Include full URLs and HTTP request parameters in trace logsThis option can be specified without value to enable it.Default: true |
log.role | boolean | Log server roleThis option can be specified without value to enable it.Default: false |
log.shorten-filenames | boolean | Shorten filenames in log output (use with —log.line-number)This option can be specified without value to enable it.Default: true |
log.thread | boolean | Show thread identifier in log messageThis option can be specified without value to enable it.Default: false |
log.thread-name | boolean | Show thread name in log messageThis option can be specified without value to enable it.Default: false |
log.time-format | string | Time 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-time | boolean | Use local timezone instead of UTCThis option can be specified without value to enable it.Default: false Deprecated in: v3.5.0 |
log.use-microtime | boolean | Use microtime insteadThis option can be specified without value to enable it.Default: false Deprecated in: v3.5.0 |
Network
Also see Network details.
Name | Type | Description |
---|---|---|
network.idle-connection-ttl | uint64 | Default time-to-live of idle connections (in milliseconds)Default: 60000 Introduced in: v3.6.0 |
network.io-threads | uint32 | Number of network IO threadsDefault: 2 Introduced in: v3.6.0 |
network.max-open-connections | uint64 | Max open network connectionsDefault: 1024 Introduced in: v3.6.0 |
network.verify-hosts | boolean | Verify hosts when using TLSThis option can be specified without value to enable it.Default: false Introduced in: v3.6.0 |
Nonce
Also see Nonce details.
Name | Type | Description |
---|---|---|
nonce.size | uint64 | The size of the hash array for noncesDefault: 4194304 |
Query
Also see Query details.
Name | Type | Description |
---|---|---|
query.cache-entries | uint64 | Maximum number of results in query result cache per databaseDefault: 128 |
query.cache-entries-max-size | uint64 | Maximum cumulated size of results in query result cache per databaseDefault: 268435456 |
query.cache-entry-max-size | uint64 | Maximum size of an invidiual result entry in query result cacheDefault: 16777216 |
query.cache-include-system-collections | boolean | Whether or not to include system collection queries in the query result cacheThis option can be specified without value to enable it.Default: false |
query.cache-mode | string | Mode for the AQL query result cache (on, off, demand)Default: "off" |
query.fail-on-warning | boolean | Whether AQL queries should fail with errors even for recoverable warningsThis option can be specified without value to enable it.Default: false |
query.memory-limit | uint64 | Memory threshold for AQL queries (in bytes)Default: 0 |
query.optimizer-max-plans | uint64 | Maximum number of query plans to create for a queryDefault: 128 |
query.optimizer-rules | string… | Enable or disable specific optimizer rules (use rule name prefixed with ‘-‘ for disabling, ‘+’ for enabling)Default: [] Introduced in: v3.6.0 |
query.parallelize-gather-writes | boolean | Enable write parallelization for gather nodesThis option can be specified without value to enable it.Default: true Introduced in: v3.6.0 |
query.registry-ttl | double | Default time-to-live of cursors and query snippets (in seconds); if <= 0, value will default to 30 for single-server instances or 600 for cluster instancesDefault: 0 |
query.slow-streaming-threshold | double | Threshold for slow streaming AQL queries (in seconds)Default: 10 |
query.slow-threshold | double | Threshold for slow AQL queries (in seconds)Default: 10 |
query.smart-joins | boolean | _Enterprise Edition only_Enable smart joins query optimizationThis option can be specified without value to enable it.Default: true Introduced in: v3.4.5, v3.5.0 |
query.tracking | boolean | Whether to track slow AQL queriesThis option can be specified without value to enable it.Default: true |
query.tracking-with-bindvars | boolean | Whether to track bind vars with AQL queriesThis option can be specified without value to enable it.Default: true |
Random
Also see Random details.
Name | Type | Description |
---|---|---|
random.generator | uint32 | 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 |
Rclone
Also see Rclone details.
Name | Type | Description |
---|---|---|
rclone.executable | string | Rclone executable used for up and download of backupsDefault: "" |
Replication
Also see Replication details.
Name | Type | Description |
---|---|---|
replication.active-failover | boolean | Enable active-failover during asynchronous replicationThis option can be specified without value to enable it.Default: false |
replication.auto-start | boolean | Switch to enable or disable the automatic start of replication appliersThis option can be specified without value to enable it.Default: true |
replication.automatic-failover | boolean | Please use —replication.active-failover insteadThis option can be specified without value to enable it.Default: false |
replication.connect-timeout | double | Default timeout value for replication connection attempts (in seconds)Default: 10 Introduced in: v3.4.9, v3.5.4 |
replication.max-parallel-tailing-invocations | uint64 | Maximum number of concurrently allowed WAL tailing invocations (0 = unlimited)Default: 0 Introduced in: v3.5.0 |
replication.request-timeout | double | Default timeout value for replication requests (in seconds)Default: 600 Introduced in: v3.4.9, v3.5.4 |
RocksDB
Also see RocksDB details.
Name | Type | Description |
---|---|---|
rocksdb.allow-fallocate | boolean | If true, allow RocksDB to use fallocate calls. if false, fallocate calls are bypassedThis option can be specified without value to enable it.Default: true Introduced in: v3.4.5, v3.5.0 |
rocksdb.block-align-data-blocks | boolean | If true, aligns data blocks on lesser of page size and block sizeThis option can be specified without value to enable it.Default: false |
rocksdb.block-cache-shard-bits | int64 | Number of shard bits to use for block cache (use -1 for default value)Default: -1 |
rocksdb.block-cache-size | uint64 | Size of block cache in bytesDefault: dynamic (e.g. 19609916620 ) |
rocksdb.compaction-read-ahead-size | uint64 | 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.create-sha-files | boolean | Enterprise Edition only_Enable generation of sha256 files for each .sst fileThis option can be specified without value to enable it.Default: true |
rocksdb.debug-logging | boolean | True to enable rocksdb debug loggingThis option can be specified without value to enable it.Default: false |
rocksdb.delayed-write-rate | uint64 | 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 writesDefault: 0 |
rocksdb.dynamic-level-bytes | boolean | If true, determine the number of bytes for each level dynamically to minimize space amplificationThis option can be specified without value to enable it.Default: true |
rocksdb.enable-pipelined-write | boolean | If true, use a two stage write queue for WAL writes and memtable writesThis option can be specified without value to enable it.Default: false |
rocksdb.enable-statistics | boolean | Whether or not RocksDB statistics should be turned onThis option can be specified without value to enable it.Default: false |
rocksdb.encryption-key-generator | string | _Enterprise Edition only_Program providing the encryption key on stdout. If set, encryption will be enabled.Default: "" |
rocksdb.encryption-keyfile | string | _Enterprise Edition only_File containing encryption key. If set, encryption will be enabled.Default: "" |
rocksdb.enforce-block-cache-size-limit | boolean | If true, strictly enforces the block cache size limitThis option can be specified without value to enable it.Default: false |
rocksdb.exclusive-writes | boolean | If true, writes are exclusive. This allows the RocksDB engine to mimic the MMFiles collection locks behavior, but will inhibit concurrent write operationsThis option can be specified without value to enable it.Default: false Introduced in: v3.5.4 |
rocksdb.intermediate-commit-count | uint64 | An intermediate commit will be performed automatically when this number of operations is reached in a transactionDefault: 1000000 |
rocksdb.intermediate-commit-size | uint64 | An intermediate commit will be performed automatically when a transaction has accumulated operations of this size (in bytes)Default: 536870912 |
rocksdb.level0-compaction-trigger | int64 | Number of level-0 files that triggers a compactionDefault: 2 |
rocksdb.level0-slowdown-trigger | int64 | Number of level-0 files that triggers a write slowdownDefault: 20 |
rocksdb.level0-stop-trigger | int64 | Number of level-0 files that triggers a full write stallDefault: 36 |
rocksdb.limit-open-files-at-startup | boolean | Limit the amount of .sst files RocksDB will inspect at startup, in order to startup reduce IOThis option can be specified without value to enable it.Default: false Introduced in: v3.4.5, v3.5.0 |
rocksdb.max-background-jobs | int32 | Maximum number of concurrent background jobs (compactions and flushes)Default: _dynamic (e.g. 8 ) |
rocksdb.max-bytes-for-level-base | uint64 | If not using dynamic level sizes, this controls the maximum total data size for level-1Default: 268435456 |
rocksdb.max-bytes-for-level-multiplier | double | 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-subcompactions | uint64 | Maximum number of concurrent subjobs for a background compactionDefault: 1 |
rocksdb.max-total-wal-size | uint64 | Maximum total size of WAL files that will force flush stale column familiesDefault: 83886080 |
rocksdb.max-transaction-size | uint64 | Transaction size limit (in bytes)Default: 18446744073709551615 |
rocksdb.max-write-buffer-number | uint64 | Maximum number of write buffers that build up in memory (default: number of column families + 2 = 9 write buffers). You can increase the amount onlyDefault: 9 |
rocksdb.min-write-buffer-number-to-merge | uint64 | Minimum number of write buffers that will be merged together before writing to storageDefault: 1 |
rocksdb.num-levels | uint64 | Number of levels for the databaseDefault: 7 |
rocksdb.num-threads-priority-high | uint32 | Number of threads for high priority operations (e.g. flush)Default: 0 |
rocksdb.num-threads-priority-low | uint32 | Number of threads for low priority operations (e.g. compaction)Default: 0 |
rocksdb.num-uncompressed-levels | uint64 | Number of uncompressed levels for the databaseDefault: 2 |
rocksdb.optimize-filters-for-hits | boolean | 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 importantThis option can be specified without value to enable it.Default: false |
rocksdb.recycle-log-file-num | boolean | If true, keep a pool of log files around for recyclingThis option can be specified without value to enable it.Default: false |
rocksdb.sync-interval | uint64 | Interval for automatic, non-requested disk syncs (in milliseconds, use 0 to turn automatic syncing off)Default: 100 |
rocksdb.table-block-size | uint64 | Approximate size (in bytes) of user data packed per blockDefault: 16384 |
rocksdb.throttle | boolean | Enable write-throttlingThis option can be specified without value to enable it.Default: true |
rocksdb.total-write-buffer-size | uint64 | Maximum total size of in-memory write buffers (0 = unbounded)Default: dynamic (e.g. 26146555494 ) |
rocksdb.transaction-lock-timeout | int64 | 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-compaction | boolean | Use O_DIRECT for flush and compactionThis option can be specified without value to enable it.Default: false |
rocksdb.use-direct-reads | boolean | Use O_DIRECT for reading filesThis option can be specified without value to enable it.Default: false |
rocksdb.use-file-logging | boolean | Use a file-base logger for RocksDB’s own logsThis option can be specified without value to enable it.Default: false |
rocksdb.use-fsync | boolean | 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-limit | uint64 | Maximum total size (in bytes) of archived WAL files (0 = unlimited)Default: 0 |
rocksdb.wal-directory | string | Optional path to the RocksDB WAL directory. If not set, the WAL directory will be located inside the regular data directoryDefault: "" |
rocksdb.wal-file-timeout | double | Timeout after which unused WAL files are deletedDefault: 10 |
rocksdb.wal-file-timeout-initial | double | Initial timeout after which unused WAL files deletion kicks in after server startDefault: 180 |
rocksdb.wal-recovery-skip-corrupted | boolean | Skip corrupted records in WAL recoveryThis option can be specified without value to enable it.Default: false |
rocksdb.write-buffer-size | uint64 | Amount of data to build up in memory before converting to a sorted on-disk file (0 = disabled)Default: 67108864 |
Server
Also see Server details.
Name | Type | Description |
---|---|---|
server.allow-use-database | boolean | Allow change of database in REST actions, only needed for unittestsThis option can be specified without value to enable it.Default: false |
server.authentication | boolean | Enable authentication for ALL client requestsThis option can be specified without value to enable it.Default: true |
server.authentication-system-only | boolean | Use HTTP authentication only for requests to /api and /_adminThis option can be specified without value to enable it.Default: true |
server.authentication-timeout | double | Timeout for the authentication cache in seconds (0 = indefinitely)Default: 0 |
server.authentication-unix-sockets | boolean | Authentication for requests via UNIX domain socketsThis option can be specified without value to enable it.Default: true |
server.check-max-memory-mappings | boolean | Check the maximum number of memory mappings at runtimeThis option can be specified without value to enable it.Default: true |
server.descriptors-minimum | uint64 | Minimum number of file descriptors needed to startDefault: 0 |
server.endpoint | string… | 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.export-metrics-api | boolean | Turn metrics API on or offThis option can be specified without value to enable it.Default: true |
server.flush-interval | uint64 | Interval (in microseconds) for flushing dataDefault: 1000000 |
server.gid | string | Switch to group-id after reading config filesDefault: "" |
server.harden | boolean | Lock down REST APIs that reveal version information or server internals for non-admin usersThis option can be specified without value to enable it.Default: false Introduced in: v3.5.0 |
server.io-threads | uint64 | Number of threads used to handle IODefault: _dynamic (e.g. 8 ) |
server.jwt-secret | string | Secret to use when doing jwt authenticationDefault: "" Deprecated in: v3.3.22, v3.4.2 |
server.jwt-secret-keyfile | string | File containing jwt secret to use when doing jwt authentication.Default: "" |
server.local-authentication | boolean | Enable authentication using the local user databaseThis option can be specified without value to enable it.Default: true |
server.maintenance-actions-block | int32 | Minimum number of seconds finished Actions block duplicatesDefault: 2 |
server.maintenance-actions-linger | int32 | Minimum number of seconds finished Actions remain in dequeDefault: 3600 |
server.maintenance-threads | uint32 | Maximum number of threads available for maintenance actionsDefault: dynamic (e.g. 9 ) |
server.maximal-queue-size | uint64 | Size of the priority 2 fifoDefault: 4096 |
server.maximal-threads | uint64 | Maximum number of request handling threads to run (0 = use system-specific default of 64)Default: dynamic (e.g. 0 ) |
server.minimal-threads | uint64 | Minimum number of request handling threads to runDefault: 2 |
server.prio1-size | uint64 | Size of the priority 1 fifoDefault: 4096 |
server.rest-server | boolean | Start a rest-serverThis option can be specified without value to enable it.Default: true |
server.scheduler-queue-size | uint64 | Number of simultaneously queued requests inside the schedulerDefault: 4096 |
server.statistics | boolean | Turn statistics gathering on or offThis option can be specified without value to enable it.Default: true |
server.statistics-history | boolean | Turn storing statistics in database on or offThis option can be specified without value to enable it.Default: true Introduced in: v3.4.9, v3.5.1 |
server.storage-engine | string | Storage engine typeDefault: "auto" Possible values: “auto”, “mmfiles”, “rocksdb” |
server.uid | string | Switch to user-id after reading config filesDefault: "" |
SSL
Also see SSL details.
Name | Type | Description |
---|---|---|
ssl.cafile | string | Ca file used for secure connectionsDefault: "" |
ssl.cipher-list | string | Ssl ciphers to use, see OpenSSL documentationDefault: "HIGH:!EXPORT:!aNULL@STRENGTH" |
ssl.ecdh-curve | string | SSL ECDH Curve, see the output of “openssl ecparam -list_curves”Default: "prime256v1" |
ssl.keyfile | string | Key-file used for secure connectionsDefault: "" |
ssl.options | uint64 | Ssl connection options, see OpenSSL documentationDefault: 2147485780 |
ssl.protocol | uint64 | Ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS)Default: 9 Possible values: 1, 2, 3, 4, 5, 6, 9 |
ssl.require-peer-certificate | boolean | _Enterprise Edition only_Require a peer certificate when connectingThis option can be specified without value to enable it.Default: false |
ssl.session-cache | boolean | Enable the session cache for connectionsThis option can be specified without value to enable it.Default: false |
TCP
Also see TCP details.
Name | Type | Description |
---|---|---|
tcp.backlog-size | uint64 | Listen backlog sizeDefault: 64 |
tcp.reuse-address | boolean | Try to reuse TCP port(s)This option can be specified without value to enable it.Default: true |
Temp
Also see Temp details.
Name | Type | Description |
---|---|---|
temp.path | string | Path for temporary filesDefault: "" |
TTL
Also see TTL details.
Name | Type | Description |
---|---|---|
ttl.frequency | uint64 | Frequency (in milliseconds) for the TTL background thread invocation. a value of 0 turns the TTL background thread off entirelyDefault: 30000 |
ttl.max-collection-removes | uint64 | Maximum number of documents to remove per collectionDefault: 1000000 |
ttl.max-total-removes | uint64 | Maximum number of documents to remove per invocation of the TTL threadDefault: 1000000 |
ttl.only-loaded-collection | boolean | Only consider already loaded collections for removalThis option can be specified without value to enable it.Default: true |
WAL
Also see WAL details.
Name | Type | Description |
---|---|---|
wal.allow-oversize-entries | boolean | Allow entries that are bigger than ‘—wal.logfile-size’This option can be specified without value to enable it.Default: true |
wal.directory | string | Logfile directoryDefault: "" |
wal.flush-timeout | uint64 | Flush timeout (in milliseconds)Default: 15000 |
wal.historic-logfiles | uint32 | Maximum number of historic logfiles to keep after collectionDefault: 10 |
wal.ignore-logfile-errors | boolean | Ignore logfile errors. this will read recoverable data from corrupted logfiles but ignore any unrecoverable dataThis option can be specified without value to enable it.Default: false |
wal.ignore-recovery-errors | boolean | Continue recovery even if re-applying operations failsThis option can be specified without value to enable it.Default: false |
wal.logfile-size | uint32 | Size of each logfile (in bytes)Default: 33554432 |
wal.open-logfiles | uint32 | Maximum number of parallel open logfilesDefault: 0 |
wal.reserve-logfiles | uint32 | Maximum number of reserve logfiles to maintainDefault: 3 |
wal.slots | uint32 | Number of logfile slots to useDefault: 1048576 |
wal.sync-interval | uint64 | Interval for automatic, non-requested disk syncs (in milliseconds)Default: 100 |
wal.throttle-wait | uint64 | Maximum wait time per operation when write-throttled (in milliseconds)Default: 15000 |
wal.throttle-when-pending | uint64 | Throttle writes when at least this many operations are waiting for collection (set to 0 to deactivate write-throttling)Default: 0 |
wal.use-mlock | boolean | Mlock WAL logfiles in memory (may require elevated privileges or limits)This option can be specified without value to enable it.Default: false |