ArangoMigrationsTrait
The migration settings of the `migrate` action of `command:arangodb`, supplied via the command init keys ({@see \oihana\arango\commands\enums\ArangoCommandParam}): where the version files live, the namespace they are declared in, and the tracking collection name.
Tags
Table of Contents
Properties
- $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.
Methods
- agent() : string
- The acting agent (`user@host`) stamped on the tracking documents — shared by the `migrate` runs and the `doctor --apply` journal.
- gitCommit() : string|null
- The current git commit hash, or null outside a git repository — the history link stamped on every tracking document.
Properties
$migrationsCollection
The tracking collection name (one per database).
public
string
$migrationsCollection
= 'migrations'
$migrationsNamespace
The PHP namespace the version classes are declared in (e.g. `fr\bouney\migrations`).
public
string
$migrationsNamespace
= ''
$migrationsPath
The directory holding the `Version*.php` migration files.
public
string|null
$migrationsPath
= null
Methods
agent()
The acting agent (`user@host`) stamped on the tracking documents — shared by the `migrate` runs and the `doctor --apply` journal.
protected
agent() : string
Return values
stringgitCommit()
The current git commit hash, or null outside a git repository — the history link stamped on every tracking document.
protected
gitCommit() : string|null