Arango extends AQL uses ControllerParamTrait, ModelParamTrait

Central enumeration of ArangoDB-related parameters used throughout aql, controllers, models, and pagination contexts.

$param = Arango::DOC;

Table of Contents

Constants

_DEPTH  : string = '_depth'

_PARENT  : string = '_parent'

ACTIVABLE  : string = 'activable'

The 'activable' parameter.

AFTER_WRITE  : string = 'afterWrite'

The 'afterWrite' parameter — set on the init of the read a controller runs **after** a write, to hand back the document through the projection.

AGGREGATABLE  : string = 'aggregatable'

The 'aggregatable' parameter — the optional whitelist/mapping of aggregatable fields (`urlKey => fieldPath`) consumed by {@see \oihana\arango\models\traits\aql\GroupTrait::$aggregatable}.

AGGREGATABLE_POLICY  : string = 'aggregatablePolicy'

The 'aggregatablePolicy' parameter — what happens to an aggregate whose field is absent from {@see AQL::AGGREGATABLE}. One of the {@see \oihana\arango\models\enums\AggregatablePolicy} codes.

AGGREGATE  : string = 'aggregate'

ALTER  : string = 'alter'

The 'alter' parameter.

ALTERS  : string = 'alters'

ANALYZER  : string = 'analyzer'

ANY_REF  : string = 'anyRef'

ARRAY  : string = 'array'

ARRAYS  : string = 'arrays'

ASSIGN  : string = 'assign'

AUTHORIZER  : string = 'authorizer'

The 'authorizer' parameter.

BIND_COLLECTION  : string = '@collection'

BINDER  : string = 'binder'

The 'binder' parameter — a `callable(mixed $value): string` that registers a value in the query's bind map and returns its `@name` token.

BINDS  : string = 'binds'

BOTH  : string = 'both'

BOUNDS  : string = 'bounds'

CACHEABLE  : string = 'cacheable'

The 'cacheable' parameter.

CHILDREN  : string = 'children'

COLLECT  : string = 'collect'

The 'collect' parameter — holds an AQL `COLLECT` (grouping/aggregation) spec forwarded to {@see aqlCollect()}.

COLLECTION  : string = 'collection'

COMPRESS  : string = 'compress'

The 'compress' parameter.

CONDITIONS  : string = 'conditions'

CONTEXT  : string = 'context'

COUNT  : string = 'count'

COUNTER  : string = 'counter'

The 'counter' parameter.

DATABASE  : string = 'database'

DATE_FIELD  : string = 'dateField'

The 'dateField' parameter.

DEFAULT  : string = 'default'

DEFAULT_LANG  : string = 'defaultLang'

The 'defaultLang' parameter — the fallback language of multilingual expressions.

DIRECTION  : string = 'direction'

DISCRIMINATOR  : string = 'discriminator'

DOC  : string = 'doc'

DOC_JOIN  : string = 'doc_join'

DOC_PREFIX  : string = 'doc_'

DOC_REF  : string = 'docRef'

DOCUMENT  : string = 'document'

DOCUMENTS  : string = 'documents'

The 'documents' parameter.

EDGE  : string = 'edge'

EDGE_COLLECTION  : string = 'edgeCollection'

EDGE_REF  : string = 'edgeRef'

EDGES  : string = 'edges'

ERASE_NULL  : string = 'eraseNull'

The 'eraseNull' flag of an in-place element edit — when truthy, the nulls a patch carries are read as **erasures** instead of values.

EXCLUDES  : string = 'excludes'

EXIST  : string = 'exist'

The 'exist' parameter.

EXPRESSION  : string = 'expression'

EXTRA_QUERY  : string = 'extraQuery'

The 'extraQuery' parameter.

FACET_COUNTS  : string = 'facetCounts'

The 'facetCounts' parameter — the list of facet keys (from `Arango::FACETS`) for which per-value bucket counts are computed alongside the list, by {@see FacetCountsQueryTrait::buildFacetCountsQuery()}.

FACET_COUNTS_LIMIT  : string = 'facetCountsLimit'

