BUG(JSCBC-756): Previously provided access to the document cas mutate macro.
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.
The path to the field.
The value to add.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
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.
Whether this operation should reference the document body or the extended attributes data for the document.
Creates a MutateInSpec for adding a value to the end of an array in a document.
The path to the field.
The value to add.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
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.
Whether this operation should reference the document body or the extended attributes data for the document.
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.
The path to an element of an array.
The value to add.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
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.
Whether this operation should reference the document body or the extended attributes data for the document.
Creates a MutateInSpec for adding a value to the beginning of an array in a document.
The path to the field.
The value to add.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
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.
Whether this operation should reference the document body or the extended attributes data for the document.
Creates a MutateInSpec for decrementing the value of a field in a document.
The path to the field.
The value to subtract.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
Whether this operation should reference the document body or the extended attributes data for the document.
Creates a MutateInSpec for incrementing the value of a field in a document.
The path to the field.
The value to add.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
Whether this operation should reference the document body or the extended attributes data for the document.
Creates a MutateInSpec for inserting a field into the document. Failing if the field already exists at the specified path.
The path to the field.
The value to insert.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
Whether this operation should reference the document body or the extended attributes data for the document.
Creates a MutateInSpec for remove a field from a document.
The path to the field.
Optional parameters for this operation.
Whether this operation should reference the document body or the extended attributes data for the document.
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.
The path to the field.
The value to write.
Optional parameters for this operation.
Whether this operation should reference the document body or the extended attributes data for the document.
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.
The path to the field.
The value to write.
Optional parameters for this operation.
Whether or not the path to the field should be created if it does not already exist.
Whether this operation should reference the document body or the extended attributes data for the document.
Generated using TypeDoc
Represents a sub-operation to perform within a mutate-in operation.