Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class MutationState

Represents a composition of MutationToken's into a single unit for performing "read your own writes" or RYOW semantics on a N1QL query.

Inheritance
object
MutationState
Implements
IEnumerable<MutationToken>
IEnumerable
Inherited Members
object.GetType()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Couchbase.Query
Assembly: Couchbase.NetClient.dll
Syntax
public sealed class MutationState : IEnumerable<MutationToken>, IEnumerable

Constructors

View Source

MutationState()

Declaration
public MutationState()

Methods

View Source

Add(params IMutationResult[])

Adds a MutationToken to the MutationState from a list of IMutationResult assuming enhanced durability is enabled.

Declaration
public MutationState Add(params IMutationResult[] mutationResults)
Parameters
Type Name Description
IMutationResult[] mutationResults

The mutationResults.

Returns
Type Description
MutationState

The MutationState object itself.

Exceptions
Type Condition
ArgumentException

If a IMutationResult does not contain a valid MutationToken.

View Source

Add(MutationState)

Adds the MutationToken's from another MutationState.

Declaration
public MutationState Add(MutationState mutationState)
Parameters
Type Name Description
MutationState mutationState

State of the mutation.

Returns
Type Description
MutationState

The MutationState object itself.

View Source

From(params IMutationResult[])

Creates a MutationToken from a list of IMutationResult's assuming enhanced durability is enabled.

Declaration
public static MutationState From(params IMutationResult[] mutationResults)
Parameters
Type Name Description
IMutationResult[] mutationResults

The mutationResults.

Returns
Type Description
MutationState
View Source

From(MutationState)

Creates aMutationState from another MutationState assuming enhanced durability is enabled.

Declaration
public static MutationState From(MutationState mutationState)
Parameters
Type Name Description
MutationState mutationState

State of the mutation.

Returns
Type Description
MutationState

The MutationState object itself.

View Source

GetEnumerator()

Returns an enumerator that iterates through the collection of MutationToken's.

Declaration
public IEnumerator<MutationToken> GetEnumerator()
Returns
Type Description
IEnumerator<MutationToken>

An enumerator that can be used to iterate through the collection.

Implements

IEnumerable<T>
IEnumerable
  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.