wow-query/me.ahoo.wow.query.schema/QueryViolation

QueryViolation

The error catalog (design §5.9): every rule a query can break, as structured facts. Each violation names its stable code, renders its message from its facts, and belongs to a Kind that decides the error it becomes (rejection): the one place a rejection is rendered. Codes are a contract (added, never renamed); texts are not.

Server faults (a failing mask strategy, a result that breaks integrity, a storage that timed out) are not violations: they are me.ahoo.wow.query.QueryExecutionExceptions.

Inheritors

Types

AnyRequiresSingleValue

data object AnyRequiresSingleValue : QueryViolation

ArrayEquality

data class ArrayEquality(val field: QueryField) : QueryViolation

EQ / NE on field names an array operand, and the storage cannot compare a whole array.

Companion

object Companion

CountRequiresFilter

data class CountRequiresFilter(val label: String) : QueryViolation

A counting query (count, paged total) matches every record, and the entry does not allow expensive operators.

CursorNotAllowed

data class CursorNotAllowed(val field: QueryField) : QueryViolation

CursorSortDuplicate

data class CursorSortDuplicate(val field: QueryField) : QueryViolation

A cursor sort names field twice once the identity tie-breaker is appended.

CursorSortTooMany

data class CursorSortTooMany(val max: Int) : QueryViolation

A cursor sort has more than max fields once the identity tie-breaker is appended.

DuplicateSortField

data class DuplicateSortField(val field: QueryField) : QueryViolation

Two sort fields (field is the later one) are bound to the same physical field, so one of them sorts nothing.

ElementScopeRequired

data class ElementScopeRequired(val field: QueryField) : QueryViolation

EventProjectionTypeRequired

data class EventProjectionTypeRequired(val field: QueryField) : QueryViolation

An event projection that keeps payloads must keep their type, so each payload can be read.

ExpensiveOperatorDisabled

data class ExpensiveOperatorDisabled(val label: String, val construct: String, val plural: Boolean = false, val location: String) : QueryViolation

construct (e.g. query operator[CONTAINS]) is expensive, and the entry does not allow expensive operators.

ExplicitEntryRequired

data object ExplicitEntryRequired : QueryViolation

The gateway requires every query to state its entry, and this one ran under UNSPECIFIED.

FilterTooLarge

data class FilterTooLarge(val label: String, val subject: String, val value: Int, val max: Int, val location: String) : QueryViolation

The filter (and HAVING) of a query has more nodes or values (subject) than the entry allows.

FirstLastRequiresOrderBy

data class FirstLastRequiresOrderBy(val field: QueryField) : QueryViolation

A FIRST / LAST metric inside an element, or on a model without an event time, names no orderBy.

FirstLastRequiresSingleValue

data class FirstLastRequiresSingleValue(val field: QueryField) : QueryViolation

FIRST / LAST need a single value per record, both for the value and for its ordering field.

IdentityUndefined

data class IdentityUndefined(val model: QueryModel) : QueryViolation

An identity filter or a cursor (whose tie-breaker is the identity) on a model that defines no identity.

IncompleteProjection

data object IncompleteProjection : QueryViolation

InvalidCursor

data object InvalidCursor : QueryViolation

A cursor token that does not decode for this model and effective sort.

Kind

enum Kind : Enum<QueryViolation.Kind>

Which error a violation renders as.

MetricFilterArrayField

data class MetricFilterArrayField(val field: QueryField) : QueryViolation

MetricFilterElementMatch

data object MetricFilterElementMatch : QueryViolation

MetricFilterSearch

data object MetricFilterSearch : QueryViolation

MissingKeyRequiresString

data class MissingKeyRequiresString(val field: QueryField) : QueryViolation

ModelSearchUnsupported

data object ModelSearchUnsupported : QueryViolation

NotCollection

data class NotCollection(val field: QueryField) : QueryViolation

NotProjectable

data class NotProjectable(val field: QueryField) : QueryViolation

NotSingleString

data class NotSingleString(val field: QueryField) : QueryViolation

ParallelArraySort

data class ParallelArraySort(val field: QueryField, val other: QueryField) : QueryViolation

field and other are independent arrays, and the storage cannot sort by both.

ProtectedAggregation

data class ProtectedAggregation(val field: QueryField) : QueryViolation

ProtectedComparison

data class ProtectedComparison(val field: QueryField) : QueryViolation

A filter or sort compares a sensitive field whose raw value must not be compared.

ResidualGroupsExceeded

data class ResidualGroupsExceeded(val label: String, val max: Int) : QueryViolation

An aggregation whose HAVING or metric sort the core computes read more than max groups, dense fill rows included. Metered while the rows arrive, so it can fail after the response started streaming.

SizeOutOfRange

data class SizeOutOfRange(val label: String, val subject: String, val value: Long, val min: Long?, val max: Long?, val location: String) : QueryViolation

A size the entry bounds (subject: a list or aggregation limit, a page index, size, window or offset, a cursor size) is value, outside min..max; a null bound is open.

SortTooMany

data class SortTooMany(val max: Int) : QueryViolation

A sort names more fields than any storage supports.

StorageUnsupported

data class StorageUnsupported(val feature: String, val field: QueryField? = null) : QueryViolation

The storage cannot run feature: it declares the feature unsupported, or its native language cannot express the query (a backend's native check). field is the field involved, when there is one.

TemporalAggregationUnsupported