query/me.ahoo.wow.query.schema/QueryModelSchema

QueryModelSchema

class QueryModelSchema(val model: QueryModel, capabilities: Set<QueryCapability>, val definition: LogicalQuerySchema, bindings: Map<QueryPathTemplate, QueryValueBindings>, val fullProjectionAvailable: Boolean = true, approximateMetrics: Set<String> = emptySet(), val storage: StorageSupport = StorageSupport.NATIVE, val provisional: Boolean = false, val profile: QueryModelProfile? = QueryModelProfile.of(model))

Published facts only: model values and operation-specific native locations.

Constructors

QueryModelSchema

constructor(model: QueryModel, capabilities: Set<QueryCapability>, definition: LogicalQuerySchema, bindings: Map<QueryPathTemplate, QueryValueBindings>, fullProjectionAvailable: Boolean = true, approximateMetrics: Set<String> = emptySet(), storage: StorageSupport = StorageSupport.NATIVE, provisional: Boolean = false, profile: QueryModelProfile? = QueryModelProfile.of(model))

Properties

approximateMetrics

val approximateMetrics: Set<String>

bindings

val bindings: Map<QueryPathTemplate, QueryValueBindings>

capabilities

val capabilities: Set<QueryCapability>

definition

val definition: LogicalQuerySchema

fullProjectionAvailable

val fullProjectionAvailable: Boolean

Whether native storage can deliver an unrestricted source projection.

hasAliases

val hasAliases: Boolean

Whether some field has an alias a query may use instead of its canonical path.

hasIncomparableFields

val hasIncomparableFields: Boolean

Whether some field's raw value must not be compared. Model-wide search then cannot be admitted: it matches every searchable field, and storage decides which fields those are.

maskedFields

val maskedFields: List<String>

The logical paths of the masked fields ({key} for a map key), in declaration order.

model

val model: QueryModel

profile

val profile: QueryModelProfile?

The record layout of model: a built-in model's, a dataset's own, or null for another custom model.

provisional

val provisional: Boolean

Compiled from QueryStorageFacts.provisional facts: the storage does not exist yet.

root

val root: QueryValueSchema

storage

val storage: StorageSupport

How the storage pages and aggregates, as its adapter declares it.

version

val version: String

The content hash of what this schema states: its model, capabilities, storage support and every logical value with its native bindings and sensitivity. It is budget-free; the capability descriptor of an entry (describe) carries its own content hash, the ETag of the descriptor route.

Functions

field

@InternalWowApi

fun field(field: QueryField<*>): QueryFieldSchema?

supports

fun supports(capability: QueryCapability): Boolean