Module query_plan

Expand description

Versioned schema identities, facts, provenance, and fingerprints. Reusable typed query plans and the first public V2 read vocabulary. Reusable typed query plans: the first public V2 read vocabulary.

A QueryPlan extends the minimal migration-assertion primitives into a reusable, invocation-free read program: dense typed bindings, declared typed inputs, one closed pattern conjunction, and an ordered pipeline of V1-parity stages (select, require, distinct, sort, offset, limit) ending in one explicit output. Later vocabulary — functions, reductions, documents, reachability — stays reserved behind independent capabilities and is absent from this format, not defaulted.

The persisted assertion algebra keeps its exact meaning: this module defines its own pattern vocabulary rather than widening AssertionPattern.

Structs§

CompatibilityValueV2: One exact V2 compatibility scalar.
DocumentField: One key-value field of a fetched document.
HydrationBindingV2: Declared-to-concrete subtype authority for one plan binding.
HydrationDescriptorV2: Complete field/role authority for one concrete model descriptor.
HydrationFieldV2: One descriptor-qualified hydrated model field.
HydrationPlayerV2: Declared-to-concrete authority for one hydrated role-player occurrence.
HydrationProjectionV2: Complete same-snapshot hydration authority for one model query.
HydrationRoleV2: One descriptor-qualified hydrated relation role.
InputColumn: One typed input column declaration owned by the reusable plan.
InputColumnId: One dense typed input column identity.
InputRow: One rectangular invocation input row.
LocalFunction: One plan-local function defined from the closed pattern algebra.
LocalReturn: The declared scalar return of one plan-local function.
OrderTerm: One typed sort key.
QueryBindingPairV2: One canonical explicit cross-join permission.
QueryFieldV2: One descriptor-qualified field reference in the compatibility algebra.
QueryInvocation: One executable invocation of a reusable validated plan.
QueryNamedOutputSlotV2: One named public output member.
QueryOrderTermV2: One descriptor-qualified model-query order term.
QueryPlan: A reusable, invocation-free typed read program.
QueryPlanFingerprint: Fingerprint of exact canonical query-plan bytes.
QueryPlanV2Compatibility: The additive V2-only compatibility portion of one query plan.
QueryReductionTermV2: One ordered typed reducer term.
QueryStableOrderV2: A validator-proven stable total order.
QueryWindowV2: One bounded model-query result window.
ReduceAssignment: One reduce-stage assignment producing a fresh value binding.

Enums§

DocumentSource: One value source of a fetched document field.
ModelQueryV2: The released model-query terminal contract carried by a V2 plan.
OrderDirection: The sort direction of one order term.
QueryComparatorV2: The closed comparison vocabulary accepted by the released match facade.
QueryMissingOrderV2: Placement of missing order values.
QueryModelOutputSlotV2: One public model-query output slot.
QueryModelOutputV2: Positional or named model-query output shape.
QueryOperand: One typed operand inside a query value comparison.
QueryOperation: The closed operation vocabulary of the first public revision.
QueryOrderDirectionV2: Direction of one model-query order term.
QueryOutput: The explicit output category of the first public vocabulary.
QueryPattern: The closed typed pattern algebra of the first public vocabulary.
QueryPatternV2: The closed boolean compatibility algebra used by the production adapter.
QueryReductionGroupV2: Optional grouping contract for one model-compatible reduction terminal.
QueryReductionKindV2: The closed reducer vocabulary used by model-compatible V2 terminals.
QueryRowCardinalityV2: Cardinality required from a hydrated row query.
ReadStage: One ordered read stage of the first public vocabulary.
Reducer: The closed reducer vocabulary of the first reduce stage.
ReleasedValueKindV2: A released-only lexical scalar domain carried by a V2 compatibility value.

Constants§

QUERY_PLAN_CANONICALIZATION: V1 canonicalization version retained for source compatibility.
QUERY_PLAN_CANONICALIZATION_V1: The V1 canonicalization version.
QUERY_PLAN_CANONICALIZATION_V2: The additive V2 canonicalization version.
QUERY_PLAN_FINGERPRINT_DOMAIN: Domain separating query-plan fingerprints from every other digest.
QUERY_PLAN_FORMAT_V1: The exact wire discriminator for first-format query plans.
QUERY_PLAN_FORMAT_V2: The exact wire discriminator for additive query plans.

Functions§

decode_query_invocation: Decode exact canonical invocation bytes and bind them to one trusted plan.
decode_query_plan: Decode canonical bytes through private constructor-rebuilding wire types.
query_given_rows_capability: Return the transport capability exact given invocations require.
query_plan_authoring_capability_vocabulary: Return every capability the public low-level V2 authoring surface can derive.
query_plan_capability_vocabulary: Return every capability the first query-plan vocabulary can require.
query_plan_v2_capability_vocabulary: Return every capability an additive V2 plan can syntax-derive.

Type Aliases§

ModelOutputV2: Concise alias used by remote response-shape contracts.