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

Counter

A counter backed by a document on Couchbase Server.

Create an instance using Collection.counter.

Counter operations are atomic with respect to a single Couchbase Server cluster, but not between clusters when Cross-Datacenter Replication (XDCR) is used.

The content of a counter document is a single JSON integer with a minimum value of zero and a maximum value of 2^64 - 1.

A counter decremented below zero is reset to zero.

A counter incremented above 2^64 - 1 overflows (wraps around).

Counter values above 2^53 - 1 may have interoperability issues with other languages that store all numbers as floating point values.

Functions

addAndGet

suspend fun addAndGet(delta: Long): ULong

Atomically adds the given delta to the current value.

decrementAndGet

suspend fun decrementAndGet(): ULong

Atomically decrements by one the current value.

get

suspend fun get(): ULong

Returns the current value of the counter.

incrementAndGet

suspend fun incrementAndGet(): ULong

Atomically increments by one the current value.

set

suspend fun set(value: ULong): MutationResult

Sets the value of the counter.

toString

open override fun toString(): String

Properties

collection

val collection: Collection

common

val common: CommonOptions

documentId

val documentId: String

durability

val durability: Durability

expiry

val expiry: Expiry

Counter

See also

Functions

Properties