arangoimport Options

Usage: arangoimport [<options>]

General

--auto-rate-limit

Introduced in: v3.7.11

Type: boolean

Adjust the data loading rate automatically, starting at --batch-size bytes per thread per second.

This option can be specified without a value to enable it.

--backslash-escape

Type: boolean

Use backslash as the escape character for quotes. Used for CSV and TSV imports.

This option can be specified without a value to enable it.

--batch-size

Type: uint64

The size for individual data batches (in bytes).

Default: 8388608

--check-configuration

Type: boolean

Check the configuration and exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

--collection

Type: string

The name of the collection to import into.

--config

Type: string

The configuration file or “none”.

--configuration

Type: string

The configuration file or “none”.

--convert

Type: boolean

Convert the strings null, false, true and strings containing numbers into non-string types. For CSV and TSV only.

This option can be specified without a value to enable it.

Default: true

--create-collection

Type: boolean

create collection if it does not yet exist

This option can be specified without a value to enable it.

--create-collection-type

Type: string

The type of the collection if it needs to be created (edge or document).

Default: document

Possible values: “document”, “edge”

--create-database

Type: boolean

Create the target database if it does not exist.

This option can be specified without a value to enable it.

--datatype

Introduced in: v3.9.0

Type: string…

Force a specific datatype for an attribute (null/boolean/number/string) using the syntax “attribute=type”. For CSV and TSV only. Takes precedence over --convert.

--define

Type: string…

Define a value for a @key@ entry in the configuration file using the syntax "key=value".

--dump-dependencies

Type: boolean

Dump the dependency graph of the feature phases (internal) and exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

--dump-options

Type: boolean

Dump all available startup options in JSON format and exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

--file

Type: string

The file to import ("-" for stdin).

--from-collection-prefix

Type: string

The collection name prefix to prepend to all values in the _from attribute.

--headers-file

Introduced in: v3.8.0

Type: string

The file to read the CSV or TSV header from. If specified, no header is expected in the regular input file.

--ignore-missing

Type: boolean

Ignore missing columns in CSV and TSV input.

This option can be specified without a value to enable it.

--latency

Type: boolean

Show 10 second latency statistics (values in microseconds).

This option can be specified without a value to enable it.

--log

Deprecated in: v3.5.0

Type: string…

Set the topic-specific log level, using --log level for the general topic or --log topic=level for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.

Default: info

--merge-attributes

Introduced in: v3.9.1

Type: string…

Merge attributes into new document attribute (e.g. “mergedAttribute=[someAttribute]-[otherAttribute]”) (CSV and TSV only)

--on-duplicate

Type: string

The 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

Type: boolean

Overwrite the collection if it exists. WARNING: This removes any data from the collection!

This option can be specified without a value to enable it.

--overwrite-collection-prefix

Type: boolean

If the collection name is already prefixed, overwrite the prefix. Only useful in combination with --from-collection-prefix / --to-collection-prefix.

This option can be specified without a value to enable it.

--progress

Type: boolean

Show the progress.

This option can be specified without a value to enable it.

Default: true

--quote

Type: string

Quote character(s). Used for CSV and TSV.

Default: "

--remove-attribute

Type: string…

remove an attribute before inserting documents into collection (for CSV, TSV and JSON only)

--separator

Type: string

The field separator. Used for CSV and TSV imports. Defaults to a comma (CSV) or a tabulation character (TSV).

--skip-lines

Type: uint64

The number of lines to skip of the input file (CSV and TSV only).

--skip-validation

Introduced in: v3.7.0

Type: boolean

Skip document schema validation during import.

This option can be specified without a value to enable it.

--threads

Type: uint32

Number of parallel import threads.

Default: dynamic (e.g. 8)

--to-collection-prefix

Type: string

The collection name prefix to prepend to all values in the _to attribute.

--translate

Type: string…

Translate an attribute name using the syntax “from=to”. For CSV and TSV only.

--type

Type: string

The format of import file.

Default: json

Possible values: “auto”, “csv”, “json”, “jsonl”, “tsv”

--use-splice-syscall

Introduced in: v3.9.4

Type: boolean

Use the splice() syscall for file copying (may not be supported on all filesystems).

This option can be specified without a value to enable it.

Default: true

Available on Linux only.

--version

Type: boolean

Print the version and other related information, then exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

--version-json

Introduced in: v3.9.0

Type: boolean

Print the version and other related information in JSON format, then exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

encryption

--encryption.key-generator

Enterprise Edition only

Type: string

A program providing the encryption key on stdout. If set, encryption at rest is enabled.

--encryption.keyfile

Enterprise Edition only

Type: string

