ArangoDoctorAction uses trait:short, trait:short, trait:short, trait:short, trait:short, \oihana\commands\traits\IOTrait

The structure health check of the ArangoDB database — the global counterpart of the `views` action.

Tags

author

Marc Alcaraz (ekameleon)

since

1.2.0

Table of Contents

Properties

$analyzers  : array<int, AnalyzerDefinition>|AnalyzerDefinition

The declared custom analyzers — a list of {@see AnalyzerDefinition} (a single one is tolerated in place of a one-element list).

$collectionIndexes  : array<string, IndexDefinition|IndexOptions|array<int, mixed>>

The collection→indexes registry — `[ collectionName => IndexOptions[] ]` (a single {@see IndexDefinition} / {@see IndexOptions} value object is tolerated in place of a one-element list).

$migrationsCollection  : string

The tracking collection name (one per database).

$migrationsNamespace  : string

The PHP namespace the version classes are declared in (e.g. `fr\bouney\migrations`).

$migrationsPath  : string|null

The directory holding the `Version*.php` migration files.

$models  : array<int, string>

Container ids of the `Documents` models to inspect.

Methods

getAnalyzerDefinitions()  : array<int, AnalyzerDefinition>

Returns the declared analyzers normalized to a flat {@see AnalyzerDefinition} list: a lone `AnalyzerDefinition` becomes a one-element list, and any entry that is not an `AnalyzerDefinition` is dropped (defensive against a malformed declaration).

agent()  : string

The acting agent (`user@host`) stamped on the tracking documents — shared by the `migrate` runs and the `doctor --apply` journal.

buildDatabase()  : Database|null

Builds a best-effort {@see Database} HTTP client from the resolved connection settings, or null when no usable endpoint/database is available or the client cannot be constructed.

doctor()  : int

Diagnoses (or repairs) the declared structure of the database.

gitCommit()  : string|null

The current git commit hash, or null outside a git repository — the history link stamped on every tracking document.

resolveDatabase()  : Database|null

Builds the best-effort {@see Database} HTTP client of an action run: every connection setting reads its CLI option first (`--database` / `--endpoint` / `--user` / `--password`) and falls back on the command configuration ({@see ArangoConfigTrait}).

resolveFacade()  : ArangoDB|null

Builds the best-effort high-level {@see ArangoDB} façade of an action run, from the same resolved connection settings as {@see resolveDatabase()} — the migration engine hands this façade to every {@see \oihana\arango\migrations\Migration}. Null when no usable endpoint is configured or the façade cannot be constructed.

doctorAccount()  : void

Accounts one diff report into the running doctor state: renders it, bumps the status counter, flips the health flag when the report is not in sync (and was not freshly applied), and collects it when applied. Shared by the model walk and the collection-index registry walk.

doctorJournal()  : void

Journals each applied object as a `CreateAction` in the tracking collection — the audit trail of `doctor --apply`, told apart from the versioned migrations by its `additionalType` ({@see MigrationKind::DOCTOR}).

doctorOrphans()  : array<int, string>

Computes and prints the orphans — collections (non-system) and views on the server that no configured model declares. Report only.

doctorPrune()  : void

Offers the interactive multi-selection of the orphans to remove and drops the chosen ones. Nothing happens in non-interactive mode.

doctorRenderReport()  : void

Prints one {@see DiffReport} as a status line (labelled with its {@see DiffKind}) plus one indented line per change.