kotlin-client/com.couchbase.client.kotlin.kv/MutationState

MutationState

class MutationState : Iterable<MutationToken>

Aggregation of MutationTokens from MutationResults.

Used for specifying advanced scan consistency requirements for SQL++ or Full-Text Search queries.

Thread-safe.

Constructors

fun MutationState()

Creates an empty mutation state.

fun MutationState(tokens: Iterable<MutationToken>)

Creates a mutation state representing the given tokens.

Types

object Companion

Functions

fun add(token: MutationToken)

Adds the given token to this state.

fun add(result: MutationResult)

Adds the given mutation result's token to this state.

fun export(): Map<String, Any?>

Exports this mutation state into a universal format, which can be used either to serialize it into a SQL++ query or to send it over the network to a different application/SDK.

open fun forEach(p0: Consumer<in MutationToken>)

open operator override fun iterator(): Iterator<MutationToken>

open fun spliterator(): Spliterator<MutationToken>

open override fun toString(): String