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

Package com.couchbase.client.kotlin.analytics

Types

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

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

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

Create instances using the positional or named factory methods.

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

One row of a query result.

Link copied to clipboard
sealed class AnalyticsScanConsistency
Content copied to clipboard

Create instances using one of the factory methods.

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

Functions

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

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
Content copied to clipboard

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