The 'facetCountsLimit' parameter — the per-request number of buckets each requested dimension keeps, overriding the `Facet::LIMIT` declared on the facet (which is a **default**, not a ceiling).

FACETS  : string = 'facets'

FACETS_ONLY  : string = 'facetsOnly'

The 'facetsOnly' flag — when truthy (and `Arango::FACET_COUNTS` is requested), the document-fetch query is skipped: the list returns an empty result set while the per-value facet counts (and an exact `total` computed by {@see DocumentsCountTrait::count()}) are still returned. Useful for a faceted-search sidebar that only needs the counts, not the documents.

FALLBACK  : string = 'fallback'

FIELD  : string = 'field'

FIELDS  : string = 'fields'

FILTER  : string = 'filter'

FILTERS  : string = 'filters'

FIRST  : string = 'first'

FOLLOWING  : string = 'following'

FROM  : string = 'from'

GRAPH  : string = 'graph'

GRAPH_DEFAULT  : string = 'vertex, edge, path'

GROUP  : string = 'group'

The 'group' parameter — holds a high-level grouping spec ({@see Group}) translated into an AQL `COLLECT` by {@see GroupTrait::prepareCollect()}.

GROUPABLE  : string = 'groupable'

The 'groupable' parameter — the optional whitelist/mapping of groupable dimensions (`urlKey => fieldPath`) consumed by {@see GroupTrait::$groupable}.

HYDRATION  : string = 'hydration'

ID  : string = 'id'

IN  : string = 'in'

INDEXES  : string = 'indexes'

INIT  : string = 'init'

The 'init' parameter.

INSERT  : string = 'insert'

INTO  : string = 'into'

INVALIDATES  : string = 'invalidates'

Container ids of the {@see \oihana\interfaces\Invalidable} services whose cached state this collection feeds. They are invalidated on every write.

IS_ARRAY  : string = 'isArray'

ITEM  : string = 'item'

ITEM_KEY  : string = 'itemKey'

The 'itemKey' parameter — the attribute carried by each element of an embedded array field, used to target a single element by identity instead of by value.

JOIN  : string = 'join'

JOINS  : string = 'joins'

KEEP  : string = 'keep'

KEEP_NULL  : string = 'keepNull'

The 'keepNull' payload marker. When a payload field definition carries `Arango::KEEP_NULL => true`, an explicit null the client sent for that field survives the compress pass (see PayloadsTrait::preparePayload), so a PATCH can clear a value with `{ "field": null }`.

KEY  : string = 'key'

KEY_LIST  : string = 'keyList'

The 'keyList' parameter.

LAZY  : string = 'lazy'

LEAF  : string = 'leaf'

LENGTH  : string = 'length'

MAP  : string = 'map'

MATCH  : string = 'match'

The 'match' parameter.

MAX_DEPTH  : string = 'maxDepth'

META_ONLY  : string = 'metaOnly'

The 'metaOnly' flag — when truthy, the document-fetch query is skipped: the list returns an empty result set while the response *metadata* (an exact `total` from {@see DocumentsCountTrait::count()}, plus the requested facet counts and numeric bounds) is still computed.

METHOD  : string = 'method'

MIN_DEPTH  : string = 'minDepth'

MOCK  : string = 'mock'

MODE  : string = 'mode'

The 'mode' parameter.

MODEL  : string = 'model'

MODEL_ID  : string = 'modelID'

The 'modelID' parameter.

NAME  : string = 'name'

NEAR  : string = 'near'

The 'near' parameter — a geospatial anchor for distance sorting.

NESTED  : string = 'nested'

NULL  : string = 'null'

NUM  : string = 'num'

The 'num' parameter.

OMIT_WHEN  : string = 'omitWhen'

The 'omitWhen' parameter — the predicates deciding which **attributes of the payload are dropped before a write**, consumed by {@see \oihana\arango\models\traits\aql\PrepareDocumentTrait::prepareDocumentClause()} on `insert`, `update`, `replace` and `upsert`.

OPERATION  : string = 'operation'

