Module plan 

SqlPlan intermediate representation and supporting types.

Structs

AlterArrayPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::AlterArray.

ArrayAggPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::ArrayAgg.

ArrayElementwisePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::ArrayElementwise.

ArrayPrefilter

Cross-engine prefilter for SqlPlan::VectorSearch: the array slice runs first, its matching cells’ surrogates form a bitmap that gates the HNSW candidate set.

ArrayProjectPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::ArrayProject.

ArraySlicePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::ArraySlice.

CreateArrayPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::CreateArray.

CreateIndexPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::CreateIndex.

CtePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::Cte.

DeleteArrayPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::DeleteArray.

DocumentIndexLookupPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::DocumentIndexLookup.

DropIndexPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::DropIndex.

HybridSearchPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::HybridSearch.

HybridSearchTriplePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::HybridSearchTriple.

InsertArrayPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::InsertArray.

InsertPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::Insert.

KvInsertPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::KvInsert.

LateralLoopPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::LateralLoop.

LateralTopKPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::LateralTopK.

MergePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::Merge.

MergePlanClause

A single WHEN ... THEN ... arm within a SqlPlan::Merge.

RangeScanPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::RangeScan.

RecursiveScanPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::RecursiveScan.

RecursiveValuePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::RecursiveValue.

TextScoreColumn

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. One bm25_score(column, query) the SELECT list or ORDER BY reads.

TextSearchPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::TextSearch.

TimeseriesIngestPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::TimeseriesIngest.

TimeseriesScanPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::TimeseriesScan.

UpsertPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::Upsert.

VectorAnnOptions

Knobs the vector planner exposes via SQL.

VectorPrimaryDeletePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::VectorPrimaryDelete.

VectorPrimaryInsertPlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::VectorPrimaryInsert.

VectorPrimaryRow

A single row for a vector-primary INSERT.

VectorPrimaryTruncatePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::VectorPrimaryTruncate.

VectorPrimaryUpdatePlan

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Payload of SqlPlan::VectorPrimaryUpdate.

Enums

DistanceMetric

Distance metric selection.

KvInsertIntent

INSERT-vs-UPSERT intent carried on SqlPlan::KvInsert.

MergeClauseKind

Which rows trigger a WHEN arm.

MergePlanAction

The action performed when a WHEN arm fires.

PlanCacheEligibility

Whether a logical plan may be lowered once and reused from the physical-plan cache.

SqlPlan

The top-level plan produced by the SQL planner.

TextSearchShape

Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. Per-family payloads of the larger SqlPlan variants. What a text search returns.

VectorPrimaryInsertIntent

Row-existence intent carried on SqlPlan::VectorPrimaryInsert.

VectorQuantization

Quantization choices exposed at SQL level.

WriteRoute

The lowering a row-shaped write takes, carried on SqlPlan::Insert and SqlPlan::Upsert.

Functions

contains_sequence_accessor

Whether expr calls a sequence accessor anywhere outside a subquery.

expr_is_volatile

Whether an expression tree contains a call to a Volatile function.

first_sequence_accessor

The name of the first sequence accessor called in expr, when one is.

projection_is_cp_computed

Whether projection holds an entry the Control Plane evaluates per row.

referenced_columns

Every column expr references, qualified as table.name when the reference carries a table, deduplicated, in first-seen order.