Class MutateInSpec

Represents a sub-operation to perform within a mutate-in operation.

Index

Accessors

CasPlaceholder

Methods

arrayAddUnique arrayAppend arrayInsert arrayPrepend decrement increment insert remove replace upsert

Accessors

`Static`CasPlaceholder

get CasPlaceholder(): MutateInMacro
BUG(JSCBC-756): Previously provided access to the document cas mutate macro.

Returns MutateInMacro
Deprecated
Use MutateInMacro.Cas instead.
- Defined in lib/sdspecs.ts:246

Methods

`Static`arrayAddUnique

arrayAddUnique(
    path: string,
    value: any,
    options?: { createPath?: boolean; multi?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for adding unique values to an array in a document. This operation will only add values if they do not already exist elsewhere in the array.
Parameters
- path: string
  The path to the field.
- value: any
  The value to add.
- Optionaloptions: { createPath?: boolean; multi?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalmulti?: boolean
    If set, this enables an array of values to be passed as value, and each element of the passed array is added to the array.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:551

`Static`arrayAppend

arrayAppend(
    path: string,
    value: any,
    options?: { createPath?: boolean; multi?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for adding a value to the end of an array in a document.
Parameters
- path: string
  The path to the field.
- value: any
  The value to add.
- Optionaloptions: { createPath?: boolean; multi?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalmulti?: boolean
    If set, this enables an array of values to be passed as value, and each element of the passed array is added to the array.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:461

`Static`arrayInsert

arrayInsert(
    path: string,
    value: any,
    options?: { createPath?: boolean; multi?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for adding a value to a specified location in an array in a document. The path should specify a specific index in the array and the new values are inserted at this location.
Parameters
- path: string
  The path to an element of an array.
- value: any
  The value to add.
- Optionaloptions: { createPath?: boolean; multi?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalmulti?: boolean
    If set, this enables an array of values to be passed as value, and each element of the passed array is added to the array.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:521

`Static`arrayPrepend

arrayPrepend(
    path: string,
    value: any,
    options?: { createPath?: boolean; multi?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for adding a value to the beginning of an array in a document.
Parameters
- path: string
  The path to the field.
- value: any
  The value to add.
- Optionaloptions: { createPath?: boolean; multi?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalmulti?: boolean
    If set, this enables an array of values to be passed as value, and each element of the passed array is added to the array.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:490

`Static`decrement

decrement(
    path: string,
    value: any,
    options?: { createPath?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for decrementing the value of a field in a document.
Parameters
- path: string
  The path to the field.
- value: any
  The value to subtract.
- Optionaloptions: { createPath?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:603

`Static`increment

increment(
    path: string,
    value: any,
    options?: { createPath?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for incrementing the value of a field in a document.
Parameters
- path: string
  The path to the field.
- value: any
  The value to add.
- Optionaloptions: { createPath?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:577

`Static`insert

insert(
    path: string,
    value: any,
    options?: { createPath?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for inserting a field into the document. Failing if the field already exists at the specified path.
Parameters
- path: string
  The path to the field.
- value: any
  The value to insert.
- Optionaloptions: { createPath?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:347

`Static`remove

remove(path: string, options?: { xattr?: boolean }): MutateInSpec
Creates a MutateInSpec for remove a field from a document.
Parameters
- path: string
  The path to the field.
- Optionaloptions: { xattr?: boolean }
  Optional parameters for this operation.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:428

`Static`replace

replace(path: string, value: any, options?: { xattr?: boolean }): MutateInSpec
Creates a MutateInSpec for replacing a field on a document. This updates the value of the specified field, failing if the field does not exits.
Parameters
- path: string
  The path to the field.
- value: any
  The value to write.
- Optionaloptions: { xattr?: boolean }
  Optional parameters for this operation.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:406

`Static`upsert

upsert(
    path: string,
    value: any,
    options?: { createPath?: boolean; xattr?: boolean },
): MutateInSpec
Creates a MutateInSpec for upserting a field on a document. This updates the value of the specified field, or creates the field if it does not exits.
Parameters
- path: string
  The path to the field.
- value: any
  The value to write.
- Optionaloptions: { createPath?: boolean; xattr?: boolean }
  Optional parameters for this operation.
  - OptionalcreatePath?: boolean
    Whether or not the path to the field should be created if it does not already exist.
  - Optionalxattr?: boolean
    Whether this operation should reference the document body or the extended attributes data for the document.
Returns MutateInSpec
- Defined in lib/sdspecs.ts:374

Class MutateInSpec

Index

Accessors

Methods

Accessors

StaticCasPlaceholder

Returns MutateInMacro

Deprecated

Methods

StaticarrayAddUnique

Parameters

OptionalcreatePath?: boolean

Optionalmulti?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

StaticarrayAppend

Parameters

OptionalcreatePath?: boolean

Optionalmulti?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

StaticarrayInsert

Parameters

OptionalcreatePath?: boolean

Optionalmulti?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

StaticarrayPrepend

Parameters

OptionalcreatePath?: boolean

Optionalmulti?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

Staticdecrement

Parameters

OptionalcreatePath?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

Staticincrement

Parameters

OptionalcreatePath?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

Staticinsert

Parameters

OptionalcreatePath?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

Staticremove

Parameters

Optionalxattr?: boolean

Returns MutateInSpec

Staticreplace

Parameters

Optionalxattr?: boolean

Returns MutateInSpec

Staticupsert

Parameters

OptionalcreatePath?: boolean

Optionalxattr?: boolean

Returns MutateInSpec

Settings

On This Page

`Static`CasPlaceholder

`Static`arrayAddUnique

`Optional`createPath?: boolean

`Optional`multi?: boolean

`Optional`xattr?: boolean

`Static`arrayAppend

`Optional`createPath?: boolean

`Optional`multi?: boolean

`Optional`xattr?: boolean

`Static`arrayInsert

`Optional`createPath?: boolean

`Optional`multi?: boolean

`Optional`xattr?: boolean

`Static`arrayPrepend

`Optional`createPath?: boolean

`Optional`multi?: boolean

`Optional`xattr?: boolean

`Static`decrement

`Optional`createPath?: boolean

`Optional`xattr?: boolean

`Static`increment

`Optional`createPath?: boolean

`Optional`xattr?: boolean

`Static`insert

`Optional`createPath?: boolean

`Optional`xattr?: boolean

`Static`remove

`Optional`xattr?: boolean

`Static`replace

`Optional`xattr?: boolean

`Static`upsert

`Optional`createPath?: boolean

`Optional`xattr?: boolean