Click or drag to resize
IMutateInBuilderTDocument Interface
Exposes the creation of a set of mutation operations to be performed.

Namespace:  Couchbase.Core
Assembly:  Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 2.5.7-alpha1
Syntax
public interface IMutateInBuilder<TDocument> : ISubDocBuilder<TDocument>, 
	ITypeSerializerProvider

Type Parameters

TDocument
The strong typed document (POCO) reflecting the structure of the paths.

The IMutateInBuilderTDocument type exposes the following members.

Properties
  NameDescription
Public propertyCas
A "check-and-set" value for ensuring that a document has not been modified by another thread.
Public propertyCount
Returns a count of the currently chained operations.
(Inherited from ISubDocBuilderTDocument.)
Public propertyExpiry
The "time-to-live" or "TTL" that specifies the document's lifetime.
Public propertyKey
Gets or sets the unique identifier for the document.
(Inherited from ISubDocBuilderTDocument.)
Public propertyPersistTo
A durability constraint ensuring that a document has been persisted to the n^th node.
Public propertyReplicateTo
A durability constraint for ensuring that the document has been replicated to the n^th node.
Public propertySerializer
Gets the ITypeSerializer related to the object.
(Inherited from ITypeSerializerProvider.)
Public propertyTimeout
The maximum time allowed for an operation to live before timing out.
(Inherited from ISubDocBuilderTDocument.)
Top
Methods
  NameDescription
Public methodArrayAddUnique(Object, Boolean)
Adds a value to an array if the value does not already exist in the array at the root of the JSON document.
Public methodArrayAddUnique(String, Object, Boolean)
Adds a value to an array if the value does not already exist in the array.
Public methodArrayAddUnique(String, Object, SubdocPathFlags, SubdocDocFlags)
Adds a value to an array if the value does not already exist in the array.
Public methodArrayAppend(Boolean, Object)
Inserts one or more values at the end of an array that is the root of a JSON document.
Public methodArrayAppend(Object, Boolean)
Inserts an array value at the end of an array that is the root of a JSON document.
Public methodArrayAppend(String, Boolean, Object)
Inserts one or more values to the end of an array in a JSON document at a given path.
Public methodArrayAppend(String, Object, Boolean)
Inserts a value to the end of an array in a JSON document at a given path.
Public methodArrayAppend(String, SubdocPathFlags, SubdocDocFlags, Object)
Inserts one or more values to the end of an array in a JSON document at a given path.
Public methodArrayAppend(String, Object, SubdocPathFlags, SubdocDocFlags)
Inserts a value to the end of an array in a JSON document at a given path.
Public methodArrayInsert(String, Object)
Inserts a value at a given position within an array. The position is indicated as part of the path.
Public methodArrayInsert(String, Object)
Inserts one or more values at a given position within an array. The position is indicated as part of the path.
Public methodArrayInsert(String, SubdocPathFlags, SubdocDocFlags, Object)
Inserts one or more values at a given position within an array. The position is indicated as part of the path.
Public methodArrayInsert(String, Object, SubdocPathFlags, SubdocDocFlags)
Inserts a value at a given position within an array. The position is indicated as part of the path.
Public methodArrayPrepend(Boolean, Object)
Inserts one or more values to the beginning of an array that is the root of a JSON document.
Public methodArrayPrepend(Object, Boolean)
Inserts a value to the beginning of an array that is the root of a JSON document.
Public methodArrayPrepend(String, Boolean, Object)
Inserts one or more values to the beginning of an array in a JSON document at a given path.
Public methodArrayPrepend(String, Object, Boolean)
Inserts a value to the beginning of an array in a JSON document at a given path.
Public methodArrayPrepend(String, SubdocPathFlags, SubdocDocFlags, Object)
Inserts one or more values to the beginning of an array in a JSON document at a given path.
Public methodArrayPrepend(String, Object, SubdocPathFlags, SubdocDocFlags)
Inserts a value to the beginning of an array in a JSON document at a given path.
Public methodCounter(String, Int64, Boolean)
Performs an arithmetic increment or decrement operation on a numeric value in a document.
Public methodCounter(String, Int64, SubdocPathFlags, SubdocDocFlags)
Performs an arithmetic increment or decrement operation on a numeric value in a document.
Public methodExecute
Executes the chained operations.
(Inherited from ISubDocBuilderTDocument.)
Public methodExecuteAsync
Executes the chained operations.
(Inherited from ISubDocBuilderTDocument.)
Public methodInsert(String, Object, Boolean)
Inserts an element into a JSON document at a given path.
Public methodInsert(String, Object, SubdocPathFlags, SubdocDocFlags)
Inserts an element into a JSON document at a given path.
Public methodRemove(String)
Removes an element or value from a JSON document at a given path.
Public methodRemove(String, SubdocPathFlags, SubdocDocFlags)
Removes an element or value from a JSON document at a given path.
Public methodReplace(String, Object)
Replaces an element or value within a JSON document at a given path.
Public methodReplace(String, Object, SubdocPathFlags, SubdocDocFlags)
Replaces an element or value within a JSON document at a given path.
Public methodUpsert(String, Object, Boolean)
Inserts or updates an element within or into a JSON document at a given path.
Public methodUpsert(String, Object, SubdocPathFlags, SubdocDocFlags)
Inserts or updates an element within or into a JSON document at a given path.
Public methodWithCas(Int64)
A "check-and-set" value for ensuring that a document has not been modified by another thread.
Public methodWithCas(UInt64)
A "check-and-set" value for ensuring that a document has not been modified by another thread.
Public methodWithDurability(PersistTo)
A durability constraint ensuring that a document has been persisted to the n^th node.
Public methodWithDurability(ReplicateTo)
A durability constraint ensuring that a document has been persisted to the n^th node.
Public methodWithDurability(PersistTo, ReplicateTo)
Sets the ReplicateTo and PersistTo values for a document.
Public methodWithExpiry
Applies an expiration to a document.
Public methodWithTimeout
The maximum time allowed for an operation to live before timing out.
Top
Extension Methods
  NameDescription
Public Extension MethodArrayAddUniqueTDocument, TContent, TElement
Add a unique fragment of type TContent into an array in a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodArrayAppendTDocument, TContent, TElement
Push a fragment of type TContent into the back of an array in a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodArrayInsertTDocument, TElement
Insert a fragment of type TElement into an array in a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodArrayPrependTDocument, TContent, TElement
Push a fragment of type TContent into the front of an array in a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodCounterTDocument, TContent
Increment or decrement a counter of type TContent in a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodInsertTDocument, TContent
Insert a fragment of type TContent into a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodRemoveTDocument, TContent
Remove a fragment of type TContent from a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodReplaceTDocument, TContent
Replace a fragment of type TContent in a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Public Extension MethodUpsertTDocument, TContent
Update or insert a fragment of type TContent into a document of type TDocument, using a given lambda expression path.
(Defined by SubdocExtensions.)
Top
See Also