ViewField uses ConstantsTrait

JSON field names exchanged with the ArangoDB view API (`/_api/view`), on both the request side (body of `POST /_api/view`, `PATCH/PUT /_api/view/{name}/properties`) and the response side (`GET /_api/view`, `GET /_api/view/{name}`, `GET /_api/view/{name}/properties`).

Tags

see

https://docs.arangodb.com/stable/develop/http-api/views/arangosearch-views/

author

Marc Alcaraz (ekameleon)

since

1.0.0

Table of Contents

Constants

ANALYZERS  : string = 'analyzers'

Per-link / per-field list of analyzer names applied to the indexed value.

CLEANUP_INTERVAL_STEP  : string = 'cleanupIntervalStep'

Cleanup interval (in commits) between two obsolete-segment cleanup passes (arangosearch property).

COLLECTION  : string = 'collection'

Per-entry source collection name of a `search-alias` view's `indexes` list.

COMMIT_INTERVAL_MSEC  : string = 'commitIntervalMsec'

Commit interval in milliseconds between two index updates (arangosearch property).

CONSOLIDATION_INTERVAL_MSEC  : string = 'consolidationIntervalMsec'

Consolidation interval in milliseconds between two segment merges (arangosearch property).

CONSOLIDATION_POLICY  : string = 'consolidationPolicy'

Consolidation policy object (arangosearch property) — carries `type` plus tier / bytes_accum-specific knobs.

FIELDS  : string = 'fields'

Per-link / per-field nested object describing the indexed sub-fields. Recursive — each value follows the same shape as the parent link.

GLOBALLY_UNIQUE_ID  : string = 'globallyUniqueId'

Server-side globally-unique identifier of the view. Present on every description / properties response.

ID  : string = 'id'

Server-side numeric identifier of the view. Present on every description / properties response.

IN_BACKGROUND  : string = 'inBackground'

Per-link flag: when true, the index is built in the background without blocking concurrent writes.

INCLUDE_ALL_FIELDS  : string = 'includeAllFields'

Per-link / per-field flag: when true, every attribute of the document is indexed regardless of the `fields` whitelist.

INDEX  : string = 'index'

Per-entry inverted-index name of a `search-alias` view's `indexes` list.

INDEXES  : string = 'indexes'

Wrapper field carrying the `{collection, index}` list of a `search-alias` view (the counterpart of {@see self::LINKS} for the arangosearch type).

LINKS  : string = 'links'

Wrapper field carrying the per-collection link map of an arangosearch view.

NAME  : string = 'name'

Top-level view name. Local to the database — views are not db-prefixed server-side (unlike analyzers).

PRIMARY_SORT  : string = 'primarySort'

Primary-sort definition of an arangosearch view (array of `{field, direction}` entries).

PROPERTIES  : string = 'properties'

arangosearch property wrapping every other property under a single key — only used in the `properties()` GET response on some server versions.

RESULT  : string = 'result'

Wrapper field carrying the list of views on `GET /_api/view`.

STORE_VALUES  : string = 'storeValues'

Per-link / per-field `storeValues` strategy — entries of {@see StoreValues}.

STORED_VALUES  : string = 'storedValues'

arangosearch property: array of additional attribute paths kept alongside the index entries to answer covering queries without touching the document.

TRACK_LIST_POSITIONS  : string = 'trackListPositions'

Per-link / per-field flag: when true, the view records the ordinal position of each value in array attributes.

TYPE  : string = 'type'

View type discriminator — entries of {@see ViewType}.

WRITEBUFFER_ACTIVE  : string = 'writebufferActive'

arangosearch property: max number of pending writes the indexer holds in memory before flushing to disk.

WRITEBUFFER_IDLE  : string = 'writebufferIdle'

arangosearch property: max number of idle writers the indexer keeps pooled.

WRITEBUFFER_SIZE_MAX  : string = 'writebufferSizeMax'

arangosearch property: max in-memory size (bytes) of a single writer.