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

Collection

class Collection
Content copied to clipboard

Operations that act on a Couchbase collection.

Functions

Link copied to clipboard
@VolatileCouchbaseApi
fun counter(documentId: String, common: CommonOptions = CommonOptions.Default, durability: Durability = Durability.none(), expiry: Expiry = Expiry.none()): Counter
Content copied to clipboard

Returns a counter backed by a document on the server.

Link copied to clipboard
suspend fun exists(id: String, common: CommonOptions = CommonOptions.Default): ExistsResult
Content copied to clipboard
Link copied to clipboard
suspend fun get(id: String, common: CommonOptions = CommonOptions.Default, withExpiry: Boolean = false, project: List<String> = emptyList()): GetResult
Content copied to clipboard

Gets a document from this collection.

Link copied to clipboard
fun getAllReplicas(id: String, common: CommonOptions = CommonOptions.Default): Flow<GetReplicaResult>
Content copied to clipboard
Link copied to clipboard
suspend fun getAndLock(id: String, lockTime: Duration, common: CommonOptions = CommonOptions.Default): GetResult
Content copied to clipboard
Link copied to clipboard
suspend fun getAndTouch(id: String, expiry: Expiry, common: CommonOptions = CommonOptions.Default): GetResult
Content copied to clipboard
Link copied to clipboard
suspend fun getAnyReplica(id: String, common: CommonOptions = CommonOptions.Default): GetReplicaResult
Content copied to clipboard
Link copied to clipboard
@VolatileCouchbaseApi
suspend fun getAnyReplicaOrNull(id: String, common: CommonOptions = CommonOptions.Default): GetReplicaResult?
Content copied to clipboard

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

Link copied to clipboard
@VolatileCouchbaseApi
inline suspend fun getOrNull(id: String, common: CommonOptions = CommonOptions.Default, withExpiry: Boolean = false, project: List<String> = emptyList()): GetResult?
Content copied to clipboard

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

Link copied to clipboard
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
Content copied to clipboard
Link copied to clipboard
suspend fun lookupIn(id: String, spec: LookupInSpec, common: CommonOptions = CommonOptions.Default, accessDeleted: Boolean = false): LookupInResult
Content copied to clipboard
inline suspend fun <T, L : LookupInSpec> lookupIn(id: String, spec: L, common: CommonOptions = CommonOptions.Default, accessDeleted: Boolean = false, block: LookupInResult.() -> T): T
Content copied to clipboard

Retrieves specific fields of a document.

Link copied to clipboard
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
Content copied to clipboard
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
Content copied to clipboard
Link copied to clipboard
suspend fun remove(id: String, common: CommonOptions = CommonOptions.Default, durability: Durability = Durability.none(), cas: Long = 0): MutationResult
Content copied to clipboard
Link copied to clipboard
@VolatileCouchbaseApi
suspend fun removeOrNull(id: String, common: CommonOptions = CommonOptions.Default, durability: Durability = Durability.none(), cas: Long = 0): MutationResult?
Content copied to clipboard

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

Link copied to clipboard
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
Content copied to clipboard
Link copied to clipboard
suspend fun touch(id: String, expiry: Expiry, common: CommonOptions = CommonOptions.Default): MutationResult
Content copied to clipboard
Link copied to clipboard
suspend fun unlock(id: String, cas: Long, common: CommonOptions = CommonOptions.Default)
Content copied to clipboard
Link copied to clipboard
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
Content copied to clipboard

Updates a document if it exists, otherwise inserts it.

Properties

Link copied to clipboard
val binary: BinaryCollection
Content copied to clipboard

Provides access to operations that apply only to binary documents.

Link copied to clipboard
@VolatileCouchbaseApi
val keyspace: Keyspace
Content copied to clipboard
Link copied to clipboard
val name: String
Content copied to clipboard
Link copied to clipboard
val scope: Scope
Content copied to clipboard