Class: MutateInBuilder

MutateInBuilder

Builder used to create a set of sub-document mutation operations.


<private> new MutateInBuilder()

Since:
  • 2.1.4 (stability: committed)

Members


addUnique

Deprecated:
  • Alias for arrayAddUnique

pushBack

Deprecated:
  • Alias for arrayAppend

pushFront

Deprecated:
  • Alias for arrayPrepend

Methods


arrayAddUnique(path, value [, options])

Adds an array add unique operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
value Object
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.2.1 (stability: committed)
Returns:
Type
MutateInBuilder

arrayAppend(path, value [, options])

Adds an array push back operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
value Object
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.2.1 (stability: committed)
Returns:
Type
MutateInBuilder

arrayAppendAll(path, values [, options])

Adds an array push all back operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
values Array.<Object>
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.4.4 (stability: committed)
Returns:
Type
MutateInBuilder

arrayInsert(path, value [, options])

Adds an array insert operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
value Object
options Object <optional>
Properties
Name Type Argument Description
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.1.4 (stability: committed)
Returns:
Type
MutateInBuilder

arrayInsertAll(path, values [, options])

Adds an array insert all operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
values Array.<Object>
options Object <optional>
Properties
Name Type Argument Description
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.4.4 (stability: committed)
Returns:
Type
MutateInBuilder

arrayPrepend(path, value [, options])

Adds an array push front operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
value Object
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.1.4 (stability: committed)
Returns:
Type
MutateInBuilder

arrayPrependAll(path, values [, options])

Adds an array push all front operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
values Array.<Object>
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.4.4 (stability: committed)
Returns:
Type
MutateInBuilder

counter(path, delta [, options])

Adds a count operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
delta number
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.1.4 (stability: committed)
Returns:
Type
MutateInBuilder

execute(callback)

Executes this set of mutation operations on the bucket.

Parameters:
Name Type Description
callback
Since:
  • 2.1.4 (stability: committed)

insert(path, value [, options])

Adds an insert operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
value Object
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.1.4 (stability: committed)
Returns:
Type
MutateInBuilder

remove(path [, options])

Adds an remove operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
options Object <optional>
Properties
Name Type Argument Description
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.1.4 (stability: committed)
Returns:
Type
MutateInBuilder

replace(path, value [, options])

Adds an replace operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
value Object
options Object <optional>
Properties
Name Type Argument Description
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.1.4 (stability: committed)
Returns:
Type
MutateInBuilder

upsert(path, value [, options])

Adds an upsert operation to this mutation operation set.

Parameters:
Name Type Argument Description
path string
value Object
options Object <optional>
Properties
Name Type Argument Description
createParents boolean <optional>
xattr boolean <optional>
xattrMacro boolean <optional>
Since:
  • 2.1.4 (stability: committed)
Returns:
Type
MutateInBuilder