QueryDataset

class QueryDataset @InternalWowApi constructor(val name: AggregateType, val scope: QueryDatasetScope, val declaration: QuerySchemaDeclaration, val identity: QueryField<*>? = null, val eventTime: QueryField<*>? = null, val title: String? = null, val storage: ObjectNode = WowJson.mapper.createObjectNode(), val unavailable: String? = null)

A dataset (the DATASET query model): a table-like record set, such as a BI wide table or the ClickHouse Sink's _state_flat view, declared at runtime or in a file rather than in the Manifest. Its fields are its declaration, at the record root; its record layout is its profile.

name is {context}.{dataset}: a dataset takes a name slot of its context, beside that context's aggregates, and the query engine keys it as it keys an aggregate type. storage is the backend's binding of the dataset (a ClickHouse table, say), opaque to the core: its dataset's QueryBindings read it.

A dataset whose unavailable names a reason is served but cannot be queried: each of its queries and its descriptor are answered wow.query.dataset-unavailable (HTTP 409) with that reason, fixed words such as needs revision (7.2b-2), instead of reading a table that may no longer hold what it declares.

Constructors

Link copied to clipboard
constructor(name: AggregateType, scope: QueryDatasetScope, declaration: QuerySchemaDeclaration, identity: QueryField<*>? = null, eventTime: QueryField<*>? = null, title: String? = null, storage: ObjectNode = WowJson.mapper.createObjectNode(), unavailable: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard

When the record last changed: the default orderBy of FIRST and LAST metrics.

Link copied to clipboard

The column that identifies one record: the target of id filters and the tie-breaker of every cursor.

Link copied to clipboard
Link copied to clipboard

The record layout of this dataset: its identity, event time and scope columns.

Link copied to clipboard
Link copied to clipboard
val storage: ObjectNode
Link copied to clipboard
Link copied to clipboard

Why the dataset cannot be queried now, or null when it can.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard

This dataset, unavailable for reason now, or available again with null.