kotlin-client/com.couchbase.client.kotlin/Collection

Collection

Operations that act on a Couchbase collection.

Functions

fun counter(documentId: String, common: CommonOptions = CommonOptions.Default, durability: Durability = Durability.none(), expiry: Expiry = Expiry.none()): Counter

Returns a counter backed by a document on the server.

exists

suspend fun exists(id: String, common: CommonOptions = CommonOptions.Default): ExistsResult

get

suspend fun get(id: String, common: CommonOptions = CommonOptions.Default, withExpiry: Boolean = false, project: List<String> = emptyList()): GetResult

Gets a document from this collection.

getAllReplicas

fun getAllReplicas(id: String, common: CommonOptions = CommonOptions.Default): Flow<GetReplicaResult>

Like get, but sends the request to all replicas in addition to the active. Returns the results from all available sources.

getAndLock

suspend fun getAndLock(id: String, lockTime: Duration, common: CommonOptions = CommonOptions.Default): GetResult

getAndTouch

suspend fun getAndTouch(id: String, expiry: Expiry, common: CommonOptions = CommonOptions.Default): GetResult

getAnyReplica

suspend fun getAnyReplica(id: String, common: CommonOptions = CommonOptions.Default): GetReplicaResult

Like get, but sends the request to all replicas in addition to the active. Returns the result from whichever server node responded quickest.

getAnyReplicaOrNull

@VolatileCouchbaseApi

suspend fun getAnyReplicaOrNull(id: String, common: CommonOptions = CommonOptions.Default): GetReplicaResult?

Like getAnyReplica, but returns null instead of throwing DocumentUnretrievableException if the document was not found.

getOrNull

@VolatileCouchbaseApi

inline suspend fun getOrNull(id: String, common: CommonOptions = CommonOptions.Default, withExpiry: Boolean = false, project: List<String> = emptyList()): GetResult?

Like get, but returns null instead of throwing DocumentNotFoundException if the document is not found.

insert

inline suspend fun <T> insert(id: String, content: T, common: CommonOptions = CommonOptions.Default, transcoder: Transcoder? = null, durability: Durability = Durability.none(), expiry: Expiry = Expiry.None): MutationResult

lookupIn

suspend fun lookupIn(id: String, spec: LookupInSpec, common: CommonOptions = CommonOptions.Default, accessDeleted: Boolean = false): LookupInResult

inline suspend fun <T, L : LookupInSpec> lookupIn(id: String, spec: L, common: CommonOptions = CommonOptions.Default, accessDeleted: Boolean = false, block: LookupInResult.() -> T): T

Retrieves specific fields of a document.

lookupInAllReplicas

@SinceCouchbase(value = "7.6")

fun lookupInAllReplicas(id: String, spec: LookupInSpec, common: CommonOptions = CommonOptions.Default): Flow<LookupInReplicaResult>

Like lookupIn, but sends the request to all replicas in addition to the active. Returns the results from all available sources.

lookupInAnyReplica

@SinceCouchbase(value = "7.6")

suspend fun lookupInAnyReplica(id: String, spec: LookupInSpec, common: CommonOptions = CommonOptions.Default): LookupInReplicaResult

@SinceCouchbase(value = "7.6")

inline suspend fun <T, L : LookupInSpec> lookupInAnyReplica(id: String, spec: L, common: CommonOptions = CommonOptions.Default, block: LookupInReplicaResult.() -> T): T

Like lookupIn, but sends the request to all replicas in addition to the active. Returns the result from whichever server node responded quickest.

mutateIn

suspend fun mutateIn(id: String, common: CommonOptions = CommonOptions.Default, expiry: Expiry = Expiry.none(), preserveExpiry: Boolean = false, durability: Durability = Durability.none(), storeSemantics: StoreSemantics = StoreSemantics.replace(), serializer: JsonSerializer? = null, accessDeleted: Boolean = false, createAsDeleted: Boolean = false, block: MutateInSpec.() -> Unit): MutateInResult

suspend fun mutateIn(id: String, spec: MutateInSpec, common: CommonOptions = CommonOptions.Default, expiry: Expiry = Expiry.none(), preserveExpiry: Boolean = false, durability: Durability = Durability.none(), storeSemantics: StoreSemantics = StoreSemantics.replace(), serializer: JsonSerializer? = null, accessDeleted: Boolean = false, createAsDeleted: Boolean = false): MutateInResult

remove

suspend fun remove(id: String, common: CommonOptions = CommonOptions.Default, durability: Durability = Durability.none(), cas: Long = 0): MutationResult

removeOrNull

@VolatileCouchbaseApi

suspend fun removeOrNull(id: String, common: CommonOptions = CommonOptions.Default, durability: Durability = Durability.none(), cas: Long = 0): MutationResult?

Like remove, but returns null instead of throwing DocumentNotFoundException if the document was not found.

replace

inline suspend fun <T> replace(id: String, content: T, common: CommonOptions = CommonOptions.Default, transcoder: Transcoder? = null, durability: Durability = Durability.none(), expiry: Expiry = Expiry.None, @SinceCouchbase(value = "7.0") preserveExpiry: Boolean = false, cas: Long = 0): MutationResult

scanDocuments

@SinceCouchbase(value = "7.6")

fun scanDocuments(type: ScanType = ScanType.range(), common: CommonOptions = CommonOptions.Default, consistency: KvScanConsistency = KvScanConsistency.notBounded(), batchItemLimit: Int = DEFAULT_SCAN_BATCH_ITEM_LIMIT, batchSizeLimit: StorageSize = DEFAULT_SCAN_BATCH_SIZE_LIMIT): Flow<GetResult>

Depending on the scan type, returns from this collection:

scanIds

@SinceCouchbase(value = "7.6")

fun scanIds(type: ScanType = ScanType.range(), common: CommonOptions = CommonOptions.Default, consistency: KvScanConsistency = KvScanConsistency.notBounded(), batchItemLimit: Int = DEFAULT_SCAN_BATCH_ITEM_LIMIT, batchSizeLimit: StorageSize = DEFAULT_SCAN_BATCH_SIZE_LIMIT): Flow<String>

Like scanDocuments, but returns only document IDs instead of full documents.

touch

suspend fun touch(id: String, expiry: Expiry, common: CommonOptions = CommonOptions.Default): MutationResult

unlock

suspend fun unlock(id: String, cas: Long, common: CommonOptions = CommonOptions.Default)

upsert

inline suspend fun <T> upsert(id: String, content: T, common: CommonOptions = CommonOptions.Default, transcoder: Transcoder? = null, durability: Durability = Durability.none(), expiry: Expiry = Expiry.None, @SinceCouchbase(value = "7.0") preserveExpiry: Boolean = false): MutationResult

Updates a document if it exists, otherwise inserts it.

Properties

binary

val binary: BinaryCollection

Provides access to operations that apply only to binary documents.

keyspace

@VolatileCouchbaseApi

val keyspace: Keyspace

name

val name: String

queryIndexes

@VolatileCouchbaseApi

@SinceCouchbase(value = "7.0")

val queryIndexes: CollectionQueryIndexManager

A manager for administering this collection's SQL++ indexes.

scope

val scope: Scope