我的书签
添加书签
移除书签Arangodump Options
Usage: arangodump [<options>]
Global
| Name | Type | Description |
|---|---|---|
all-databases | boolean | Dump data of all databasesThis option can be specified without value to enable it.Default: falseIntroduced in: v3.5.0 |
batch-size | uint64 | Maximum size for individual data batches (in bytes)Default: 67108864 |
check-configuration | boolean | Check the configuration and exitThis is a command, no value needs to be specified. The process terminates after executing the command.Default: false |
collection | string… | Restrict to collection name (can be specified multiple times)Default: [] |
compress-output | boolean | Compress files containing collection contents using gzip formatThis option can be specified without value to enable it.Default: falseIntroduced in: v3.4.6, v3.5.0 |
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 fileDefault: [] |
dump-data | boolean | Dump collection dataThis option can be specified without value to enable it.Default: true |
dump-dependencies | boolean | Dump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command.Default: false |
dump-options | boolean | Dump configuration options in json formatThis is a command, no value needs to be specified. The process terminates after executing the command.Default: true |
force | boolean | Continue dumping even in the face of some server-side errorsThis option can be specified without value to enable it.Default: false |
ignore-distribute-shards-like-errors | boolean | Continue dump even if sharding prototype collection is not backed up alongThis option can be specified without value to enable it.Default: false |
include-system-collections | boolean | Include system collectionsThis option can be specified without value to enable it.Default: false |
initial-batch-size | uint64 | Initial size for individual data batches (in bytes)Default: 8388608 |
log | string… | The global or topic-specific log levelDefault: ["info"]Deprecated in: v3.5.0 |
maskings | string | File with maskings definitionDefault: ""Introduced in: v3.3.22, v3.4.2 |
output-directory | string | Output directoryDefault: "/work/ArangoDB/dump" |
overwrite | boolean | Overwrite data in output directoryThis option can be specified without value to enable it.Default: false |
progress | boolean | Show progressThis option can be specified without value to enable it.Default: true |
threads | uint32 | Maximum number of collections to process in parallel. from v3.4.0Default: 2 |
tick-end | uint64 | Last tick to be included in data dumpDefault: 0 |
tick-start | uint64 | Only include data after this tickDefault: 0 |
version | boolean | Reports the version and exitsThis is a command, no value needs to be specified. The process terminates after executing the command.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 loggingThis option can be specified without value to enable it.Default: true |
log.escape | boolean | Escape characters when loggingThis option can be specified without value to enable it.Default: true |
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 groupDefault: ""Introduced in: v3.4.5, v3.5.0 |
log.file-mode | string | Mode to use for new log file, umask will be applied as wellDefault: ""Introduced in: v3.4.5, v3.5.0 |
log.force-direct | boolean | Do not start a seperate thread for loggingThis option can be specified without value to enable it.Default: false |
log.foreground-tty | boolean | Also log to tty if backgroundedThis option can be specified without value to enable it.Default: false |
log.ids | boolean | Log unique message idsThis option can be specified without value to enable it.Default: trueIntroduced in: v3.5.0 |
log.keep-logrotate | boolean | Keep the old log file after receiving a sighupThis option can be specified without value to enable it.Default: false |
log.level | string… | The global or topic-specific log levelDefault: ["info"] |
log.line-number | boolean | Append line number and file nameThis 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: falseDeprecated in: v3.5.0 |
log.prefix | string | Prefix log message with this stringDefault: "" |
log.request-parameters | boolean | Include full urls and http request parameters in trace logsThis option can be specified without value to enable it.Default: true |
log.role | boolean | Log server roleThis 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 messageThis option can be specified without value to enable it.Default: false |
log.thread-name | boolean | Show thread name in log messageThis option can be specified without value to enable it.Default: false |
log.time-format | string | Time format to use in logsDefault: "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-local-time | boolean | Use local timezone instead of utcThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0 |
log.use-microtime | boolean | Use microtime insteadThis option can be specified without value to enable it.Default: falseDeprecated 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: 1Possible 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 secondsDefault: 5 |
server.database | string | Database name to use when connectingDefault: "_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 communicationDefault: 1073741824 |
server.password | string | Password to use when connecting. if not specified and authentication is required, the user will be prompted for a passwordDefault: "" |
server.request-timeout | double | Request timeout in secondsDefault: 1200 |
server.username | string | Username to use when connectingDefault: "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)Default: 5Possible values: 1, 2, 3, 4, 5 |
Notes
Encryption Option Details
This feature is only available in theEnterprise Edition
—encryption.keyfile path-of-keyfile
The file path-to-keyfile must contain the encryption key. Thisfile must be secured, so that only arangodump or arangorestore can access it.You should also ensure that in case someone steals your hardware, they will not beable to read the file. For example, by encrypting /mytmpfs orcreating an in-memory file-system under /mytmpfs. The encryption keyfile must contain 32 bytes of data.
—encryption.key-generator path-to-my-generator
This output is used if you want to use the program to generate your encryption key.The program path-to-my-generator must output the encryption on standard outputand exit. The encryption keyfile must contain 32 bytes of data.
