ArangoDB v3.4 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent version here: Latest Docs

Arangoimport Options

Usage: arangoimport [<options>]

General

Name Type Description
backslash-escape boolean Use backslash as the escape character for quotes, used for csv
This option can be specified without value to enable it.
Default: false
batch-size uint64 Size for individual data batches (in bytes)
Default: 1048576
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 Collection name
Default: ""
config string The configuration file or ‘none’
Default: ""
configuration string The configuration file or ‘none’
Default: ""
convert boolean Convert the strings ‘null’, ‘false’, ‘true’ and strings containing numbers into non-string types (csv and tsv only)
This option can be specified without value to enable it.
Default: true
create-collection boolean Create collection if it does not yet exist
This option can be specified without value to enable it.
Default: false
create-collection-type string Type of collection if collection is created (edge or document)
Default: "document"
Possible values: “document”, “edge”
create-database boolean Create the target database if it does not exist
This option can be specified without value to enable it.
Default: false
define string… Define key=value for a @key@ entry in config file
Default: []
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.
file string File name (“-“ for STDIN)
Default: ""
from-collection-prefix string _from collection name prefix (will be prepended to all values in ‘_from’)
Default: ""
ignore-missing boolean Ignore missing columns in csv input
This option can be specified without value to enable it.
Default: false
latency boolean Show 10 second latency statistics (values in microseconds)
This option can be specified without value to enable it.
Default: false
log string… The global or topic-specific log level
Default: ["info"]
on-duplicate string Action to perform when a unique key constraint violation occurs. Possible values: ignore, replace, update, error
Default: "error"
Possible values: “error”, “ignore”, “replace”, “update”
overwrite boolean Overwrite collection if it exist (WARNING: this will remove any data from the collection)
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
quote string Quote character(s), used for csv
Default: "\""
remove-attribute string… Remove an attribute before inserting an attribute into a collection (for csv and tsv only)
Default: []
separator string Field separator, used for csv and tsv
Default: ""
skip-lines uint64 Number of lines to skip for formats (csv and tsv only)
Default: 0
threads uint32 Number of parallel import threads. Most useful for the rocksdb engine
Default: 2
to-collection-prefix string _to collection name prefix (will be prepended to all values in ‘_to’)
Default: ""
translate string… Translate an attribute name (use as --translate “from=to”, for csv and tsv only)
Default: []
type string Type of import file
Default: "json"
Possible values: “auto”, “csv”, “json”, “jsonl”, “tsv”
version boolean Reports the version and exits
This is a command, no value needs to be specified. The process terminates after executing the command.

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.api-enabled string Whether the log api is enabled (true) or not (false), or only enabled for superuser JWT (jwt)
Default: "true"
Introduced in: v3.4.11, v3.5.6, v3.6.5
log.color boolean Use colors for TTY logging
This option can be specified without value to enable it.
Default: 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, v3.5.0
log.file-mode string Mode to use for new log file, umask will be applied as well
Default: ""
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.
Default: false
log.foreground-tty boolean Also log to tty if backgrounded
This option can be specified without value to enable it.
Default: false
log.keep-logrotate boolean Keep the old log file after receiving a sighup
This option can be specified without value to enable it.
Default: false
log.level string… The global or topic-specific log level
Default: ["info"]
log.line-number boolean Append line number and file name
This option can be specified without value to enable it.
Default: false
log.output string… Log destination(s)
Default: []
log.performance boolean Shortcut for ‘--log.level performance=trace’
This option can be specified without value to enable it.
Default: false
log.prefix string Prefix log message with this string
Default: ""
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.use-local-time boolean Use local timezone instead of UTC
This option can be specified without value to enable it.
Default: false
log.use-microtime boolean Use microtime instead
This option can be specified without value to enable it.
Default: false

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.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, 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2)
Default: 5
Possible values: 1, 2, 3, 4, 5

Temp

Name Type Description
temp.path string Path for temporary files
Default: ""