ArangoRestoreAction uses trait:short, trait:short, trait:short, trait:short, trait:short, trait:short, \oihana\commands\traits\EncryptTrait

The command to manage an ArangoDB database.

Table of Contents

Constants

ARANGO_RESTORE  : string = 'arangorestore'

The arango restore command.

ARCHIVE_REGEXP  : string = \oihana\arango\commands\enums\ArchivePattern::R...

The regexp to find the archive file.

PARTIAL_MARKER  : string = 'partial'

Marker appended to the archive name when the dump targets a subset of collections (either `--collection` or `--ignore-collection`).

Properties

$directory  : string|null

The dump/restore directory.

$exit  : string

The exit message.

$dumpConfig  : array<string|int, mixed>

The `[arango.dump]` config defaults (option name => value).

$profiles  : array<string|int, mixed>

The declared named profiles, from the `[arango.profiles]` config section.

$restoreConfig  : array<string|int, mixed>

The `[arango.restore]` config defaults (option name => value).

Methods

arangoRestore()  : int

Run the 'arangorestore' command to restore the ArangoDB database.

getArangoRestoreArguments()  : array<int, string>

Builds the `arangorestore` argument vector (argv[0] = binary name).

initializeArangoOptions()  : static

Captures the `[arango.dump]` / `[arango.restore]` config sections from the init array. Non-array values are ignored, leaving the defaults empty.

initializeArangoProfiles()  : static

Captures the `[arango.profiles]` config section from the init array.

initializeDirectory()  : static

Initializes the dump/restore directory from an init array.

profileConnection()  : array<string|int, mixed>

The optional **source** connection carried by a profile (dump only).

profileDirectory()  : string|null

The optional output **directory** carried by a profile (dump only).

profileExclude()  : array<string|int, mixed>

The `exclude` list of a profile.

profilePositive()  : array<string|int, mixed>

The positive selection of a profile — `collections` + `edges` merged.

profileSelection()  : array<string|int, mixed>

The effective collection list of a profile.

resolveProfile()  : array<string|int, mixed>|null

Resolves the `--profile` value to a profile array.

restore()  : int

Restore the ArangoDB database.

assertCollectionTargeting()  : void

Asserts that `--collection` and `--ignore-collection` are not used together — `arangodump` rejects that combination.

excludeCollections()  : array<int, string>

Returns the available collection names minus the excluded ones, order-preserving (case-sensitive).

getArchiveFileSuffix()  : string

Builds the archive file name suffix used to locate a dump by date.

getArchiveNameSuffix()  : string

Builds the archive name suffix (without file extension) shared by the dump output name and the restore-by-date lookup.

isSystemCollection()  : bool

Returns true when the given name is an ArangoDB system collection (its name starts with an underscore, e.g. `_jobs`, `_apps`).

listDumps()  : int

List the dump files of the database.

missingCollections()  : array<int, string>

Returns the requested collection names that are NOT present in the available set (case-sensitive, as ArangoDB collection names are).

normalizeCollections()  : array<int, string>

Normalizes a raw collection option into a clean, de-duplicated, order-preserving list of collection names.

resolveDumpOptions()  : array<string|int, mixed>

Layers the explicit dump options over the `[arango.dump]` config defaults, then lets the curated CLI flags override everything.

resolveRestoreOptions()  : array<string|int, mixed>

Layers the explicit restore options over the `[arango.restore]` config defaults, then lets the curated CLI flags override everything.

restoreProtectedCollections()  : array<int, string>

The collection names the `restore` action refuses to overwrite unless `--force` is passed, read from the `protected` key of the `[arango.restore]` config section ({@see ArangoCommandParam::PROTECTED}).

sanitizeLabel()  : string|null

Validates and normalizes the optional archive label.

archiveCollections()  : array<int, string>

The collection names declared by the `*.structure.json` files of an untarred dump — the universe used by an exclude-only profile on restore.

isLocalEndpoint()  : bool

True when an ArangoDB endpoint targets the local machine.

looksLikePath()  : bool

True when a `--profile` value designates an external `.toml` file rather than a named section.

normalizeProfileList()  : array<string|int, mixed>

Flattens a profile list value: arrays and comma-separated strings → a clean, de-duplicated list of trimmed names.

restoreSelectionLabel()  : string

A human-readable description of the restore selection, for `--dry-run` (the exact exclude-only list is only known once the archive is untarred).