ArangoCommandParam uses ConstantsTrait

The command to manage an ArangoDB database.

Table of Contents

Constants

ANALYZERS  : string = 'analyzers'

The 'analyzers' parameter — the database-level registry of declared **custom** analyzers reconciled by the `arango:analyzers` action (and signalled by the `doctor`): a list of {@see \oihana\arango\db\options\analyzers\AnalyzerDefinition} (a single one is tolerated in place of a one-element list). Analyzers are shared and database-scoped, so they are declared once here rather than per model.

COLLECTION_INDEXES  : string = 'collectionIndexes'

The 'collectionIndexes' parameter — the collection→indexes registry reconciled by the `doctor` action, declared independently of the models: a map `collectionName => IndexOptions[]` (a single `IndexOptions` is tolerated in place of a one-element list). Lets a collection's indexes be declared once, in one place, even when several models back it (or none declares `AQL::INDEXES`).

DATE_FORMAT  : string = 'dateFormat'

The 'dateFormat' parameter.

DIRECTORY  : string = 'directory'

The 'directory' parameter.

DUMP  : string = 'dump'

The 'dump' parameter — the `[arango.dump]` config section (option defaults applied to the `dump` action, overridable on the CLI).

MASKING  : string = 'masking'

The 'masking' key — the convenient masking table of a profile (`[arango.profiles.<name>.masking]`) or of the dump defaults (`[arango.dump.masking]`), compiled to a native `arangodump` maskings file. Dump-only.

MIGRATIONS_COLLECTION  : string = 'migrationsCollection'

The 'migrationsCollection' parameter — the tracking collection name of the `migrate` action (default `migrations`).

MIGRATIONS_NAMESPACE  : string = 'migrationsNamespace'

The 'migrationsNamespace' parameter — the PHP namespace the version classes of the `migrate` action are declared in.

MIGRATIONS_PATH  : string = 'migrationsPath'

The 'migrationsPath' parameter — the directory holding the `Version*.php` files of the `migrate` action.

MODELS  : string = 'models'

The 'models' parameter — the container ids of the `Documents` models whose View declarations the `views` action inspects.

PROFILE_COLLECTIONS  : string = 'collections'

The 'collections' key of a profile — the positive document-collection selection.

PROFILE_EDGES  : string = 'edges'

The 'edges' key of a profile — the positive edge-collection selection (merged with the collections into a single list).

PROFILE_EXCLUDE  : string = 'exclude'

The 'exclude' key of a profile — names removed from the resolved selection.

PROFILES  : string = 'profiles'

The 'profiles' parameter — the `[arango.profiles]` config section (named dump/restore selection profiles, keyed by name).

PROTECTED  : string = 'protected'

The 'protected' key of the `[arango.restore]` config section — the list of collection names the `restore` action refuses to overwrite unless `--force` is passed (a deployment-level safety policy, never an option of the `arangorestore` binary).

RESTORE  : string = 'restore'

The 'restore' parameter — the `[arango.restore]` config section (option defaults applied to the `restore` action, overridable on the CLI).

RETENTION  : string = 'retention'

The 'retention' key of the `[arango.dump]` config section — the archive rotation policy ({@see RetentionOption}: `keep` / `max_age` / `max_total` / `auto` / `buckets`) of the `dump` action.

SEARCH_ALIAS_VIEWS  : string = 'searchAliasViews'

The 'searchAliasViews' init key — the database-level registry of declared `search-alias` views ({@see \oihana\arango\db\options\views\SearchAliasView}), consumed by the `views` action.

TIMEZONE  : string = 'timezone'

The 'timezone' parameter.