kotlin-client/com.couchbase.client.kotlin.analytics

Package-level declarations

Types

Link copied to clipboard
sealed class AnalyticsFlowItem
Link copied to clipboard
class AnalyticsMetadata(header: AnalyticsChunkHeader, trailer: AnalyticsChunkTrailer) : AnalyticsFlowItem

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

Link copied to clipboard
class AnalyticsMetrics(val map: Map<String, Any?>)
Link copied to clipboard
sealed class AnalyticsParameters

Create instances using the positional or named factory methods.

Link copied to clipboard
sealed class AnalyticsPriority
Link copied to clipboard
class AnalyticsResult(val rows: List<AnalyticsRow>, val metadata: AnalyticsMetadata)
Link copied to clipboard
class AnalyticsRow(val content: ByteArray, defaultSerializer: JsonSerializer) : AnalyticsFlowItem

One row of a query result.

Link copied to clipboard
sealed class AnalyticsScanConsistency

Create instances using one of the factory methods.

Link copied to clipboard
Link copied to clipboard
class AnalyticsWarning(val code: Int, val message: String)

Functions

Link copied to clipboard
suspend fun Flow<AnalyticsFlowItem>.execute(): AnalyticsResult

Collects an analytics query Flow into an AnalyticsResult. Should only be called if the query results are expected to fit in memory.

inline suspend fun Flow<AnalyticsFlowItem>.execute(crossinline rowAction: suspend (AnalyticsRow) -> Unit): AnalyticsMetadata

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