UpsertOptions 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

$exclusive  : bool

The RocksDB engine does not require collection-level locks. Different write operations on the same collection do not block each other, as long as there are no write-write conflicts on the same documents.

$forceIndexHint  : bool

Makes the index or indexes specified in indexHint mandatory if enabled. The default is false.

$ignoreErrors  : bool

Suppress query errors that may occur when trying to update non-existing documents or when violating unique key constraints.

$ignoreRevs  : bool

In order to not accidentally overwrite documents that have been modified since you last fetched them, you can use the option ignoreRevs to either let ArangoDB compare the _rev value and only succeed if they still match, or let ArangoDB ignore them (default).

$indexHint  : string|null

The indexHint option is used as a hint for the document lookup performed as part of the UPSERT operation, and can help in cases such as UPSERT not picking the best index automatically.

$keepNull  : bool

When updating an attribute to the null value, ArangoDB does not remove the attribute from the document but stores this null value.

$mergeObjects  : bool

The option mergeObjects controls whether object contents are merged if an object attribute is present in both the UPDATE query and in the to-be-updated document.

$readOwnWrites  : bool

The readOwnWrites option allows an UPSERT operation to process its inputs one by one.

$waitForSync  : bool

To make sure data are durable when an update query returns.

Methods

__construct()  : mixed

Creates a new QueryOptions instance.

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

Invoked to serialize the object with the json serializer.