Skip to main content

Module plan

Module plan 

Source
Expand description

SQL planning.

SQL planning is the process of taking the abstract syntax tree of a Statement and turning it into a Plan that the dataflow layer can execute.

Statements must be purified before they can be planned. See the pure module for details.

Structs§

AbortTransactionPlan
AggregateExpr
AlterClusterPlan
AlterClusterRenamePlan
AlterClusterReplicaRenamePlan
AlterClusterSwapPlan
AlterConnectionPlan
AlterDefaultPrivilegesPlan
AlterItemRenamePlan
AlterMaterializedViewApplyReplacementPlan
AlterNetworkPolicyPlan
AlterNoopPlan
Generated by ALTER ... IF EXISTS if the named object did not exist.
AlterOwnerPlan
AlterRetainHistoryPlan
AlterRolePlan
AlterSchemaRenamePlan
AlterSchemaSwapPlan
AlterSecretPlan
AlterSetClusterPlan
AlterSinkPlan
AlterSourceAddSubsourceOptionExtracted
AlterSourcePlan
AlterSourceTimestampIntervalPlan
AlterSystemResetAllPlan
AlterSystemResetPlan
AlterSystemSetPlan
AlterTablePlan
AutoScalingStrategy
The user-configured autoscaling policy of a managed cluster.
ClosePlan
CommentPlan
CommitTransactionPlan
ComputeReplicaConfig
ComputeReplicaIntrospectionConfig
Configuration of introspection for a cluster replica.
Connection
CopyFromPlan
CopyToPlan
COPY TO S3
CreateClusterManagedPlan
CreateClusterPlan
CreateClusterReplicaPlan
CreateClusterUnmanagedPlan
CreateConnectionPlan
CreateDatabasePlan
CreateIndexPlan
CreateMaterializedViewPlan
CreateNetworkPolicyPlan
CreateRolePlan
CreateSchemaPlan
CreateSecretPlan
CreateSinkPlan
CreateSourcePlan
CreateSourcePlanBundle
A CreateSourcePlan and the metadata necessary to sequence it.
CreateTablePlan
CreateTypePlan
CreateViewPlan
DeallocatePlan
DeclarePlan
DropObjectsPlan
DropOwnedPlan
ExecutePlan
ExplainPlanPlan
ExplainPushdownPlan
ExplainSinkSchemaPlan
ExplainTimestampPlan
ExprContext
A bundle of unrelated things that we need for planning Exprs.
FetchPlan
GrantPrivilegesPlan
GrantRolePlan
Hir
HirToMirConfig
Index
InsertPlan
InspectShardPlan
MaterializedView
MySqlConfigOptionExtracted
NetworkPolicyRule
OnHydration
The ON HYDRATION autoscaling sub-policy: while objects are un-hydrated, run an extra replica at hydration_size to accelerate hydration.
Params
A vector of values to which parameter references should be bound.
PgConfigOptionExtracted
PlanClusterOption
PlanContext
Controls planning of a SQL query.
PlannedRoleAttributes
PolicyAddress
PreparePlan
QueryContext
The state required when planning a Query.
RaisePlan
ReadThenWritePlan
ReassignOwnedPlan
ResetVariablePlan
RevokePrivilegesPlan
RevokeRolePlan
Scope
Secret
SelectPlan
A plan for select statements.
SendDiffsPlan
SetTransactionPlan
SetVariablePlan
ShowColumnsPlan
ShowCreatePlan
ShowVariablePlan
Sink
Source
SourceReference
An available external reference for a source and if possible to retrieve, any column names it contains.
SourceReferences
SqlServerConfigOptionExtracted
StartTransactionPlan
StatementContext
Immutable state that applies to the planning of an entire Statement.
StatementDesc
Describes the output of a SQL statement.
SubscribePlan
Table
Type
UpdatePrivilege
ValidateConnectionPlan
View
WebhookHeaderFilters
WebhookHeaders
WebhookValidation
WebhookValidationSecret

Enums§

AlterClusterPlanStrategy
AlterConnectionAction
AlterOptionParameter
AlterSourceAction
ClusterSchedule
CoercibleScalarExpr
A CoercibleScalarExpr is a HirScalarExpr whose type is not fully determined. Several SQL expressions can be freely coerced based upon where in the expression tree they appear. For example, the string literal ‘42’ will be automatically coerced to the integer 42 if used in a numeric context:
ConnectionDetails
CopyFormat
CopyFromFilter
CopyFromSource
CreateClusterVariant
DataSourceDesc
ExecuteTimeout
Explainee
The type of object to be explained
ExplaineeStatement
Explainee types that are statements.
ExplaineeStatementKind
HirRelationExpr
Just like mz_expr::MirRelationExpr, except where otherwise noted below.
HirScalarExpr
Just like mz_expr::MirScalarExpr, except where otherwise noted below.
IndexOption
JoinKind
MutationKind
NetworkPolicyRuleAction
NetworkPolicyRuleDirection
OnTimeoutAction
Plan
Instructions for executing a SQL query.
PlanError
PlanKind
PlanNotice
Notices that can occur in the adapter layer.
PlannedAlterRoleOption
PlannedRoleVariable
QueryLifetime
Specifies how long a query will live.
QueryWhen
Specifies when a Peek or Subscribe should occur.
ReplicaConfig
SideEffectingFunc
A side-effecting function is a function whose evaluation triggers side effects.
SshKey
StatementClassification
Statement classification as documented by plan.
SubscribeFrom
SubscribeOutput
TableDataSource
TableOption
TransactionType
VariableValue
WebhookBodyFormat
WindowExprType
A window function with its parameters.

Functions§

describe
Creates a description of the purified statement stmt.
normalize_subqueries
Normalize the way subqueries appear in HirScalarExpr::Exists or HirScalarExpr::Select variants.
plan
Produces a Plan from the purified statement stmt.
plan_copy_from
resolve_cluster_for_materialized_view