Package com.couchbase.client.kotlin.query

Types

Link copied to clipboard
sealed class QueryFlowItem
Link copied to clipboard
class QueryMetadata : QueryFlowItem

Metadata about query execution. Always the last item in the flow.

Link copied to clipboard
class QueryMetrics
Link copied to clipboard
sealed class QueryParameters

Create instances using the positional or named factory methods.

Link copied to clipboard
enum QueryProfile : Enum<QueryProfile>

Controls how much query profiling information is included in the response metadata.

Link copied to clipboard
class QueryResult(rows: List<QueryRow>, metadata: QueryMetadata)
Link copied to clipboard
class QueryRow(content: ByteArray, defaultSerializer: JsonSerializer) : QueryFlowItem

One row of a query result.

Link copied to clipboard
sealed class QueryScanConsistency

Create instances using the requestPlus, consistentWith, or notBounded factory methods.

Link copied to clipboard
enum QueryStatus : Enum<QueryStatus>
Link copied to clipboard
class QueryWarning(code: Int, message: String)

Functions

Link copied to clipboard
suspend fun Flow<QueryFlowItem>.execute(): QueryResult

Collects a query Flow into a QueryResult. Should only be called if the query results are expected to fit in memory.

inline suspend fun Flow<QueryFlowItem>.execute(crossinline rowAction: suspend (QueryRow) -> Unit): QueryMetadata

Collects a query Flow, passing each result row to the given lambda. Returns metadata about the query.