DiffStatus uses ConstantsTrait
The status of a declaration ↔ server comparison, as reported by {@see \oihana\arango\db\results\DiffReport::$status} — the answer to "is the server object still what the model declares?", for a collection, the indexes of a collection or an ArangoSearch View ({@see DiffKind}).
Produced by the diff primitives (collectionDiff() / indexesDiff() /
viewDiff()); the sync counterparts only act on MISSING and DRIFTED.
Tags
Table of Contents
Constants
- DRIFTED : string = 'drifted'
- The server object diverges from the declaration: a declared field or index is missing, a definition differs, or the server carries something that is no longer declared. The sync counterpart repairs it (`updateProperties()` for a View; indexes are immutable — repairing a drifted index means drop + recreate, only done when forced).
- IN_SYNC : string = 'inSync'
- The server object matches the declaration — nothing to do.
- INVALID : string = 'invalid'
- The comparison is meaningless: the declaration is malformed, a dependency is broken (collection or analyzer not found on the server), or a same-name entity of another type exists. Never created nor synchronized automatically.
- MISSING : string = 'missing'
- The object is declared but does not exist on the server.
- UNREACHABLE : string = 'unreachable'
- The server could not be queried (no database, connection failure) — the report carries the underlying error message.
Constants
DRIFTED
The server object diverges from the declaration: a declared field or index is missing, a definition differs, or the server carries something that is no longer declared. The sync counterpart repairs it (`updateProperties()` for a View; indexes are immutable — repairing a drifted index means drop + recreate, only done when forced).
public
string
DRIFTED
= 'drifted'
IN_SYNC
The server object matches the declaration — nothing to do.
public
string
IN_SYNC
= 'inSync'
INVALID
The comparison is meaningless: the declaration is malformed, a dependency is broken (collection or analyzer not found on the server), or a same-name entity of another type exists. Never created nor synchronized automatically.
public
string
INVALID
= 'invalid'
MISSING
The object is declared but does not exist on the server.
public
string
MISSING
= 'missing'
The sync counterpart creates it from the declaration.
UNREACHABLE
The server could not be queried (no database, connection failure) — the report carries the underlying error message.
public
string
UNREACHABLE
= 'unreachable'