SearchOptions extends QueryOptions

The options of the AQL `SEARCH` operation (`SEARCH expression OPTIONS { … }`), hydrated by {@see \oihana\arango\db\operations\aqlSearch()} from the `AQL::SEARCH_OPTIONS` key. Null properties are omitted from the emitted `OPTIONS` object, so the server applies its own defaults.

Tags

see

https://docs.arangodb.com/stable/aql/high-level-operations/search/#search-options

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

$collections  : array<string|int, mixed>|null

Restrict the search to the given source collections of the View — an array of collection names. Documents from the View's other linked collections are ignored. The search expression itself is unrestricted (`true` matches every document of the selected collections).

$conditionOptimization  : string|null

How the search criteria get optimized — one of the {@see \oihana\arango\db\enums\ConditionOptimization} constants: `'auto'` (server default: convert to disjunctive normal form and remove redundant or overlapping conditions) or `'none'` (search the index without optimizing the conditions).

$countApproximate  : string|null

How the total row count is calculated when the `fullCount` query option is enabled or a `COLLECT WITH COUNT` clause is executed — one of the {@see \oihana\arango\db\enums\CountApproximate} constants: `'exact'` (server default: enumerate the rows) or `'cost'` (O(1) cost-based approximation, precise for an empty or single-term search condition).

$parallelism  : int|null

Number of worker threads that may process the View's index segments in parallel. `1` disables parallelization; greater values are a hint, capped by the server's `--arangosearch.execution-threads-limit`. Omit to use the server's `--arangosearch.default-parallelism`.

Methods

__construct()  : mixed

Creates a new QueryOptions instance.

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

Invoked to serialize the object with the json serializer.