arangoimport Options
Usage: arangoimport [<options>]
General
Name | Type | Description |
---|---|---|
auto-rate-limit |
boolean | Adjust the data loading rate automatically, starting at --batch-size bytes per thread per second This option can be specified without value to enable it. Default: false Introduced in: v3.7.11 |
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: 8388608 |
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 |
datatype |
string… | Force a specific datatype for an attribute (null/boolean/number/string). Use as “attribute=type”. For CSV and TSV only. Takes precendence over --convert Default: [] Introduced in: v3.9.0 |
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: "" |
headers-file |
string | Filename to read CSV or TSV headers from. if specified will not try to read headers from regular input file Default: "" Introduced in: v3.8.0 |
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"] Deprecated in: v3.5.0 |
merge-attributes |
string… | Merge attributes into new document attribute (e.g. mergedAttribute=[someAttribute]-[otherAttribute]) (CSV and TSV only) Default: [] Introduced in: v3.9.1 |
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 exists (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 documents into collection (for CSV and TSV only) Default: [] |
separator |
string | Field separator, used for csv and tsv. Defaults to a comma (csv) or a tabulation character (tsv) Default: dynamic (e.g. "" ) |
skip-lines |
uint64 | Number of lines to skip for formats (csv and tsv only) Default: 0 |
skip-validation |
boolean | Skips document validation during import This option can be specified without value to enable it. Default: false Introduced in: v3.7.0 |
threads |
uint32 | Number of parallel import threads Default: dynamic (e.g. 36 ) |
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. |
version-json |
boolean | Reports the version as JSON and exits This is a command, no value needs to be specified. The process terminates after executing the command. Introduced in: v3.9.0 |
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-control-chars |
boolean | Escape control characters when logging This option can be specified without value to enable it. Default: true Introduced in: v3.9.0 |
log.escape-unicode-chars |
boolean | Escape unicode characters when logging This option can be specified without value to enable it. Default: false Introduced in: v3.9.0 |
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.structured-param |
string… | Toggle usage of log category parameter in structured log messages Default: [] Introduced in: v3.10.0 |
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:// 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 |
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: "" |