query-api/me.ahoo.wow.api.query/SnapshotProperties

SnapshotProperties

open class SnapshotProperties

The fields of a snapshot record a query names, as QueryFields: the system fields and STATE, under which the aggregate's state lies. Each name is its path in upper snake case, a nested segment after __: OPERATOR__ID is operator.id.

The compiler generates a <State>Properties object for the state of each aggregate whose module has wow-query-api on its class path. It extends this class, so it carries these fields beside the state's own, which it names after the Kotlin properties of their full path: OrderStateProperties.STATE__STATUS is state.status, and STATE__ITEMS__PRODUCT_ID is state.items.productId, named inside STATE__ITEMS.elementMatch { }. Without a state at hand, the system fields are on the companion: SnapshotProperties.LAST_EVENT_TIME.

val query = listQuery {
    filter {
        OrderStateProperties.STATE__STATUS eq OrderStatus.PAID
        OrderStateProperties.OPERATOR__ID eq "user-1"
    }
    sort { OrderStateProperties.LAST_EVENT_TIME.desc() }
}

Inheritors

Types

object Companion : SnapshotProperties

The system fields alone.

Properties

val ACCESS: QueryField<Any?>

The aggregate's declared access attributes (@Access), by name: a single one's value, a multiple one's values; access names one of them. The built-in owner and space are OWNER_ID and SPACE_ID.

val AGGREGATE_ID: QueryField<String>

The aggregate's id, unique within its tenant.

val DELETED: QueryField<Boolean>

Whether the aggregate is deleted; a query sees only the others unless it filters on the deletion state.

FIRST_EVENT_TIME

val FIRST_EVENT_TIME: QueryField<Long>

When the aggregate got its first event, in epoch milliseconds.

val FIRST_OPERATOR: QueryField<Any?>

Who sent the command that created the aggregate, as OPERATOR.

FIRST_OPERATOR__CROSS_SCOPE

val FIRST_OPERATOR__CROSS_SCOPE: QueryField<Boolean?>

FIRST_OPERATOR__ID

val FIRST_OPERATOR__ID: QueryField<String?>

FIRST_OPERATOR__TENANT_ID

val FIRST_OPERATOR__TENANT_ID: QueryField<String?>

LAST_EVENT_TIME

val LAST_EVENT_TIME: QueryField<Long>

When the aggregate got its last event, in epoch milliseconds.

val OPERATOR: QueryField<Any?>

Who sent the last command: {id, tenantId, crossScope}, or null for an anonymous caller.

OPERATOR__CROSS_SCOPE

val OPERATOR__CROSS_SCOPE: QueryField<Boolean?>

val OPERATOR__ID: QueryField<String?>

OPERATOR__TENANT_ID

val OPERATOR__TENANT_ID: QueryField<String?>

val OWNER_ID: QueryField<String?>

The aggregate's owner, null when it has none.

val SCHEDULES: QueryField<Any?>

The schedules the aggregate keeps: each rule by its key, {type, ...} as Wow's JSON writes it ({type: "cron", expression, zone, misfire}); schedule names one.

val SPACE_ID: QueryField<String?>

The aggregate's space, null when it has none.

val STATE: QueryField<Any?>

The aggregate's state.

val TENANT_ID: QueryField<String>

The aggregate's tenant.

val VERSION: QueryField<Int>

The aggregate's version: the number of its events.

Functions

fun access(name: String): QueryField<*>

The access attribute name of ACCESS: access.<name>.

fun schedule(key: String): QueryField<*>

The schedule key of SCHEDULES: schedules.<key>, its rule.