TraversalOptions 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

$defaultWeight  : int|null

Specifies the default weight of an edge (number). The default value is 1.

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

Restrict edge collections the traversal may visit (string|array).

$indexHint  : object|null

You can provide index hints for traversals to let the optimizer prefer the vertex-centric indexes you specify over the regular edge index.

$maxProjections  : int|null

Specifies the number of document attributes per FOR loop to be used as projections (number).

$order  : string|null

Specify which traversal algorithm to use (string): - "bfs" – the traversal is executed breadth-first.

$parallelism  : int|null

Parallelize traversal execution (number).

$uniqueEdges  : string|null

Ensure edge uniqueness (string):

$uniqueVertices  : string|null

Ensure node uniqueness (string):

$useCache  : bool|null

Whether to use the in-memory cache for edges. The default is true.

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

Restrict node collections the traversal may visit (string|array).

$weightAttribute  : string|null

Specifies the name of an attribute that is used to look up the weight of an edge (string).

Methods

__construct()  : mixed

Creates a new QueryOptions instance.

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

Invoked to serialize the object with the json serializer.