Package com.couchbase.client.kotlin.analytics

Types

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

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

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

Create instances using the positional or named factory methods.

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

One row of a query result.

AnalyticsScanConsistency
Link copied to clipboard
sealed class AnalyticsScanConsistency

Create instances using one of the factory methods.

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

Functions

execute
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.