ArangoDumpOptions extends Options uses ArangoCommonOptions

<p>The startup options of the arangodump executable.</p> <p><b>Usage:</b> <code>arangodump [<options>]</code></p>

Tags

see

https://docs.arangodb.com/stable/components/tools/arangodump/options/

Table of Contents

Properties

$allDatabases  : bool|null

Whether to dump all databases.

$batchSize  : int|null

<p>The maximum size for individual data batches (in bytes).</p> <p>Default: 67108864</p>

$checkConfiguration  : bool|null

Check the configuration and exit.

$collection  : string|array<string|int, mixed>|null

Restrict the dump to this collection name (can be specified multiple times). Either --collection or --ignore-collection can be used at the same time

$compressOutput  : bool|null

Compress files containing collection contents using the gzip format.

$compressRequestThreshold  : int|null

The HTTP request body size from which on requests are transparently compressed when sending them to the server.

$compressTransfer  : bool|null

Compress data for transport between arangodump and server.

$config  : string|null

The configuration file or “none”.

$configuration  : string|null

The configuration file or “none”.

$dbserverPrefetchBatches  : int|null

Number of batches to prefetch on each DB-Server.

$dbserverWorkerThreads  : int|null

Number of worker threads on each DB-Server.

$define  : string|array<string|int, mixed>|null

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

$descriptorsMinimum  : int|null

<p>The minimum number of file descriptors needed to start (0 = no minimum)</p> <p>Default: 8192</p>

$docsPerBatch  : int|null

<p>The maximum number of documents to be returned per batch.</p> <p>Default: 10000</p>

$dumpData  : bool|null

<p>Whether to dump collection data.</p> <p>This option can be specified without a value to enable it.</p>

$dumpDependencies  : bool|null

<p>Dump the dependency graph of the feature phases (internal) and exit.</p> <p>This is a command, no value needs to be specified. The process terminates after executing the command.</p>

$dumpOptions  : bool|null

<p>Whether to dump view definitions.</p> <p>This option can be specified without a value to enable it.</p> <p>Default: true</p>

$dumpViews  : bool|null

<p>Dump all available startup options in JSON format and exit.</p> <p>This is a command, no value needs to be specified. The process terminates after executing the command.</p>

$dumpVPack  : bool|null

<p>Dump collection data in velocypack format (more compact than JSON, but requires ArangoDB 3.12 or higher to restore)</p> <p></p>This option can be specified without a value to enable it.<p>

$encryptionKeyfile  : string|null

The path to the file that contains the encryption key.

$encryptionKeyGenerator  : string|null

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

$force  : bool|null

<p>Continue dumping even in the face of some server-side errors.</p> <p>This option can be specified without a value to enable it.</p>

$honorNsswitch  : bool|null

<p>Allow hostname lookup configuration via /etc/nsswitch.conf if on Linux/glibc.</p> <p>This option can be specified without a value to enable it.</p>

$ignoreDistributeShardsLikeErrors  : bool|null

Continue dumping even if a sharding prototype collection is not backed up, too.

$includeSystemCollections  : bool|null

Include system collections.

$initialBatchSize  : int|null

<p>The initial size for individual data batches (in bytes).</p> Default: 8388608

$localNetworkThreads  : int|null

<p>Number of local network threads, i.e. how many requests are sent in parallel.</p> Default: 5

$localWriterThreads  : int|null

<p>Number of local writer threads.</p> Default: 5

$log  : string|array<string|int, mixed>|null

<p>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).</p> <p>Available log levels: fatal, error, warning, info, debug, trace.</p> <p>Default: info</p>

$logColor  : bool|null

Use colors for TTY logging.

$logEscapeControlChars  : bool|null

Escape control characters in log messages.

$logEscapeUnicodeChars  : bool|null

Escape Unicode characters in log messages.

$logFile  : string|null

Shortcut for --log.output file://<filename>

$logFileGroup  : string|null

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

$logFileMode  : string|null

The mode to use for a new log file. The umask is applied as well.

$logForceDirect  : bool|null

Do not start a separate thread for logging.

$logForegroundTty  : bool|null

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

$logHostname  : string|null

The hostname to use in log message.

$logIds  : bool|null

Log unique message IDs.

$logLevel  : string|array<string|int, mixed>|null

<p>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).</p>