The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.

log

--log.color

Type: boolean

Use colors for TTY logging.

This option can be specified without a value to enable it.

Default: dynamic (e.g. true)

--log.escape-control-chars

Introduced in: v3.9.0

Type: boolean

Escape control characters in log messages.

This option can be specified without a value to enable it.

Default: true

--log.escape-unicode-chars

Introduced in: v3.9.0

Type: boolean

Escape Unicode characters in log messages.

This option can be specified without a value to enable it.

--log.file

Type: string

shortcut for ‘--log.output file://’

Default: -

--log.file-group

Introduced in: v3.4.5

Type: string

group to use for new log file, user must be a member of this group

--log.file-mode

Introduced in: v3.4.5

Type: string

mode to use for new log file, umask will be applied as well

--log.force-direct

Type: boolean

Do not start a separate thread for logging.

This option can be specified without a value to enable it.

--log.foreground-tty

Type: boolean

Also log to TTY if backgrounded.

This option can be specified without a value to enable it.

--log.hostname

Introduced in: v3.8.0

Type: string

The hostname to use in log message. Leave empty for none, use “auto” to automatically determine a hostname.

--log.ids

Introduced in: v3.5.0

Type: boolean

Log unique message IDs.

This option can be specified without a value to enable it.

Default: true

--log.level

Type: string…

Set the topic-specific log level, using --log.level level for the general topic or --log.level topic=level for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace. Available log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.

Default: info

arangod --log.level all=warning --log.level queries=trace --log.level startup=trace

[log]
level = all=warning
level = queries=trace
level = startup=trace

--log.line-number

Type: 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 a value to enable it.

--log.max-entry-length

Introduced in: v3.7.9

Type: uint32

The maximum length of a log entry (in bytes).

Default: 134217728

--log.max-queued-entries

Introduced in: v3.10.12

Type: uint32

Upper limit of log entries that are queued in a background thread.

Default: 10000

--log.output

Type: string…

Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).

--log.performance

Deprecated in: v3.5.0

Type: boolean

Shortcut for --log.level performance=trace.

This option can be specified without a value to enable it.

--log.prefix

Type: string

Prefix log message with this string.

--log.process

Introduced in: v3.8.0

Type: boolean

Show the process identifier (PID) in log messages.

This option can be specified without a value to enable it.

Default: true

--log.request-parameters

Type: boolean

include full URLs and HTTP request parameters in trace logs

This option can be specified without a value to enable it.

Default: true

--log.role

Type: boolean

Log the server role.

This option can be specified without a value to enable it.

--log.shorten-filenames

Type: boolean

shorten filenames in log output (use with --log.line-number)

This option can be specified without a value to enable it.

Default: true

--log.structured-param

Introduced in: v3.10.0

Type: string…

Toggle the usage of the log category parameter in structured log messages.

--log.thread

Type: boolean

Show the thread identifier in log messages.

This option can be specified without a value to enable it.

--log.thread-name

Type: boolean

Show thread name in log messages.

This option can be specified without a value to enable it.

--log.time-format

Introduced in: v3.5.0

Type: string

The 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-micros”, “utc-datestring-millis”

--log.use-json-format

Introduced in: v3.8.0

Type: boolean

Use JSON as output format for logging.

This option can be specified without a value to enable it.

--log.use-local-time

Deprecated in: v3.5.0

Type: boolean

Use the local timezone instead of UTC.

This option can be specified without a value to enable it.

--log.use-microtime

Deprecated in: v3.5.0

Type: boolean

Use Unix timestamps in seconds with microsecond precision.

This option can be specified without a value to enable it.

random

--random.generator

Type: uint32

The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).

Default: 1

Possible values: 1, 2, 3, 4

server

--server.authentication

Type: boolean

Require authentication credentials when connecting (does not affect the server-side authentication settings).

This option can be specified without a value to enable it.

--server.connection-timeout

Type: double

The connection timeout (in seconds).

Default: 5

--server.database

Type: string

The database name to use when connecting.

Default: _system

--server.endpoint

Type: string…

The endpoint to connect to. Use ’none’ to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://

Default: http+tcp://127.0.0.1:8529

--server.max-packet-size

Type: uint64

The maximum packet size (in bytes) for client/server communication.

Default: 1073741824

--server.password

Type: string

The password to use when connecting. If not specified and authentication is required, the user is prompted for a password

--server.request-timeout

Type: double

The request timeout (in seconds).

Default: 1200

--server.username

Type: string

The username to use when connecting.

Default: root

ssl

--ssl.protocol

Type: uint64

The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))

Default: 5

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

temp

--temp.path

Type: string

The path for temporary files.