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

Bucket

class Bucket

Properties

Link copied to clipboard
Link copied to clipboard
@UncommittedCouchbaseApi
val collections: CollectionManager

A manager for administering Scopes and Collections within this bucket.

Link copied to clipboard
val name: String
Link copied to clipboard

Functions

Link copied to clipboard
fun collection(name: String): Collection

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

Link copied to clipboard
@VolatileCouchbaseApi
suspend fun config(timeout: Duration): BucketConfig
Link copied to clipboard
fun defaultCollection(): Collection

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

Link copied to clipboard
fun defaultScope(): Scope

Returns this bucket's default scope.

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

Pings services in the Couchbase cluster.

Link copied to clipboard
fun scope(name: String): Scope

Returns the requested scope.

Link copied to clipboard
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.

Link copied to clipboard
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.