$logLineNumber  : bool|null

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.

$logMaxEntryLength  : int|null

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

$logMaxQueuedEntries  : int|null

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

$logOutput  : string|array<string|int, mixed>|null

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

$logPerformance  : bool|null

Shortcut for --log.level performance=trace.

$logPrefix  : string|null

Prefix log message with this string.

$logProcess  : bool|null

Show the process identifier (PID) in log messages.

$logRequestParameters  : bool|null

include full URLs and HTTP request parameters in trace logs This option can be specified without a value to enable it.

$logRole  : bool|null

Log the server role.

$logShortenFilenames  : bool|null

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

$logStructuredParam  : string|array<string|int, mixed>|null

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

$logThread  : bool|null

Show the thread identifier in log messages.

$logThreadName  : bool|null

Show thread name in log messages.

$logTimeFormat  : string|null

The time format to use in logs.

$logUseJsonFormat  : bool|null

Use JSON as output format for logging.

$logUseLocalTime  : bool|null

Use the local timezone instead of UTC.

$logUseMicrotime  : bool|null

Use Unix timestamps in seconds with microsecond precision.

$maskings  : string|null

A path to a file with masking definitions.

$outputDirectory  : string|null

<p>The folder path to write the dump to.</p> <p>Default: /dump</p>

$overwrite  : bool|null

<p>Overwrite data in the output directory.</p> <p>This option can be specified without a value to enable it.</p>

$parallelDump  : bool|null

<p>Enable highly parallel dump behavior.</p> <p>This option can be specified without a value to enable it.</p> <p>Default: true</p>

$progress  : bool|null

<p>Show the dump progress.</p> <p>This option can be specified without a value to enable it.</p>

$randomGenerator  : int|null

<p>The random number generator to use :</p> <ul> <li>1 = MERSENNE</li> <li>2 = RANDOM</li> <li>3 = URANDOM</li> <li>4 = COMBINED</li> </ul> <p>The options 2, 3, and 4 are deprecated and will be removed in a future version.</p> <p>Default: 1</p> <p></p>Possible values: 1, 2, 3, 4</p>

$serverAskJwtSecret  : bool|null

If enabled, you are prompted for a JWT secret.

$serverAuthentication  : bool|null

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

$serverConnectionTimeout  : float|null

The connection timeout (in seconds).

$serverDatabase  : string|null

The database name to use when connecting.

$serverEndpoint  : string|array<string|int, mixed>|null

The endpoint to connect to. Use ’none’ to start without a server.

$serverJwtSecretKeyfile  : string|null

If enabled, the JWT secret is loaded from the given file.

$serverMaxPacketSize  : int|null

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

$serverPassword  : string|null

The password to use when connecting.

$serverRequestTimeout  : float|null

The request timeout (in seconds).

$serverUsername  : string|null

The username to use when connecting.

$shard  : string|array<string|int, mixed>|null

Restrict the dump to this shard (can be specified multiple times).

$splitFiles  : bool|null

<p>Split a collection in multiple files to increase throughput.</p> <p>This option can be specified without a value to enable it.</p>

$sslProtocol  : int|null

<p></p>The SSL protocol :</p> <ul> <li>1 = SSLv2 (unsupported),</li> <li>2 = SSLv2 or SSLv3 (negotiated)</li> <li>3 = SSLv3</li> <li>4 = TLSv1</li> <li>5 = TLSv1.2</li> <li>6 = TLSv1.3</li> <li>9 = generic TLS (negotiated))</li> </ul> <p>Default: 5</p> <p></p>Possible values: 1, 2, 3, 4, 5, 6, 9</p>

$threads  : int|null

<p>The maximum number of collections/shards to process in parallel.</p> <p>Default: dynamic (e.g. 8)</p>

$useSpliceSyscall  : bool|null

<p>Use the splice() syscall for file copying (may not be supported on all filesystems).</p> <p>This option can be specified without a value to enable it.</p> <p>Default: true</p>

$version  : bool|null

<p>Print the version and other related information, then exit.</p> <p>This is a command, no value needs to be specified.

$versionJson  : bool|null

<p>Print the version and other related information in JSON format, then exit.</p> <p>This is a command, no value needs to be specified. The process terminates after executing the command.</p>

Methods

__toString()  : string

Returns the string expression of the object.