ForOptions extends QueryOptions

Table of Contents

Constants

CACHE_ENABLED  : string = 'cacheEnabled'

DEDUPLICATE  : string = 'deduplicate'

DISABLE_INDEX  : string = 'disableIndex'

ESTIMATES  : string = 'estimates'

EXCLUSIVE  : string = 'exclusive'

EXPIRE_AFTER  : string = 'expireAfter'

FIELD_VALUE_TYPES  : string = 'fieldValueTypes'

FIELDS  : string = 'fields'

FORCE_INDEX_HINT  : string = 'forceIndexHint'

GEO_JSON  : string = 'geoJson'

IGNORE_ERRORS  : string = 'ignoreErrors'

IGNORE_REVS  : string = 'ignoreRevs'

IN_BACKGROUND  : string = 'inBackground'

INDEX_HINT  : string = 'indexHint'

KEEP_NULL  : string = 'keepNull'

LEGACY_POLYGONS  : string = 'legacyPolygons'

LOOKAHEAD  : string = 'lookahead'

MAX_PROJECTIONS  : string = 'maxProjections'

MERGE_OBJECTS  : string = 'mergeObjects'

METHOD  : string = 'method'

NAME  : string = 'name'

OVERWRITE_MODE  : string = 'overwriteMode'

PARALLELISM  : string = 'parallelism'

PARAMS  : string = 'params'

PREFIX_FIELDS  : string = 'prefixFields'

READ_OWN_WRITES  : string = 'readOwnWrites'

REFILL_INDEX_CACHES  : string = 'refillIndexCaches'

SPARSE  : string = 'sparse'

STORED_VALUE  : string = 'storedValue'

TYPE  : string = 'type'

UNIQUE  : string = 'unique'

USE_CACHE  : string = 'useCache'

WAIT_FOR_SYNC  : string = 'waitForSync'

Properties

$disableIndex  : bool

In some rare cases it can be beneficial to not do an index lookup or scan, but to do a full collection scan.

$forceIndexHint  : bool

Index hints are not enforced by default. If forceIndexHint is set to true, then an error is generated if indexHint does not contain a usable index, instead of using a fallback index or not using an index at all.

$indexHint  : string|null

For collections, index hints can be given to the optimizer with the indexHint option. The value can be a single index name or a list of index names in order of preference: <code> FOR … IN … OPTIONS { indexHint: "byName" } </code> <code> FOR … IN … OPTIONS { indexHint: ["byName", "byColor"] } </code> Whenever there is a chance to potentially use an index for this FOR loop, the optimizer will first check if the specified index can be used.

$lookahead  : int|null

The multi-dimensional index types mdi and mdi-prefixed support an optional index hint for tweaking performance: <code> FOR … IN … OPTIONS { lookahead: 32 } </code>

$maxProjections  : int|null

By default, the query optimizer will consider up to 5 document attributes per FOR loop to be used as projections.

$useCache  : bool

You can disable in-memory caches that you may have enabled for persistent indexes on a case-by-case basis.

Methods

__construct()  : mixed

Creates a new QueryOptions instance.

jsonSerialize()  : array<string|int, mixed>

Invoked to serialize the object with the json serializer.