kotlin-client/com.couchbase.client.kotlin/Bucket

Bucket

class Bucket

Functions

collection

fun collection(name: String): Collection

Returns the requested collection in the bucket's default scope.

config

@VolatileCouchbaseApi

suspend fun config(timeout: Duration): BucketConfig

defaultCollection

fun defaultCollection(): Collection

Returns the default collection in this bucket's default scope.

defaultScope

fun defaultScope(): Scope

Returns this bucket's default scope.

ping

suspend fun ping(common: CommonOptions = CommonOptions.Default, services: Set<ServiceType> = emptySet(), reportId: String = UUID.randomUUID().toString()): PingResult

Pings services in the Couchbase cluster.

scope

fun scope(name: String): Scope

Returns the requested scope.

viewQuery

~~fun~~ ~~viewQuery~~(~~designDocument~~: String, ~~viewName~~: String, ~~common~~: CommonOptions = ~~CommonOptions.Default~~, ~~serializer~~: JsonSerializer? = ~~null~~, ~~namespace~~: DesignDocumentNamespace = ~~PRODUCTION~~, ~~scanConsistency~~: ViewScanConsistency = ~~ViewScanConsistency.updateAfter()~~, ~~selection~~: ViewSelection = ~~ViewSelection.range()~~, ~~skip~~: Int = 0, ~~limit~~: Int? = ~~null~~, ~~reduce~~: Boolean = ~~true~~, ~~group~~: ViewGroupLevel = ~~ViewGroupLevel.none()~~, ~~onError~~: ViewErrorMode = ~~ViewErrorMode.CONTINUE~~, ~~debug~~: Boolean = ~~false~~, ~~raw~~: Map<String, String>? = ~~null~~): Flow<ViewFlowItem>

Queries a view on the bucket.

waitUntilReady

suspend fun waitUntilReady(timeout: Duration, services: Set<ServiceType> = emptySet(), desiredState: ClusterState = ClusterState.ONLINE): Bucket

Waits until SDK bootstrap is complete and the desired ClusterState is observed.

Properties

cluster

val cluster: Cluster

collections

@UncommittedCouchbaseApi

val collections: CollectionManager

A manager for administering Scopes and Collections within this bucket.

name

val name: String

viewIndexes

~~val~~ ~~viewIndexes~~: ViewIndexManager