arangoexport Options

arangoexport Options

Usage: arangoexport [<options>]

General

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) Default: `[]`
`compress-output`	boolean	Compress files containing collection contents using gzip format This option can be specified without value to enable it. Default: `false` Introduced in: v3.4.8, v3.5.1
`config`	string	The configuration file or ‘none’ Default: `“”`
`configuration`	string	The configuration file or ‘none’ Default: `“”`
`define`	string…	Define key=value for a @key@ entry in config file Default: `[]`
`documents-per-batch`	uint64	Number of documents to return in each batch Default: `1000` Introduced in: v3.8.0
`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 Default: `“”`
`graph-name`	string	Name of a graph to export Default: `“”`
`log`	string…	The global or topic-specific log level Default: `[“info”]` Deprecated in: v3.5.0
`output-directory`	string	Output directory Default: `“/work/ArangoDB/export”`
`overwrite`	boolean	Overwrite data in output directory This option can be specified without value to enable it. Default: `false`
`progress`	boolean	Show progress This option can be specified without value to enable it. Default: `true`
`query`	string	AQL query to run Default: `“”`
`query-max-runtime`	double	Runtime threshold for AQL queries (in seconds, 0 = no limit) Default: `0` Introduced in: v3.8.0
`type`	string	Type of export Default: `“json”` 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 Default: `“label”`
`xgmml-label-only`	boolean	Export only xgmml label This option can be specified without value to enable it. Default: `false`

Encryption

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

Log

Name	Type	Description
`log.color`	boolean	Use colors for TTY logging This option can be specified without value to enable it. Default: dynamic (e.g. `true`)
`log.escape`	boolean	Escape characters when logging This option can be specified without value to enable it. Default: `true`
`log.file`	string	Shortcut for ‘—log.output file://‘ Default: `“-“`
`log.file-group`	string	Group to use for new log file, user must be a member of this group Default: `“”` Introduced in: v3.4.5
`log.file-mode`	string	Mode to use for new log file, umask will be applied as well Default: `“”` Introduced in: v3.4.5
`log.force-direct`	boolean	Do not start a seperate thread for logging This option can be specified without value to enable it. Default: `false`
`log.foreground-tty`	boolean	Also log to tty if backgrounded This option can be specified without value to enable it. Default: dynamic (e.g. `false`)
`log.hostname`	string	Hostname to use in log message (empty for none, use ‘auto’ to automatically figure out hostname) Default: `“”` Introduced in: v3.8.0
`log.ids`	boolean	Log unique message ids This option can be specified without value to enable it. Default: `true` Introduced in: v3.5.0
`log.level`	string…	The global or topic-specific log level Default: `[“info”]`
`log.line-number`	boolean	Include the function name, file name and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]` This option can be specified without value to enable it. Default: `false`
`log.max-entry-length`	uint32	Maximum length of a log entry (in bytes) Default: `134217728` Introduced in: v3.7.9
`log.output`	string…	Log destination(s), e.g. file:///path/to/file (any ‘$PID’ will be replaced with the process id) 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 string Default: `“”`
`log.process`	boolean	Show process identifier (pid) in log message This option can be specified without value to enable it. Default: `true` Introduced in: v3.8.0
`log.request-parameters`	boolean	Include full URLs and HTTP request parameters in trace logs This option can be specified without value to enable it. Default: `true`
`log.role`	boolean	Log server role This 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 message This option can be specified without value to enable it. Default: `false`
`log.thread-name`	boolean	Show thread name in log message This option can be specified without value to enable it. Default: `false`
`log.time-format`	string	Time format to use in logs Default: `“utc-datestring”` Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis” Introduced in: v3.5.0
`log.use-json-format`	boolean	Use json output format This option can be specified without value to enable it. Default: `false` Introduced in: v3.8.0
`log.use-local-time`	boolean	Use local timezone instead of UTC This option can be specified without value to enable it. Default: `false` Deprecated in: v3.5.0
`log.use-microtime`	boolean	Use microtime instead This option can be specified without value to enable it. Default: `false` 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) Default: `1` 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. Default: `false`
`server.connection-timeout`	double	Connection timeout in seconds Default: `5`
`server.database`	string	Database name to use when connecting Default: `“_system”`
`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:// Default: `“http+tcp://127.0.0.1:8529”`
`server.force-json`	boolean	Force to not use VelocyPack for easier debugging This option can be specified without value to enable it. Default: `false` Introduced in: v3.6.0
`server.max-packet-size`	uint64	Maximum packet size (in bytes) for client/server communication Default: `1073741824`
`server.password`	string	Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password Default: `“”`
`server.request-timeout`	double	Request timeout in seconds Default: `1200`
`server.username`	string	Username to use when connecting Default: `“root”`

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) Default: `5` Possible values: 1, 2, 3, 4, 5, 6, 9

Temp

Name	Type	Description
`temp.path`	string	Path for temporary files Default: `“”`