The 'operation' parameter — what the controller is about to ask the model, named after the model call rather than after the HTTP verb.

OPERATOR  : string = 'operator'

OPTIONS  : string = 'options'

ORDER  : string = 'order'

PATCH  : string = 'patch'

The 'patch' parameter — the partial object merged into the array element targeted by {@see Arango::ITEM_KEY}, consumed by {@see DocumentsArrayTrait::arrayUpdate()}.

PATH  : string = 'path'

PATH_REF  : string = 'pathRef'

POSITION  : string = 'position'

The 'position' parameter.

POSITION_KEY  : string = 'positionKey'

The 'positionKey' parameter — the attribute of each element of an embedded array field that carries its **rank**, kept in sync with the element order.

PRECEDING  : string = 'preceding'

PREFIX  : string = 'prefix'

PROFILE  : string = 'profile'

The 'profile' parameter — when truthy, `list()` / `get()` run the query in profiled mode (`true` → profile level 2) and the measurements are exposed through {@see ArangoTrait::getProfile()}.

PROJECTION  : string = 'projection'

PROPERTY  : string = 'property'

PRUNE  : string = 'prune'

PURGE  : string = 'purge'

QUERY_ID  : string = 'queryId'

RANGE_VALUE  : string = 'rangeValue'

RAW  : string = 'raw'

RAW_KEYS  : string = 'rawKeys'

RAW_VALUES  : string = 'rawValues'

RELATION  : string = 'relation'

RELATIONS  : string = 'relations'

The 'relations' parameter.

REMOVE_KEYS  : string = 'removeKeys'

The 'removeKeys' parameter.

REPLACE  : string = 'replace'

REQUIRES  : string = 'requires'

RESOLVE  : string = '__resolve__'

RESULT  : string = 'result'

RETURN  : string = 'return'

ROUTE  : string = 'route'

The 'route' parameter.

SCHEMA  : string = 'schema'

SEARCH  : string = 'search'

SEARCH_OPTIONS  : string = 'searchOptions'

SEARCHABLE  : string = 'searchable'

SIDE  : string = 'side'

The 'side' parameter.

SKIN  : string = 'skin'

SKIN_FIELDS  : string = 'skinFields'

SKIP  : string = 'skip'

The 'skip' parameter.

SORT  : string = 'sort'

SORT_DEFAULT  : string = 'sortDefault'

SORT_TIEBREAK  : string = 'sortTiebreak'

SORTABLE  : string = 'sortable'

SOURCE  : string = 'source'

START_VERTEX  : string = 'startVertex'

TARGET  : string = 'target'

TO  : string = 'to'

TOUCH  : string = 'touch'

The 'touch' parameter — whether a write refreshes the housekeeping dates.

TYPE  : string = 'type'

UNIQUE  : string = 'unique'

UPDATE  : string = 'update'

USE_SPACE  : string = 'useSpace'

VALUE  : string = 'value'

VALUES  : string = 'values'

VAR_COLLECTION  : string = '@@collection'

VAR_NAME  : string = 'varName'

The 'varName' parameter.

VARIABLES  : string = 'variables'

The 'variables' parameter.

VERTEX  : string = 'vertex'

VERTEX_REF  : string = 'vertexRef'

VERTICES  : string = 'vertices'

VIEW  : string = 'view'

WHERE  : string = 'where'

WITH  : string = 'with'

WITH_COUNT  : string = 'withCount'

WITH_PATH  : string = 'withPath'

$model->update
([
    Arango::VALUE     => 'k1' ,
    Arango::DOC       => [ 'name' => 'Marc' , 'nickname' => null ] ,
    Arango::OMIT_WHEN => [ fn( $value ) => $value === null || $value === '' ] ,
]) ;

$model->repsert
([
    Arango::FILTER  => $filter ,
    Arango::INSERT  => [ ...$document , 'created' => '2024-05-12' , 'modified' => '2025-11-03' ] ,
    Arango::REPLACE => [ ...$document , 'created' => '2024-05-12' , 'modified' => '2025-11-03' ] ,
    Arango::TOUCH   => false ,
]) ;