Arangoexport Options

Usage: arangoexport [<options>]

Global

Name Type Description
check-configuration boolean Check the configuration and exit
This is a command, no value needs to be specified. The process terminates after executing the command.
collection string… Restrict to collection name (can be specified multiple times)
compress-output boolean Compress files containing collection contents using gzip format
This option can be specified without value to enable it.

Introduced in: v3.4.8, v3.5.1
config string The configuration file or ‘none’
configuration string The configuration file or ‘none’
define string… Define key=value for a @key@ entry in config file
dump-dependencies boolean Dump dependency graph
This is a command, no value needs to be specified. The process terminates after executing the command.
dump-options boolean Dump configuration options in JSON format
This is a command, no value needs to be specified. The process terminates after executing the command.
fields string Comma separated list of fields to export into a csv file
graph-name string Name of a graph to export
log string… The global or topic-specific log level

Deprecated in: v3.5.0
output-directory string Output directory
overwrite boolean Overwrite data in output directory
This option can be specified without value to enable it.
progress boolean Show progress
This option can be specified without value to enable it.
query string AQL query to run
type string Type of export

Possible values: “csv”, “json”, “jsonl”, “xgmml”, “xml”
version boolean Reports the version and exits
This is a command, no value needs to be specified. The process terminates after executing the command.
xgmml-label-attribute string Specify document attribute that will be the xgmml label
xgmml-label-only boolean Export only xgmml label
This option can be specified without value to enable it.

Encryption

Name Type Description
encryption.key-generator string Enterprise Edition only
Program providing the encryption key on stdout. If set, encryption will be enabled.
encryption.keyfile string Enterprise Edition only
File containing the encryption key. If set, encryption will be enabled.

Log

Name Type Description
log.color boolean Use colors for TTY logging
This option can be specified without value to enable it.
log.escape boolean Escape characters when logging
This option can be specified without value to enable it.
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 group

Introduced in: v3.4.5, v3.5.0
log.file-mode string Mode to use for new log file, umask will be applied as well

Introduced in: v3.4.5, v3.5.0
log.force-direct boolean Do not start a seperate thread for logging
This option can be specified without value to enable it.
log.foreground-tty boolean Also log to tty if backgrounded
This option can be specified without value to enable it.
log.ids boolean Log unique message ids
This option can be specified without value to enable it.

Introduced in: v3.5.0
log.keep-logrotate boolean Keep the old log file after receiving a sighup
This option can be specified without value to enable it.
log.level string… The global or topic-specific log level
log.line-number boolean Append line number and file name
This option can be specified without value to enable it.
log.output string… Log destination(s), e.g. file:///path/to/file (Linux, macOS) or file://C:\path\to\file (Windows)
log.performance boolean Shortcut for ‘--log.level performance=trace’
This option can be specified without value to enable it.

Deprecated in: v3.5.0
log.prefix string Prefix log message with this string
log.request-parameters boolean Include full URLs and HTTP request parameters in trace logs
This option can be specified without value to enable it.
log.role boolean Log server role
This option can be specified without value to enable it.
log.shorten-filenames boolean Shorten filenames in log output (use with --log.line-number)
This option can be specified without value to enable it.
log.thread boolean Show thread identifier in log message
This option can be specified without value to enable it.
log.thread-name boolean Show thread name in log message
This option can be specified without value to enable it.
log.time-format string Time format to use in logs

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 UTC
This option can be specified without value to enable it.

Deprecated in: v3.5.0
log.use-microtime boolean Use microtime instead
This option can be specified without value to enable it.

Deprecated in: v3.5.0

Random

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)

Possible values: 1, 2, 3, 4

Server

Name Type Description
server.authentication boolean Require authentication credentials when connecting (does not affect the server-side authentication settings)
This option can be specified without value to enable it.
server.connection-timeout double Connection timeout in seconds
server.database string Database name to use when connecting
server.endpoint string Endpoint 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://
server.force-json boolean Force to not use VelocyPack for easier debugging
This option can be specified without value to enable it.

Introduced in: v3.6.0
server.max-packet-size uint64 Maximum packet size (in bytes) for client/server communication
server.password string Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password
server.request-timeout double Request timeout in seconds
server.username string Username to use when connecting

SSL

Name Type Description
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)

Possible values: 1, 2, 3, 4, 5, 6, 9

Temp

Name Type Description
temp.path string Path for temporary files