Documentation ¶
Overview ¶
Package operators contains the operators used to plan queries.
The operators go through a few phases while planning:
- Initial plan In this first pass, we build an operator tree from the incoming parsed query. At the leaves, it will contain QueryGraphs - these are the tables in the FROM clause that we can easily do join ordering on because they are all inner joins. All the post-processing - aggregations, sorting, limit etc. are at this stage contained in Horizon structs. We try to push these down under routes, and expand the ones that can't be pushed down into individual operators such as Projection, Agreggation, Limit, etc.
- Planning Once the initial plan has been fully built, we go through a number of phases. recursively running rewriters on the tree in a fixed point fashion, until we've gone over all phases and the tree has stop changing.
- Offset planning Now is the time to stop working with AST objects and transform remaining expressions being used on top of vtgate to either offsets on inputs or evalengine expressions.
Index ¶
- Constants
- func AddPredicate(ctx *plancontext.PlanningContext, join JoinOp, expr sqlparser.Expr, ...) (ops.Operator, error)
- func Clone(op ops.Operator) ops.Operator
- func CompareRefInt(a *int, b *int) bool
- func CostOf(op ops.Operator) (cost int)
- func IsTableSchemaOrName(e sqlparser.Expr) (col *sqlparser.ColName, isTableSchema bool, isTableName bool)
- func NotImplementedSchemaInfoResolver(*sqlparser.ColName) (int, error)
- func PlanQuery(ctx *plancontext.PlanningContext, stmt sqlparser.Statement) (ops.Operator, error)
- func QualifiedIdentifier(ks *vindexes.Keyspace, i sqlparser.IdentifierCS) string
- func QualifiedString(ks *vindexes.Keyspace, s string) string
- func QualifiedTableName(ks *vindexes.Keyspace, t sqlparser.TableName) string
- func QualifiedTableNames(ks *vindexes.Keyspace, ts []sqlparser.TableName) []string
- func QualifiedTables(ks *vindexes.Keyspace, vts []*vindexes.Table) []string
- func RemovePredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr, op ops.Operator) (ops.Operator, error)
- func SingleQualifiedIdentifier(ks *vindexes.Keyspace, i sqlparser.IdentifierCS) []string
- func SingleQualifiedString(ks *vindexes.Keyspace, s string) []string
- func TableID(op ops.Operator) (result semantics.TableSet)
- func TablesUsed(op ops.Operator) []string
- func ToSQL(ctx *plancontext.PlanningContext, op ops.Operator) (sqlparser.Statement, ops.Operator, error)
- func UnresolvedPredicates(op ops.Operator, st *semantics.SemTable) (result []sqlparser.Expr)
- type Aggr
- type AggrRewriter
- type Aggregator
- func (a *Aggregator) AddColumn(ctx *plancontext.PlanningContext, reuse bool, groupBy bool, ...) (int, error)
- func (a *Aggregator) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (a *Aggregator) Clone(inputs []ops.Operator) ops.Operator
- func (a *Aggregator) FindCol(ctx *plancontext.PlanningContext, in sqlparser.Expr, underRoute bool) (int, error)
- func (a *Aggregator) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (a *Aggregator) GetOrdering() ([]ops.OrderBy, error)
- func (a *Aggregator) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (a *Aggregator) Inputs() []ops.Operator
- func (a *Aggregator) SetInputs(operators []ops.Operator)
- func (a *Aggregator) ShortDescription() string
- func (a *Aggregator) SplitAggregatorBelowRoute(input []ops.Operator) *Aggregator
- type AliasedProjections
- type AnyShardRouting
- func (rr *AnyShardRouting) AlternateInKeyspace(keyspace *vindexes.Keyspace) *Route
- func (rr *AnyShardRouting) Clone() Routing
- func (rr *AnyShardRouting) Cost() int
- func (rr *AnyShardRouting) Keyspace() *vindexes.Keyspace
- func (rr *AnyShardRouting) OpCode() engine.Opcode
- func (rr *AnyShardRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
- type ApplyJoin
- func (aj *ApplyJoin) AddColumn(ctx *plancontext.PlanningContext, reuse bool, groupBy bool, ...) (int, error)
- func (aj *ApplyJoin) AddJoinPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) error
- func (aj *ApplyJoin) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (aj *ApplyJoin) Clone(inputs []ops.Operator) ops.Operator
- func (aj *ApplyJoin) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, _ bool) (int, error)
- func (aj *ApplyJoin) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (aj *ApplyJoin) GetLHS() ops.Operator
- func (aj *ApplyJoin) GetOrdering() ([]ops.OrderBy, error)
- func (aj *ApplyJoin) GetRHS() ops.Operator
- func (aj *ApplyJoin) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (aj *ApplyJoin) Inputs() []ops.Operator
- func (aj *ApplyJoin) IsInner() bool
- func (a *ApplyJoin) LHSColumnsNeeded(ctx *plancontext.PlanningContext) (needed sqlparser.Exprs)
- func (aj *ApplyJoin) MakeInner()
- func (aj *ApplyJoin) SetInputs(inputs []ops.Operator)
- func (aj *ApplyJoin) SetLHS(operator ops.Operator)
- func (aj *ApplyJoin) SetRHS(operator ops.Operator)
- func (aj *ApplyJoin) ShortDescription() string
- type BindVarExpr
- type ColNameColumns
- type Cost
- type Delete
- func (Delete) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (Delete) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
- func (d *Delete) Clone([]ops.Operator) ops.Operator
- func (Delete) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (Delete) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (d *Delete) GetOrdering() ([]ops.OrderBy, error)
- func (Delete) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (Delete) Inputs() []ops.Operator
- func (Delete) SetInputs(ops []ops.Operator)
- func (d *Delete) ShortDescription() string
- func (d *Delete) Statement() sqlparser.Statement
- func (d *Delete) TablesUsed() []string
- type DerivedTable
- type Distinct
- func (d *Distinct) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ...) (int, error)
- func (d *Distinct) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (d *Distinct) Clone(inputs []ops.Operator) ops.Operator
- func (d *Distinct) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (d *Distinct) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (d *Distinct) GetOrdering() ([]ops.OrderBy, error)
- func (d *Distinct) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (d *Distinct) Inputs() []ops.Operator
- func (d *Distinct) SetInputs(operators []ops.Operator)
- func (d *Distinct) ShortDescription() string
- type DualRouting
- type EvalEngine
- type ExprInfo
- type Filter
- func (f *Filter) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ...) (int, error)
- func (f *Filter) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (f *Filter) Clone(inputs []ops.Operator) ops.Operator
- func (f *Filter) Compact(*plancontext.PlanningContext) (ops.Operator, *rewrite.ApplyResult, error)
- func (f *Filter) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (f *Filter) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (f *Filter) GetOrdering() ([]ops.OrderBy, error)
- func (f *Filter) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (f *Filter) Inputs() []ops.Operator
- func (f *Filter) SetInputs(ops []ops.Operator)
- func (f *Filter) ShortDescription() string
- func (f *Filter) UnsolvedPredicates(st *semantics.SemTable) []sqlparser.Expr
- type FkCascade
- func (FkCascade) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (FkCascade) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
- func (fkc *FkCascade) Clone(inputs []ops.Operator) ops.Operator
- func (FkCascade) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (FkCascade) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (fkc *FkCascade) GetOrdering() ([]ops.OrderBy, error)
- func (FkCascade) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (fkc *FkCascade) Inputs() []ops.Operator
- func (fkc *FkCascade) SetInputs(operators []ops.Operator)
- func (fkc *FkCascade) ShortDescription() string
- type FkChild
- func (FkChild) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (FkChild) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
- func (FkChild) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (FkChild) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (FkChild) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- type FkVerify
- func (FkVerify) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (FkVerify) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
- func (fkv *FkVerify) Clone(inputs []ops.Operator) ops.Operator
- func (FkVerify) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (FkVerify) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (fkv *FkVerify) GetOrdering() ([]ops.OrderBy, error)
- func (FkVerify) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (fkv *FkVerify) Inputs() []ops.Operator
- func (fkv *FkVerify) SetInputs(operators []ops.Operator)
- func (fkv *FkVerify) ShortDescription() string
- type Generate
- type GroupBy
- type Horizon
- func (h *Horizon) AddColumn(ctx *plancontext.PlanningContext, reuse bool, _ bool, ...) (int, error)
- func (h *Horizon) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (h *Horizon) Clone(inputs []ops.Operator) ops.Operator
- func (h *Horizon) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (h *Horizon) GetColumns(ctx *plancontext.PlanningContext) (exprs []*sqlparser.AliasedExpr, err error)
- func (h *Horizon) GetOrdering() ([]ops.OrderBy, error)
- func (h *Horizon) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (h *Horizon) Inputs() []ops.Operator
- func (h *Horizon) IsDerived() bool
- func (h *Horizon) IsMergeable(ctx *plancontext.PlanningContext) bool
- func (h *Horizon) SetInputs(ops []ops.Operator)
- func (h *Horizon) ShortDescription() string
- type InfoSchemaRouting
- func (isr *InfoSchemaRouting) Clone() Routing
- func (isr *InfoSchemaRouting) Cost() int
- func (isr *InfoSchemaRouting) Keyspace() *vindexes.Keyspace
- func (isr *InfoSchemaRouting) OpCode() engine.Opcode
- func (isr *InfoSchemaRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
- type Insert
- func (Insert) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (Insert) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
- func (i *Insert) Clone(inputs []ops.Operator) ops.Operator
- func (Insert) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (Insert) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (i *Insert) GetOrdering() ([]ops.OrderBy, error)
- func (Insert) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (i *Insert) Inputs() []ops.Operator
- func (i *Insert) SetInputs(inputs []ops.Operator)
- func (i *Insert) ShortDescription() string
- func (i *Insert) Statement() sqlparser.Statement
- func (i *Insert) TablesUsed() []string
- type Join
- func (Join) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (j *Join) AddJoinPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) error
- func (j *Join) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (j *Join) Clone(inputs []ops.Operator) ops.Operator
- func (j *Join) Compact(ctx *plancontext.PlanningContext) (ops.Operator, *rewrite.ApplyResult, error)
- func (Join) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (Join) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (j *Join) GetLHS() ops.Operator
- func (j *Join) GetOrdering() ([]ops.OrderBy, error)
- func (j *Join) GetRHS() ops.Operator
- func (Join) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (j *Join) Inputs() []ops.Operator
- func (j *Join) IsInner() bool
- func (j *Join) MakeInner()
- func (j *Join) SetInputs(ops []ops.Operator)
- func (j *Join) SetLHS(operator ops.Operator)
- func (j *Join) SetRHS(operator ops.Operator)
- func (j *Join) ShortDescription() string
- type JoinColumn
- type JoinOp
- type Limit
- func (l *Limit) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ...) (int, error)
- func (l *Limit) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (l *Limit) Clone(inputs []ops.Operator) ops.Operator
- func (l *Limit) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (l *Limit) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (l *Limit) GetOrdering() ([]ops.OrderBy, error)
- func (l *Limit) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (l *Limit) Inputs() []ops.Operator
- func (l *Limit) SetInputs(operators []ops.Operator)
- func (l *Limit) ShortDescription() string
- type LockAndComment
- func (l *LockAndComment) AddColumn(ctx *plancontext.PlanningContext, reuseExisting bool, addToGroupBy bool, ...) (int, error)
- func (l *LockAndComment) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (l *LockAndComment) Clone(inputs []ops.Operator) ops.Operator
- func (l *LockAndComment) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (l *LockAndComment) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (l *LockAndComment) GetOrdering() ([]ops.OrderBy, error)
- func (l *LockAndComment) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (l *LockAndComment) Inputs() []ops.Operator
- func (l *LockAndComment) SetInputs(operators []ops.Operator)
- func (l *LockAndComment) ShortDescription() string
- type NoneRouting
- type Offset
- type OpWithAST
- type Ordering
- func (o *Ordering) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ...) (int, error)
- func (o *Ordering) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (o *Ordering) Clone(inputs []ops.Operator) ops.Operator
- func (o *Ordering) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (o *Ordering) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (o *Ordering) GetOrdering() ([]ops.OrderBy, error)
- func (o *Ordering) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (o *Ordering) Inputs() []ops.Operator
- func (o *Ordering) SetInputs(operators []ops.Operator)
- func (o *Ordering) ShortDescription() string
- type Phase
- type ProjCols
- type ProjExpr
- type Projection
- func (p *Projection) AddColumn(ctx *plancontext.PlanningContext, reuse bool, addToGroupBy bool, ...) (int, error)
- func (p *Projection) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (p *Projection) AllOffsets() (cols []int)
- func (p *Projection) Clone(inputs []ops.Operator) ops.Operator
- func (p *Projection) Compact(ctx *plancontext.PlanningContext) (ops.Operator, *rewrite.ApplyResult, error)
- func (p *Projection) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (p *Projection) GetAliasedProjections() (AliasedProjections, error)
- func (p *Projection) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (p *Projection) GetOrdering() ([]ops.OrderBy, error)
- func (p *Projection) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (p *Projection) Inputs() []ops.Operator
- func (p *Projection) SetInputs(operators []ops.Operator)
- func (p *Projection) ShortDescription() string
- type QueryGraph
- func (QueryGraph) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (qg *QueryGraph) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (qg *QueryGraph) Clone([]ops.Operator) ops.Operator
- func (QueryGraph) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (QueryGraph) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (qg *QueryGraph) GetOrdering() ([]ops.OrderBy, error)
- func (qg *QueryGraph) GetPredicates(lhs, rhs semantics.TableSet) []sqlparser.Expr
- func (QueryGraph) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (QueryGraph) Inputs() []ops.Operator
- func (QueryGraph) SetInputs(ops []ops.Operator)
- func (qg *QueryGraph) ShortDescription() string
- func (qg *QueryGraph) UnsolvedPredicates(_ *semantics.SemTable) []sqlparser.Expr
- type QueryProjection
- func (qp *QueryProjection) AddGroupBy(by GroupBy)
- func (qp *QueryProjection) AggrRewriter(ctx *plancontext.PlanningContext) *AggrRewriter
- func (qp *QueryProjection) AggregationExpressions(ctx *plancontext.PlanningContext, allowComplexExpression bool) (out []Aggr, complex bool, err error)
- func (qp *QueryProjection) AlignGroupByAndOrderBy(ctx *plancontext.PlanningContext) bool
- func (qp *QueryProjection) FindSelectExprIndexForExpr(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (*int, *sqlparser.AliasedExpr)
- func (qp *QueryProjection) GetColumnCount() int
- func (qp *QueryProjection) GetGrouping() []GroupBy
- func (qp *QueryProjection) NeedsAggregation() bool
- func (qp *QueryProjection) NeedsDistinct() bool
- func (qp *QueryProjection) NeedsProjecting(ctx *plancontext.PlanningContext, ...) (needsVtGateEval bool, expressions []sqlparser.Expr, colNames []string, ...)
- type QueryTable
- type Route
- func (r *Route) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ...) (int, error)
- func (r *Route) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (r *Route) Clone(inputs []ops.Operator) ops.Operator
- func (r *Route) Cost() int
- func (r *Route) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, _ bool) (int, error)
- func (r *Route) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (r *Route) GetOrdering() ([]ops.OrderBy, error)
- func (r *Route) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (r *Route) Inputs() []ops.Operator
- func (r *Route) IsSingleShard() bool
- func (r *Route) SetInputs(ops []ops.Operator)
- func (r *Route) ShortDescription() string
- func (r *Route) TablesUsed() []string
- type RouteOrdering
- type Routing
- type SelectExpr
- type SequenceRouting
- func (sr *SequenceRouting) Clone() Routing
- func (sr *SequenceRouting) Cost() int
- func (sr *SequenceRouting) Keyspace() *vindexes.Keyspace
- func (sr *SequenceRouting) OpCode() engine.Opcode
- func (sr *SequenceRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
- type SetExpr
- type ShardedRouting
- func (tr *ShardedRouting) Clone() Routing
- func (tr *ShardedRouting) Cost() int
- func (tr *ShardedRouting) Keyspace() *vindexes.Keyspace
- func (tr *ShardedRouting) OpCode() engine.Opcode
- func (tr *ShardedRouting) PickBestAvailableVindex()
- func (tr *ShardedRouting) SelectedVindex() vindexes.Vindex
- func (tr *ShardedRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
- func (tr *ShardedRouting) VindexExpressions() []sqlparser.Expr
- type StarProjections
- type SubQuery
- func (sq *SubQuery) AddColumn(ctx *plancontext.PlanningContext, reuseExisting bool, addToGroupBy bool, ...) (int, error)
- func (sq *SubQuery) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (sq *SubQuery) Clone(inputs []ops.Operator) ops.Operator
- func (sq *SubQuery) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (sq *SubQuery) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (sq *SubQuery) GetJoinColumns(ctx *plancontext.PlanningContext, outer ops.Operator) ([]JoinColumn, error)
- func (sq *SubQuery) GetMergePredicates() []sqlparser.Expr
- func (sq *SubQuery) GetOrdering() ([]ops.OrderBy, error)
- func (sq *SubQuery) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (sq *SubQuery) Inputs() []ops.Operator
- func (sq *SubQuery) OuterExpressionsNeeded(ctx *plancontext.PlanningContext, outer ops.Operator) (result []*sqlparser.ColName, err error)
- func (sq *SubQuery) SetInputs(inputs []ops.Operator)
- func (sq *SubQuery) ShortDescription() string
- type SubQueryBuilder
- type SubQueryContainer
- func (sqc *SubQueryContainer) AddColumn(ctx *plancontext.PlanningContext, reuseExisting bool, addToGroupBy bool, ...) (int, error)
- func (sqc *SubQueryContainer) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (sqc *SubQueryContainer) Clone(inputs []ops.Operator) ops.Operator
- func (sqc *SubQueryContainer) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (sqc *SubQueryContainer) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (sqc *SubQueryContainer) GetOrdering() ([]ops.OrderBy, error)
- func (sqc *SubQueryContainer) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (sqc *SubQueryContainer) Inputs() []ops.Operator
- func (sqc *SubQueryContainer) SetInputs(ops []ops.Operator)
- func (sqc *SubQueryContainer) ShortDescription() string
- type SubQueryExpression
- type Table
- func (to *Table) AddCol(col *sqlparser.ColName)
- func (to *Table) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (to *Table) AddPredicate(_ *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (to *Table) Clone([]ops.Operator) ops.Operator
- func (to *Table) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (to *Table) GetColNames() []*sqlparser.ColName
- func (to *Table) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (to *Table) GetOrdering() ([]ops.OrderBy, error)
- func (to *Table) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (Table) Inputs() []ops.Operator
- func (Table) SetInputs(ops []ops.Operator)
- func (to *Table) ShortDescription() string
- func (to *Table) TablesUsed() []string
- type TableUser
- type TargetedRouting
- func (tr *TargetedRouting) Clone() Routing
- func (tr *TargetedRouting) Cost() int
- func (tr *TargetedRouting) Keyspace() *vindexes.Keyspace
- func (tr *TargetedRouting) OpCode() engine.Opcode
- func (tr *TargetedRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
- type Union
- func (u *Union) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ...) (int, error)
- func (u *Union) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (u *Union) Clone(inputs []ops.Operator) ops.Operator
- func (u *Union) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (u *Union) GetColumns(ctx *plancontext.PlanningContext) (result []*sqlparser.AliasedExpr, err error)
- func (u *Union) GetOrdering() ([]ops.OrderBy, error)
- func (u *Union) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (u *Union) GetSelectFor(source int) (*sqlparser.Select, error)
- func (u *Union) Inputs() []ops.Operator
- func (u *Union) NoLHSTableSet()
- func (u *Union) SetInputs(ops []ops.Operator)
- func (u *Union) ShortDescription() string
- type Update
- func (Update) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
- func (Update) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
- func (u *Update) Clone([]ops.Operator) ops.Operator
- func (Update) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
- func (Update) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (u *Update) GetOrdering() ([]ops.OrderBy, error)
- func (Update) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (Update) Inputs() []ops.Operator
- func (Update) SetInputs(ops []ops.Operator)
- func (u *Update) ShortDescription() string
- func (u *Update) TablesUsed() []string
- type VerifyOp
- type Vindex
- func (v *Vindex) AddCol(col *sqlparser.ColName)
- func (v *Vindex) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ...) (int, error)
- func (v *Vindex) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
- func (v *Vindex) CheckValid() error
- func (v *Vindex) Clone([]ops.Operator) ops.Operator
- func (v *Vindex) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
- func (v *Vindex) GetColNames() []*sqlparser.ColName
- func (v *Vindex) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
- func (v *Vindex) GetOrdering() ([]ops.OrderBy, error)
- func (v *Vindex) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
- func (Vindex) Inputs() []ops.Operator
- func (Vindex) SetInputs(ops []ops.Operator)
- func (v *Vindex) ShortDescription() string
- func (v *Vindex) TablesUsed() []string
- type VindexOption
- type VindexPlusPredicates
- type VindexTable
Constants ¶
const VindexUnsupported = "WHERE clause for vindex function must be of the form id = <val> or id in(<val>,...)"
Variables ¶
This section is empty.
Functions ¶
func AddPredicate ¶
func CompareRefInt ¶
CompareRefInt compares two references of integers. In case either one is nil, it is considered to be smaller
func IsTableSchemaOrName ¶ added in v0.17.0
func NotImplementedSchemaInfoResolver ¶ added in v0.17.0
func PlanQuery ¶
func PlanQuery(ctx *plancontext.PlanningContext, stmt sqlparser.Statement) (ops.Operator, error)
PlanQuery creates a query plan for a given SQL statement
func QualifiedIdentifier ¶
func QualifiedIdentifier(ks *vindexes.Keyspace, i sqlparser.IdentifierCS) string
func QualifiedTableName ¶
func QualifiedTableNames ¶
func RemovePredicate ¶
func RemovePredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr, op ops.Operator) (ops.Operator, error)
RemovePredicate is used when we turn a predicate into a plan operator, and the predicate needs to be removed as an AST construct
func SingleQualifiedIdentifier ¶
func SingleQualifiedIdentifier(ks *vindexes.Keyspace, i sqlparser.IdentifierCS) []string
func TablesUsed ¶
Types ¶
type Aggr ¶
type Aggr struct { Original *sqlparser.AliasedExpr Func sqlparser.AggrFunc OpCode opcode.AggregateOpcode // OriginalOpCode will contain opcode.AggregateUnassigned unless we are changing opcode while pushing them down OriginalOpCode opcode.AggregateOpcode Alias string // The index at which the user expects to see this aggregated function. Set to nil, if the user does not ask for it // Only used in the old Horizon Planner Index *int Distinct bool // the offsets point to columns on the same aggregator ColOffset int WSOffset int SubQueryExpression []*SubQuery }
Aggr encodes all information needed for aggregation functions
func NewAggr ¶ added in v0.17.0
func NewAggr(opCode opcode.AggregateOpcode, f sqlparser.AggrFunc, original *sqlparser.AliasedExpr, alias string) Aggr
func (Aggr) GetTypeCollation ¶ added in v0.17.2
func (aggr Aggr) GetTypeCollation(ctx *plancontext.PlanningContext) (sqltypes.Type, collations.ID)
func (Aggr) NeedsWeightString ¶ added in v0.18.0
func (aggr Aggr) NeedsWeightString(ctx *plancontext.PlanningContext) bool
type AggrRewriter ¶
type AggrRewriter struct { Err error // contains filtered or unexported fields }
func (*AggrRewriter) RewriteDown ¶
RewriteDown stops the walker from entering inside aggregation functions
type Aggregator ¶ added in v0.17.0
type Aggregator struct { Source ops.Operator Columns []*sqlparser.AliasedExpr Grouping []GroupBy Aggregations []Aggr // We support a single distinct aggregation per aggregator. It is stored here. // When planning the ordering that the OrderedAggregate will require, // this needs to be the last ORDER BY expression DistinctExpr sqlparser.Expr // Pushed will be set to true once this aggregation has been pushed deeper in the tree Pushed bool // Original will only be true for the original aggregator created from the AST Original bool ResultColumns int QP *QueryProjection DT *DerivedTable // contains filtered or unexported fields }
Aggregator represents a GroupBy γ relational operator. Both all aggregations and no grouping, and the inverse of all grouping and no aggregations are valid configurations of this operator
func (*Aggregator) AddColumn ¶ added in v0.17.0
func (a *Aggregator) AddColumn(ctx *plancontext.PlanningContext, reuse bool, groupBy bool, ae *sqlparser.AliasedExpr) (int, error)
func (*Aggregator) AddPredicate ¶ added in v0.17.0
func (a *Aggregator) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Aggregator) Clone ¶ added in v0.17.0
func (a *Aggregator) Clone(inputs []ops.Operator) ops.Operator
func (*Aggregator) FindCol ¶ added in v0.18.0
func (a *Aggregator) FindCol(ctx *plancontext.PlanningContext, in sqlparser.Expr, underRoute bool) (int, error)
func (*Aggregator) GetColumns ¶ added in v0.17.0
func (a *Aggregator) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Aggregator) GetOrdering ¶ added in v0.17.0
func (a *Aggregator) GetOrdering() ([]ops.OrderBy, error)
func (*Aggregator) GetSelectExprs ¶ added in v0.18.0
func (a *Aggregator) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Aggregator) Inputs ¶ added in v0.17.0
func (a *Aggregator) Inputs() []ops.Operator
func (*Aggregator) SetInputs ¶ added in v0.17.0
func (a *Aggregator) SetInputs(operators []ops.Operator)
func (*Aggregator) ShortDescription ¶ added in v0.17.0
func (a *Aggregator) ShortDescription() string
func (*Aggregator) SplitAggregatorBelowRoute ¶ added in v0.18.0
func (a *Aggregator) SplitAggregatorBelowRoute(input []ops.Operator) *Aggregator
SplitAggregatorBelowRoute returns the aggregator that will live under the Route. This is used when we are splitting the aggregation so one part is done at the mysql level and one part at the vtgate level
type AliasedProjections ¶ added in v0.18.0
type AliasedProjections []*ProjExpr
Used when we know all the columns
func (AliasedProjections) AddColumn ¶ added in v0.18.0
func (ap AliasedProjections) AddColumn(col *sqlparser.AliasedExpr) (ProjCols, int, error)
func (AliasedProjections) GetColumns ¶ added in v0.18.0
func (ap AliasedProjections) GetColumns() ([]*sqlparser.AliasedExpr, error)
func (AliasedProjections) GetSelectExprs ¶ added in v0.18.0
func (ap AliasedProjections) GetSelectExprs() sqlparser.SelectExprs
type AnyShardRouting ¶ added in v0.17.0
type AnyShardRouting struct { Alternates map[*vindexes.Keyspace]*Route // contains filtered or unexported fields }
AnyShardRouting is used for routing logic where any shard in the keyspace can be used. Shared by unsharded and reference routing
func (*AnyShardRouting) AlternateInKeyspace ¶ added in v0.17.0
func (rr *AnyShardRouting) AlternateInKeyspace(keyspace *vindexes.Keyspace) *Route
func (*AnyShardRouting) Clone ¶ added in v0.17.0
func (rr *AnyShardRouting) Clone() Routing
func (*AnyShardRouting) Cost ¶ added in v0.17.0
func (rr *AnyShardRouting) Cost() int
func (*AnyShardRouting) Keyspace ¶ added in v0.17.0
func (rr *AnyShardRouting) Keyspace() *vindexes.Keyspace
func (*AnyShardRouting) OpCode ¶ added in v0.17.0
func (rr *AnyShardRouting) OpCode() engine.Opcode
func (*AnyShardRouting) UpdateRoutingParams ¶ added in v0.17.0
func (rr *AnyShardRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
type ApplyJoin ¶
type ApplyJoin struct {
LHS, RHS ops.Operator
// LeftJoin will be true in the case of an outer join
LeftJoin bool
// Before offset planning
Predicate sqlparser.Expr
// JoinColumns keeps track of what AST expression is represented in the Columns array
JoinColumns []JoinColumn
// JoinPredicates are join predicates that have been broken up into left hand side and right hand side parts.
JoinPredicates []JoinColumn
// ExtraVars are columns we need to copy from left to right not needed by any predicates or projections,
// these are needed by other operators further down the right hand side of the join
ExtraLHSVars []BindVarExpr
// Columns stores the column indexes of the columns coming from the left and right side
// negative value comes from LHS and positive from RHS
Columns []int
// Vars are the arguments that need to be copied from the LHS to the RHS
Vars map[string]int
}
ApplyJoin is a nested loop join - for each row on the LHS, we'll execute the plan on the RHS, feeding data from left to right
func NewApplyJoin ¶
func (*ApplyJoin) AddColumn ¶
func (aj *ApplyJoin) AddColumn( ctx *plancontext.PlanningContext, reuse bool, groupBy bool, expr *sqlparser.AliasedExpr, ) (int, error)
func (*ApplyJoin) AddJoinPredicate ¶
func (aj *ApplyJoin) AddJoinPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) error
func (*ApplyJoin) AddPredicate ¶
func (aj *ApplyJoin) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*ApplyJoin) FindCol ¶ added in v0.18.0
func (aj *ApplyJoin) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, _ bool) (int, error)
func (*ApplyJoin) GetColumns ¶ added in v0.17.0
func (aj *ApplyJoin) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*ApplyJoin) GetOrdering ¶ added in v0.17.0
func (*ApplyJoin) GetSelectExprs ¶ added in v0.18.0
func (aj *ApplyJoin) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*ApplyJoin) LHSColumnsNeeded ¶ added in v0.18.0
func (a *ApplyJoin) LHSColumnsNeeded(ctx *plancontext.PlanningContext) (needed sqlparser.Exprs)
func (*ApplyJoin) ShortDescription ¶ added in v0.17.0
type BindVarExpr ¶ added in v0.18.0
BindVarExpr is an expression needed from one side of a join/subquery, and the argument name for it. TODO: Do we really need to store the name here? it could be found in the semantic state instead
func (BindVarExpr) String ¶ added in v0.18.0
func (bve BindVarExpr) String() string
type ColNameColumns ¶
type Delete ¶
type Delete struct { QTable *QueryTable VTable *vindexes.Table OwnedVindexQuery string AST *sqlparser.Delete // contains filtered or unexported fields }
func (Delete) AddColumn ¶
func (Delete) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (Delete) AddPredicate ¶
func (Delete) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
AddPredicate implements the Operator interface
func (Delete) FindCol ¶ added in v0.18.0
func (Delete) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (Delete) GetColumns ¶ added in v0.17.0
func (Delete) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (Delete) GetSelectExprs ¶ added in v0.18.0
func (Delete) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Delete) ShortDescription ¶ added in v0.17.0
func (*Delete) TablesUsed ¶
type DerivedTable ¶ added in v0.18.0
func (*DerivedTable) RewriteExpression ¶ added in v0.18.0
func (dt *DerivedTable) RewriteExpression(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (sqlparser.Expr, error)
func (*DerivedTable) String ¶ added in v0.18.0
func (dt *DerivedTable) String() string
type Distinct ¶ added in v0.17.0
type Distinct struct { Source ops.Operator QP *QueryProjection // When we go from AST to operator, we place DISTINCT ops in the required places in the op tree // These are marked as `Required`, because they are semantically important to the results of the query. // During planning, when we can't push down the DISTINCT op any further, we sometimes create and push down // additional DISTINCT ops that are not strictly required, but that limit the number of incoming rows so less // work has to be done. When we have pushed down these performance DISTINCTs, we set the `PushedPerformance` // field to true on the originating op Required bool PushedPerformance bool // This is only filled in during offset planning Columns []engine.CheckCol Truncate int }
func (*Distinct) AddColumn ¶ added in v0.17.0
func (d *Distinct) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, expr *sqlparser.AliasedExpr) (int, error)
func (*Distinct) AddPredicate ¶ added in v0.17.0
func (d *Distinct) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Distinct) FindCol ¶ added in v0.18.0
func (d *Distinct) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Distinct) GetColumns ¶ added in v0.17.0
func (d *Distinct) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Distinct) GetOrdering ¶ added in v0.17.0
func (*Distinct) GetSelectExprs ¶ added in v0.18.0
func (d *Distinct) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Distinct) ShortDescription ¶ added in v0.17.0
type DualRouting ¶ added in v0.17.0
type DualRouting struct{}
DualRouting represents the dual-table. It is special compared to all other tables because it can be merged with tables in any keyspace
func (*DualRouting) Clone ¶ added in v0.17.0
func (dr *DualRouting) Clone() Routing
func (*DualRouting) Cost ¶ added in v0.17.0
func (dr *DualRouting) Cost() int
func (*DualRouting) Keyspace ¶ added in v0.17.0
func (dr *DualRouting) Keyspace() *vindexes.Keyspace
func (*DualRouting) OpCode ¶ added in v0.17.0
func (dr *DualRouting) OpCode() engine.Opcode
func (*DualRouting) UpdateRoutingParams ¶ added in v0.17.0
func (dr *DualRouting) UpdateRoutingParams(*plancontext.PlanningContext, *engine.RoutingParameters) error
type EvalEngine ¶ added in v0.18.0
type EvalEngine struct {
EExpr evalengine.Expr
}
EvalEngine is used for expressions that have to be evaluated in the vtgate using the evalengine
type ExprInfo ¶ added in v0.18.0
type ExprInfo interface {
// contains filtered or unexported methods
}
type Filter ¶
type Filter struct { Source ops.Operator Predicates []sqlparser.Expr // PredicateWithOffsets is the evalengine expression that will finally be used. // It contains the ANDed predicates in Predicates, with ColName:s replaced by Offset:s PredicateWithOffsets evalengine.Expr Truncate int }
func (*Filter) AddColumn ¶
func (f *Filter) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, expr *sqlparser.AliasedExpr) (int, error)
func (*Filter) AddPredicate ¶
func (f *Filter) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Filter) Compact ¶
func (f *Filter) Compact(*plancontext.PlanningContext) (ops.Operator, *rewrite.ApplyResult, error)
func (*Filter) FindCol ¶ added in v0.18.0
func (f *Filter) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Filter) GetColumns ¶ added in v0.17.0
func (f *Filter) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Filter) GetSelectExprs ¶ added in v0.18.0
func (f *Filter) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Filter) ShortDescription ¶ added in v0.17.0
type FkCascade ¶ added in v0.18.0
type FkCascade struct { Selection ops.Operator Children []*FkChild Parent ops.Operator // contains filtered or unexported fields }
FkCascade is used to represent a foreign key cascade operation as an operator. This operator is created for DML queries that require cascades (for example, ON DELETE CASCADE).
func (FkCascade) AddColumn ¶ added in v0.18.0
func (FkCascade) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (FkCascade) AddPredicate ¶ added in v0.18.0
func (FkCascade) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
AddPredicate implements the Operator interface
func (FkCascade) FindCol ¶ added in v0.18.0
func (FkCascade) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (FkCascade) GetColumns ¶ added in v0.18.0
func (FkCascade) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*FkCascade) GetOrdering ¶ added in v0.18.0
GetOrdering implements the Operator interface
func (FkCascade) GetSelectExprs ¶ added in v0.18.0
func (FkCascade) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*FkCascade) ShortDescription ¶ added in v0.18.0
ShortDescription implements the Operator interface
type FkChild ¶ added in v0.18.0
type FkChild struct { BVName string Cols []int // indexes Op ops.Operator // contains filtered or unexported fields }
FkChild is used to represent a foreign key child table operation
func (FkChild) AddColumn ¶ added in v0.18.0
func (FkChild) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (FkChild) AddPredicate ¶ added in v0.18.0
func (FkChild) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
AddPredicate implements the Operator interface
func (FkChild) FindCol ¶ added in v0.18.0
func (FkChild) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (FkChild) GetColumns ¶ added in v0.18.0
func (FkChild) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (FkChild) GetSelectExprs ¶ added in v0.18.0
func (FkChild) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
type FkVerify ¶ added in v0.18.0
type FkVerify struct { Verify []*VerifyOp Input ops.Operator // contains filtered or unexported fields }
FkVerify is used to represent a foreign key verification operation as an operator. This operator is created for DML queries that require verifications on the existence of the rows in the parent table (for example, INSERT and UPDATE).
func (FkVerify) AddColumn ¶ added in v0.18.0
func (FkVerify) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (FkVerify) AddPredicate ¶ added in v0.18.0
func (FkVerify) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
AddPredicate implements the Operator interface
func (FkVerify) FindCol ¶ added in v0.18.0
func (FkVerify) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (FkVerify) GetColumns ¶ added in v0.18.0
func (FkVerify) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*FkVerify) GetOrdering ¶ added in v0.18.0
GetOrdering implements the Operator interface
func (FkVerify) GetSelectExprs ¶ added in v0.18.0
func (FkVerify) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*FkVerify) ShortDescription ¶ added in v0.18.0
ShortDescription implements the Operator interface
type Generate ¶ added in v0.17.0
type Generate struct { // Keyspace represents the keyspace information for the table. Keyspace *vindexes.Keyspace // TableName represents the name of the table. TableName sqlparser.TableName // Values are the supplied values for the column, which // will be stored as a list within the expression. New // values will be generated based on how many were not // supplied (NULL). Values evalengine.Expr // Insert using Select, offset for auto increment column Offset int // contains filtered or unexported fields }
Generate represents an auto-increment generator for the insert operation.
type GroupBy ¶
type GroupBy struct { Inner sqlparser.Expr // The simplified expressions is the "unaliased expression". // In the following query, the group by has the inner expression // `x` and the `SimplifiedExpr` is `table.col + 10`: // select table.col + 10 as x, count(*) from tbl group by x SimplifiedExpr sqlparser.Expr // The index at which the user expects to see this column. Set to nil, if the user does not ask for it InnerIndex *int // points to the column on the same aggregator ColOffset int WSOffset int // contains filtered or unexported fields }
GroupBy contains the expression to used in group by and also if grouping is needed at VTGate level then what the weight_string function expression to be sent down for evaluation.
func NewGroupBy ¶ added in v0.17.0
func NewGroupBy(inner, simplified sqlparser.Expr, aliasedExpr *sqlparser.AliasedExpr) GroupBy
NewGroupBy creates a new group by from the given fields.
func (GroupBy) AsAliasedExpr ¶
func (b GroupBy) AsAliasedExpr() *sqlparser.AliasedExpr
type Horizon ¶
type Horizon struct { Source ops.Operator // If this is a derived table, the two following fields will contain the tableID and name of it TableId *semantics.TableSet Alias string ColumnAliases sqlparser.Columns // derived tables can have their column aliases specified outside the subquery // QP contains the QueryProjection for this op QP *QueryProjection Query sqlparser.SelectStatement // Columns needed to feed other plans Columns []*sqlparser.ColName ColumnsOffset []int }
Horizon is an operator that allows us to postpone planning things like SELECT/GROUP BY/ORDER BY/LIMIT until later. It contains information about the planning we have to do after deciding how we will send the query to the tablets. If we are able to push down the Horizon under a route, we don't have to plan these things separately and can just copy over the AST constructs to the query being sent to a tablet. If we are not able to push it down, this operator needs to be split up into smaller Project/Aggregate/Sort/Limit operations, some which can be pushed down, and some that have to be evaluated at the vtgate level.
func (*Horizon) AddColumn ¶
func (h *Horizon) AddColumn(ctx *plancontext.PlanningContext, reuse bool, _ bool, expr *sqlparser.AliasedExpr) (int, error)
func (*Horizon) AddPredicate ¶
func (h *Horizon) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Horizon) FindCol ¶ added in v0.18.0
func (h *Horizon) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Horizon) GetColumns ¶ added in v0.17.0
func (h *Horizon) GetColumns(ctx *plancontext.PlanningContext) (exprs []*sqlparser.AliasedExpr, err error)
func (*Horizon) GetOrdering ¶ added in v0.17.0
func (*Horizon) GetSelectExprs ¶ added in v0.18.0
func (h *Horizon) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Horizon) IsMergeable ¶ added in v0.18.0
func (h *Horizon) IsMergeable(ctx *plancontext.PlanningContext) bool
IsMergeable is not a great name for this function. Suggestions for a better one are welcome! This function will return false if the derived table inside it has to run on the vtgate side, and so can't be merged with subqueries This logic can also be used to check if this is a derived table that can be had on the left hand side of a vtgate join. Since vtgate joins are always nested loop joins, we can't execute them on the RHS if they do some things, like LIMIT or GROUP BY on wrong columns
func (*Horizon) ShortDescription ¶ added in v0.17.0
type InfoSchemaRouting ¶ added in v0.17.0
type InfoSchemaRouting struct { SysTableTableSchema []sqlparser.Expr SysTableTableName map[string]sqlparser.Expr Table *QueryTable }
InfoSchemaRouting used for information_schema queries. They are special because we usually don't know at plan-time what keyspace the query go to, because we don't see normalized literal values
func (*InfoSchemaRouting) Clone ¶ added in v0.17.0
func (isr *InfoSchemaRouting) Clone() Routing
func (*InfoSchemaRouting) Cost ¶ added in v0.17.0
func (isr *InfoSchemaRouting) Cost() int
func (*InfoSchemaRouting) Keyspace ¶ added in v0.17.0
func (isr *InfoSchemaRouting) Keyspace() *vindexes.Keyspace
func (*InfoSchemaRouting) OpCode ¶ added in v0.17.0
func (isr *InfoSchemaRouting) OpCode() engine.Opcode
func (*InfoSchemaRouting) UpdateRoutingParams ¶ added in v0.17.0
func (isr *InfoSchemaRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
type Insert ¶ added in v0.17.0
type Insert struct { // VTable represents the target table for the insert operation. VTable *vindexes.Table // AST represents the insert statement from the SQL syntax. AST *sqlparser.Insert // AutoIncrement represents the auto-increment generator for the insert operation. AutoIncrement *Generate // Ignore specifies whether to ignore duplicate key errors during insertion. Ignore bool // ForceNonStreaming when true, select first then insert, this is to avoid locking rows by select for insert. ForceNonStreaming bool // ColVindexes are the vindexes that will use the VindexValues or VindexValueOffset ColVindexes []*vindexes.ColumnVindex // VindexValues specifies values for all the vindex columns. VindexValues [][][]evalengine.Expr // VindexValueOffset stores the offset for each column in the ColumnVindex // that will appear in the result set of the select query. VindexValueOffset [][]int // Insert using select query will have select plan as input operator for the insert operation. Input ops.Operator // contains filtered or unexported fields }
Insert represents an insert operation on a table.
func (Insert) AddColumn ¶ added in v0.17.0
func (Insert) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (Insert) AddPredicate ¶ added in v0.17.0
func (Insert) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
AddPredicate implements the Operator interface
func (Insert) FindCol ¶ added in v0.18.0
func (Insert) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (Insert) GetColumns ¶ added in v0.17.0
func (Insert) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (Insert) GetSelectExprs ¶ added in v0.18.0
func (Insert) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Insert) ShortDescription ¶ added in v0.17.0
func (*Insert) TablesUsed ¶ added in v0.17.0
type Join ¶
type Join struct {
LHS, RHS ops.Operator
Predicate sqlparser.Expr
LeftJoin bool
// contains filtered or unexported fields
}
Join represents a join. If we have a predicate, this is an inner join. If no predicate exists, it is a cross join
func (Join) AddColumn ¶
func (Join) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (*Join) AddJoinPredicate ¶
func (j *Join) AddJoinPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) error
func (*Join) AddPredicate ¶
func (j *Join) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Join) Compact ¶
func (j *Join) Compact(ctx *plancontext.PlanningContext) (ops.Operator, *rewrite.ApplyResult, error)
func (Join) FindCol ¶ added in v0.18.0
func (Join) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (Join) GetColumns ¶ added in v0.17.0
func (Join) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (Join) GetSelectExprs ¶ added in v0.18.0
func (Join) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Join) ShortDescription ¶ added in v0.17.0
type JoinColumn ¶ added in v0.17.0
type JoinColumn struct { Original *sqlparser.AliasedExpr // this is the original expression being passed through LHSExprs []BindVarExpr RHSExpr sqlparser.Expr GroupBy bool // if this is true, we need to push this down to our inputs with addToGroupBy set to true }
JoinColumn is where we store information about columns passing through the join operator It can be in one of three possible configurations:
- Pure left We are projecting a column that comes from the left. The RHSExpr will be nil for these
- Pure right We are projecting a column that comes from the right. The LHSExprs will be empty for these
- Mix of data from left and right Here we need to transmit columns from the LHS to the RHS, so they can be used for the result of this expression that is using data from both sides. All fields will be used for these
func BreakExpressionInLHSandRHS ¶
func BreakExpressionInLHSandRHS( ctx *plancontext.PlanningContext, expr sqlparser.Expr, lhs semantics.TableSet, ) (col JoinColumn, err error)
BreakExpressionInLHSandRHS takes an expression and extracts the parts that are coming from one of the sides into `ColName`s that are needed
func (JoinColumn) IsMixedLeftAndRight ¶ added in v0.17.0
func (jc JoinColumn) IsMixedLeftAndRight() bool
func (JoinColumn) IsPureLeft ¶ added in v0.17.0
func (jc JoinColumn) IsPureLeft() bool
func (JoinColumn) IsPureRight ¶ added in v0.17.0
func (jc JoinColumn) IsPureRight() bool
type Limit ¶ added in v0.17.0
type Limit struct { Source ops.Operator AST *sqlparser.Limit // Pushed marks whether the limit has been pushed down to the inputs but still need to keep the operator around. // For example, `select * from user order by id limit 10`. Even after we push the limit to the route, we need a limit on top // since it is a scatter. Pushed bool }
func (*Limit) AddColumn ¶ added in v0.17.0
func (l *Limit) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, expr *sqlparser.AliasedExpr) (int, error)
func (*Limit) AddPredicate ¶ added in v0.17.0
func (l *Limit) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Limit) FindCol ¶ added in v0.18.0
func (l *Limit) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Limit) GetColumns ¶ added in v0.17.0
func (l *Limit) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Limit) GetSelectExprs ¶ added in v0.18.0
func (l *Limit) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Limit) ShortDescription ¶ added in v0.17.0
type LockAndComment ¶ added in v0.18.0
type LockAndComment struct { Source ops.Operator Comments *sqlparser.ParsedComments Lock sqlparser.Lock }
LockAndComment contains any comments or locking directives we want on all queries down from this operator
func (*LockAndComment) AddColumn ¶ added in v0.18.0
func (l *LockAndComment) AddColumn(ctx *plancontext.PlanningContext, reuseExisting bool, addToGroupBy bool, expr *sqlparser.AliasedExpr) (int, error)
func (*LockAndComment) AddPredicate ¶ added in v0.18.0
func (l *LockAndComment) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*LockAndComment) Clone ¶ added in v0.18.0
func (l *LockAndComment) Clone(inputs []ops.Operator) ops.Operator
func (*LockAndComment) FindCol ¶ added in v0.18.0
func (l *LockAndComment) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*LockAndComment) GetColumns ¶ added in v0.18.0
func (l *LockAndComment) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*LockAndComment) GetOrdering ¶ added in v0.18.0
func (l *LockAndComment) GetOrdering() ([]ops.OrderBy, error)
func (*LockAndComment) GetSelectExprs ¶ added in v0.18.0
func (l *LockAndComment) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*LockAndComment) Inputs ¶ added in v0.18.0
func (l *LockAndComment) Inputs() []ops.Operator
func (*LockAndComment) SetInputs ¶ added in v0.18.0
func (l *LockAndComment) SetInputs(operators []ops.Operator)
func (*LockAndComment) ShortDescription ¶ added in v0.18.0
func (l *LockAndComment) ShortDescription() string
type NoneRouting ¶ added in v0.17.0
type NoneRouting struct {
// contains filtered or unexported fields
}
NoneRouting is used when we know that this Route will return no results. Can be merged with any other route going to the same keyspace
func (*NoneRouting) Clone ¶ added in v0.17.0
func (n *NoneRouting) Clone() Routing
func (*NoneRouting) Cost ¶ added in v0.17.0
func (n *NoneRouting) Cost() int
func (*NoneRouting) Keyspace ¶ added in v0.17.0
func (n *NoneRouting) Keyspace() *vindexes.Keyspace
func (*NoneRouting) OpCode ¶ added in v0.17.0
func (n *NoneRouting) OpCode() engine.Opcode
func (*NoneRouting) UpdateRoutingParams ¶ added in v0.17.0
func (n *NoneRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
type Offset ¶ added in v0.17.0
type Offset int
Offset is used when we are only passing through data from an incoming column
type Ordering ¶ added in v0.17.0
type Ordering struct { Source ops.Operator Offset []int WOffset []int Order []ops.OrderBy ResultColumns int }
func (*Ordering) AddColumn ¶ added in v0.17.0
func (o *Ordering) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, expr *sqlparser.AliasedExpr) (int, error)
func (*Ordering) AddPredicate ¶ added in v0.17.0
func (o *Ordering) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Ordering) FindCol ¶ added in v0.18.0
func (o *Ordering) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Ordering) GetColumns ¶ added in v0.17.0
func (o *Ordering) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Ordering) GetOrdering ¶ added in v0.17.0
func (*Ordering) GetSelectExprs ¶ added in v0.18.0
func (o *Ordering) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Ordering) ShortDescription ¶ added in v0.17.0
type ProjCols ¶ added in v0.18.0
type ProjCols interface { GetColumns() ([]*sqlparser.AliasedExpr, error) GetSelectExprs() sqlparser.SelectExprs AddColumn(*sqlparser.AliasedExpr) (ProjCols, int, error) }
ProjCols is used to enable projections that are only valid if we can push them into a route, and we never need to ask it about offsets
type ProjExpr ¶ added in v0.17.0
type ProjExpr struct { Original *sqlparser.AliasedExpr // this is the expression the user asked for. should only be used to decide on the column alias EvalExpr sqlparser.Expr // EvalExpr is the expression that will be evaluated at runtime ColExpr sqlparser.Expr // ColExpr is used during planning to figure out which column this ProjExpr is representing Info ExprInfo // Here we store information about evalengine, offsets or subqueries }
type Projection ¶ added in v0.17.0
type Projection struct { Source ops.Operator // Columns contain the expressions as viewed from the outside of this operator Columns ProjCols // DT will hold all the necessary information if this is a derived table projection DT *DerivedTable FromAggr bool }
Projection is used when we need to evaluate expressions on the vtgate It uses the evalengine to accomplish its goal
func (*Projection) AddColumn ¶ added in v0.17.0
func (p *Projection) AddColumn(ctx *plancontext.PlanningContext, reuse bool, addToGroupBy bool, ae *sqlparser.AliasedExpr) (int, error)
func (*Projection) AddPredicate ¶ added in v0.17.0
func (p *Projection) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Projection) AllOffsets ¶ added in v0.17.0
func (p *Projection) AllOffsets() (cols []int)
AllOffsets returns a slice of integer offsets for all columns in the Projection if all columns are of type Offset. If any column is not of type Offset, it returns nil.
func (*Projection) Clone ¶ added in v0.17.0
func (p *Projection) Clone(inputs []ops.Operator) ops.Operator
func (*Projection) Compact ¶ added in v0.17.0
func (p *Projection) Compact(ctx *plancontext.PlanningContext) (ops.Operator, *rewrite.ApplyResult, error)
func (*Projection) FindCol ¶ added in v0.18.0
func (p *Projection) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Projection) GetAliasedProjections ¶ added in v0.18.0
func (p *Projection) GetAliasedProjections() (AliasedProjections, error)
func (*Projection) GetColumns ¶ added in v0.17.0
func (p *Projection) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Projection) GetOrdering ¶ added in v0.17.0
func (p *Projection) GetOrdering() ([]ops.OrderBy, error)
func (*Projection) GetSelectExprs ¶ added in v0.18.0
func (p *Projection) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Projection) Inputs ¶ added in v0.17.0
func (p *Projection) Inputs() []ops.Operator
func (*Projection) SetInputs ¶ added in v0.17.0
func (p *Projection) SetInputs(operators []ops.Operator)
func (*Projection) ShortDescription ¶ added in v0.17.0
func (p *Projection) ShortDescription() string
type QueryGraph ¶
type QueryGraph struct { // the Tables, including predicates that only depend on this particular table Tables []*QueryTable // NoDeps contains the predicates that can be evaluated anywhere. NoDeps sqlparser.Expr // contains filtered or unexported fields }
QueryGraph represents the FROM and WHERE parts of a query.
It is an intermediate representation of the query that makes it easier for the planner to find all possible join combinations. Instead of storing the query information in a form that is close to the syntax (AST), we extract the interesting parts into a graph form with the nodes being tables in the FROM clause and the edges between them being predicates. We keep predicates in a hash map keyed by the dependencies of the predicate. This makes it very fast to look up connections between tables in the query.
func (QueryGraph) AddColumn ¶
func (QueryGraph) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (*QueryGraph) AddPredicate ¶
func (qg *QueryGraph) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*QueryGraph) Clone ¶
func (qg *QueryGraph) Clone([]ops.Operator) ops.Operator
Clone implements the Operator interface
func (QueryGraph) FindCol ¶ added in v0.18.0
func (QueryGraph) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (QueryGraph) GetColumns ¶ added in v0.17.0
func (QueryGraph) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*QueryGraph) GetOrdering ¶ added in v0.17.0
func (qg *QueryGraph) GetOrdering() ([]ops.OrderBy, error)
func (*QueryGraph) GetPredicates ¶
func (qg *QueryGraph) GetPredicates(lhs, rhs semantics.TableSet) []sqlparser.Expr
GetPredicates returns the predicates that are applicable for the two given TableSets
func (QueryGraph) GetSelectExprs ¶ added in v0.18.0
func (QueryGraph) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*QueryGraph) ShortDescription ¶ added in v0.17.0
func (qg *QueryGraph) ShortDescription() string
func (*QueryGraph) UnsolvedPredicates ¶
func (qg *QueryGraph) UnsolvedPredicates(_ *semantics.SemTable) []sqlparser.Expr
UnsolvedPredicates implements the unresolved interface
type QueryProjection ¶
type QueryProjection struct { // If you change the contents here, please update the toString() method SelectExprs []SelectExpr HasAggr bool Distinct bool OrderExprs []ops.OrderBy HasStar bool // AddedColumn keeps a counter for expressions added to solve HAVING expressions the user is not selecting AddedColumn int // TODO Remove once all horizon planning is done on the operators CanPushSorting bool // contains filtered or unexported fields }
QueryProjection contains the information about the projections, group by and order by expressions used to do horizon planning.
func CreateQPFromSelectStatement ¶ added in v0.18.0
func CreateQPFromSelectStatement(ctx *plancontext.PlanningContext, stmt sqlparser.SelectStatement) (*QueryProjection, error)
func (*QueryProjection) AddGroupBy ¶
func (qp *QueryProjection) AddGroupBy(by GroupBy)
AddGroupBy does just that
func (*QueryProjection) AggrRewriter ¶
func (qp *QueryProjection) AggrRewriter(ctx *plancontext.PlanningContext) *AggrRewriter
AggrRewriter extracts
func (*QueryProjection) AggregationExpressions ¶
func (qp *QueryProjection) AggregationExpressions(ctx *plancontext.PlanningContext, allowComplexExpression bool) (out []Aggr, complex bool, err error)
func (*QueryProjection) AlignGroupByAndOrderBy ¶
func (qp *QueryProjection) AlignGroupByAndOrderBy(ctx *plancontext.PlanningContext) bool
AlignGroupByAndOrderBy aligns the group by and order by columns, so they are in the same order The GROUP BY clause is a set - the order between the elements does not make any difference, so we can simply re-arrange the column order We are also free to add more ORDER BY columns than the user asked for which we leverage, so the input is already ordered according to the GROUP BY columns used
func (*QueryProjection) FindSelectExprIndexForExpr ¶
func (qp *QueryProjection) FindSelectExprIndexForExpr(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (*int, *sqlparser.AliasedExpr)
FindSelectExprIndexForExpr returns the index of the given expression in the select expressions, if it is part of it returns -1 otherwise.
func (*QueryProjection) GetColumnCount ¶
func (qp *QueryProjection) GetColumnCount() int
func (*QueryProjection) GetGrouping ¶
func (qp *QueryProjection) GetGrouping() []GroupBy
GetGrouping returns a copy of the grouping parameters of the QP
func (*QueryProjection) NeedsAggregation ¶
func (qp *QueryProjection) NeedsAggregation() bool
NeedsAggregation returns true if we either have aggregate functions or grouping defined
func (*QueryProjection) NeedsDistinct ¶
func (qp *QueryProjection) NeedsDistinct() bool
NeedsDistinct returns true if the query needs explicit distinct
func (*QueryProjection) NeedsProjecting ¶ added in v0.16.1
func (qp *QueryProjection) NeedsProjecting( ctx *plancontext.PlanningContext, pusher func(expr *sqlparser.AliasedExpr) (int, error), ) (needsVtGateEval bool, expressions []sqlparser.Expr, colNames []string, err error)
NeedsProjecting returns true if we have projections that need to be evaluated at the vtgate level and can't be pushed down to MySQL
type QueryTable ¶
type QueryTable struct { ID semantics.TableSet Alias *sqlparser.AliasedTableExpr Table sqlparser.TableName Predicates []sqlparser.Expr IsInfSchema bool }
QueryTable is a single FROM table, including all predicates particular to this table This is to be used as an immutable data structure which is created in the logical Operator Tree
func (*QueryTable) Clone ¶
func (qt *QueryTable) Clone() *QueryTable
Clone implements the Operator interface
type Route ¶
type Route struct { Source ops.Operator // Routes that have been merged into this one. MergedWith []*Route Routing Routing Ordering []RouteOrdering Comments *sqlparser.ParsedComments Lock sqlparser.Lock ResultColumns int }
func (*Route) AddColumn ¶
func (r *Route) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, expr *sqlparser.AliasedExpr) (int, error)
func (*Route) AddPredicate ¶
func (r *Route) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Route) FindCol ¶ added in v0.18.0
func (r *Route) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, _ bool) (int, error)
func (*Route) GetColumns ¶ added in v0.17.0
func (r *Route) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Route) GetSelectExprs ¶ added in v0.18.0
func (r *Route) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Route) IsSingleShard ¶
func (*Route) ShortDescription ¶ added in v0.17.0
func (*Route) TablesUsed ¶
TablesUsed returns tables used by MergedWith routes, which are not included in Inputs() and thus not a part of the operator tree
type RouteOrdering ¶ added in v0.17.0
type RouteOrdering struct { AST sqlparser.Expr // Offset and WOffset will contain the offset to the column (and the weightstring column). -1 if it's missing Offset, WOffset int Direction sqlparser.OrderDirection }
type Routing ¶ added in v0.17.0
type Routing interface { // UpdateRoutingParams allows a Routing to control the routing params that will be used by the engine Route // OpCode is already set, and the default keyspace is set for read queries UpdateRoutingParams(ctx *plancontext.PlanningContext, rp *engine.RoutingParameters) error // Clone returns a copy of the routing. Since we are trying different variation of merging, // one Routing can be used in different constellations. // We don't want these different alternatives to influence each other, and cloning allows this Clone() Routing // Cost returns the cost of this Route. Cost() int OpCode() engine.Opcode Keyspace() *vindexes.Keyspace // note that all routings do not have a keyspace, so this method can return nil // contains filtered or unexported methods }
Routing is used for the routing and merging logic of `Route`s. Every Route has a Routing object, and this object is updated when predicates are found, and when merging `Route`s together
func UpdateRoutingLogic ¶ added in v0.17.0
func UpdateRoutingLogic(ctx *plancontext.PlanningContext, expr sqlparser.Expr, r Routing) (Routing, error)
UpdateRoutingLogic first checks if we are dealing with a predicate that
type SelectExpr ¶
type SelectExpr struct { Col sqlparser.SelectExpr Aggr bool }
SelectExpr provides whether the column is aggregation expression or not.
func (SelectExpr) GetAliasedExpr ¶
func (s SelectExpr) GetAliasedExpr() (*sqlparser.AliasedExpr, error)
GetAliasedExpr returns the SelectExpr as a *sqlparser.AliasedExpr if its type allows it, otherwise an error is returned.
type SequenceRouting ¶ added in v0.17.0
type SequenceRouting struct {
// contains filtered or unexported fields
}
func (*SequenceRouting) Clone ¶ added in v0.17.0
func (sr *SequenceRouting) Clone() Routing
func (*SequenceRouting) Cost ¶ added in v0.17.0
func (sr *SequenceRouting) Cost() int
func (*SequenceRouting) Keyspace ¶ added in v0.17.0
func (sr *SequenceRouting) Keyspace() *vindexes.Keyspace
func (*SequenceRouting) OpCode ¶ added in v0.17.0
func (sr *SequenceRouting) OpCode() engine.Opcode
func (*SequenceRouting) UpdateRoutingParams ¶ added in v0.17.0
func (sr *SequenceRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
type ShardedRouting ¶ added in v0.17.0
type ShardedRouting struct { // here we store the possible vindexes we can use so that when we add predicates to the plan, // we can quickly check if the new predicates enables any new vindex Options VindexPreds []*VindexPlusPredicates // the best option available is stored here Selected *VindexOption RouteOpCode engine.Opcode // SeenPredicates contains all the predicates that have had a chance to influence routing. // If we need to replan routing, we'll use this list SeenPredicates []sqlparser.Expr // contains filtered or unexported fields }
ShardedRouting is what we use for all tables that exist in a sharded keyspace It knows about available vindexes and can use them for routing when applicable
func (*ShardedRouting) Clone ¶ added in v0.17.0
func (tr *ShardedRouting) Clone() Routing
func (*ShardedRouting) Cost ¶ added in v0.17.0
func (tr *ShardedRouting) Cost() int
func (*ShardedRouting) Keyspace ¶ added in v0.17.0
func (tr *ShardedRouting) Keyspace() *vindexes.Keyspace
func (*ShardedRouting) OpCode ¶ added in v0.17.0
func (tr *ShardedRouting) OpCode() engine.Opcode
func (*ShardedRouting) PickBestAvailableVindex ¶ added in v0.17.0
func (tr *ShardedRouting) PickBestAvailableVindex()
PickBestAvailableVindex goes over the available vindexes for this route and picks the best one available.
func (*ShardedRouting) SelectedVindex ¶ added in v0.17.0
func (tr *ShardedRouting) SelectedVindex() vindexes.Vindex
func (*ShardedRouting) UpdateRoutingParams ¶ added in v0.17.0
func (tr *ShardedRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
func (*ShardedRouting) VindexExpressions ¶ added in v0.17.0
func (tr *ShardedRouting) VindexExpressions() []sqlparser.Expr
type StarProjections ¶ added in v0.18.0
type StarProjections sqlparser.SelectExprs
Used when there are stars in the expressions that we were unable to expand
func (StarProjections) AddColumn ¶ added in v0.18.0
func (sp StarProjections) AddColumn(*sqlparser.AliasedExpr) (ProjCols, int, error)
func (StarProjections) GetColumns ¶ added in v0.18.0
func (sp StarProjections) GetColumns() ([]*sqlparser.AliasedExpr, error)
func (StarProjections) GetSelectExprs ¶ added in v0.18.0
func (sp StarProjections) GetSelectExprs() sqlparser.SelectExprs
type SubQuery ¶
type SubQuery struct { // Fields filled in at the time of construction: Outer ops.Operator // Outer query operator. Subquery ops.Operator // Subquery operator. FilterType opcode.PulloutOpcode // Type of subquery filter. Original sqlparser.Expr // This is the expression we should use if we can merge the inner to the outer Predicates sqlparser.Exprs // Predicates joining outer and inner queries. Empty for uncorrelated subqueries. OuterPredicate sqlparser.Expr // This is the predicate that is using the subquery expression. It will not be empty for projections ArgName string // This is the name of the ColName or Argument used to replace the subquery TopLevel bool // will be false if the subquery is deeply nested JoinColumns []JoinColumn // Broken up join predicates. SubqueryValueName string // Value name returned by the subquery (uncorrelated queries). HasValuesName string // Argument name passed to the subquery (uncorrelated queries). // Fields related to correlated subqueries: Vars map[string]int // Arguments copied from outer to inner, set during offset planning. IsProjection bool // contains filtered or unexported fields }
SubQuery represents a subquery used for filtering rows in an outer query through a join.
func (*SubQuery) AddColumn ¶
func (sq *SubQuery) AddColumn(ctx *plancontext.PlanningContext, reuseExisting bool, addToGroupBy bool, exprs *sqlparser.AliasedExpr) (int, error)
func (*SubQuery) AddPredicate ¶
func (sq *SubQuery) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*SubQuery) FindCol ¶ added in v0.18.0
func (sq *SubQuery) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*SubQuery) GetColumns ¶ added in v0.17.0
func (sq *SubQuery) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*SubQuery) GetJoinColumns ¶ added in v0.18.0
func (sq *SubQuery) GetJoinColumns(ctx *plancontext.PlanningContext, outer ops.Operator) ([]JoinColumn, error)
func (*SubQuery) GetMergePredicates ¶ added in v0.18.0
GetMergePredicates returns the predicates that we can use to try to merge this subquery with the outer query.
func (*SubQuery) GetOrdering ¶ added in v0.17.0
func (*SubQuery) GetSelectExprs ¶ added in v0.18.0
func (sq *SubQuery) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*SubQuery) OuterExpressionsNeeded ¶ added in v0.18.0
func (sq *SubQuery) OuterExpressionsNeeded(ctx *plancontext.PlanningContext, outer ops.Operator) (result []*sqlparser.ColName, err error)
func (*SubQuery) ShortDescription ¶ added in v0.17.0
type SubQueryBuilder ¶ added in v0.18.0
type SubQueryBuilder struct { Inner []*SubQuery // contains filtered or unexported fields }
type SubQueryContainer ¶ added in v0.18.0
SubQueryContainer stores the information about a query and it's subqueries. The inner subqueries can be executed in any order, so we store them like this so we can see more opportunities for merging
func (*SubQueryContainer) AddColumn ¶ added in v0.18.0
func (sqc *SubQueryContainer) AddColumn(ctx *plancontext.PlanningContext, reuseExisting bool, addToGroupBy bool, exprs *sqlparser.AliasedExpr) (int, error)
func (*SubQueryContainer) AddPredicate ¶ added in v0.18.0
func (sqc *SubQueryContainer) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*SubQueryContainer) Clone ¶ added in v0.18.0
func (sqc *SubQueryContainer) Clone(inputs []ops.Operator) ops.Operator
Clone implements the Operator interface
func (*SubQueryContainer) FindCol ¶ added in v0.18.0
func (sqc *SubQueryContainer) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*SubQueryContainer) GetColumns ¶ added in v0.18.0
func (sqc *SubQueryContainer) GetColumns(ctx *plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*SubQueryContainer) GetOrdering ¶ added in v0.18.0
func (sqc *SubQueryContainer) GetOrdering() ([]ops.OrderBy, error)
func (*SubQueryContainer) GetSelectExprs ¶ added in v0.18.0
func (sqc *SubQueryContainer) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*SubQueryContainer) Inputs ¶ added in v0.18.0
func (sqc *SubQueryContainer) Inputs() []ops.Operator
Inputs implements the Operator interface
func (*SubQueryContainer) SetInputs ¶ added in v0.18.0
func (sqc *SubQueryContainer) SetInputs(ops []ops.Operator)
SetInputs implements the Operator interface
func (*SubQueryContainer) ShortDescription ¶ added in v0.18.0
func (sqc *SubQueryContainer) ShortDescription() string
type SubQueryExpression ¶ added in v0.18.0
type SubQueryExpression []*SubQuery
type Table ¶
type Table struct { QTable *QueryTable VTable *vindexes.Table Columns []*sqlparser.ColName // contains filtered or unexported fields }
func (*Table) AddColumn ¶
func (to *Table) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
func (*Table) AddPredicate ¶
func (to *Table) AddPredicate(_ *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
AddPredicate implements the PhysicalOperator interface
func (*Table) FindCol ¶ added in v0.18.0
func (to *Table) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Table) GetColNames ¶ added in v0.17.0
func (*Table) GetColumns ¶
func (to *Table) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Table) GetSelectExprs ¶ added in v0.18.0
func (to *Table) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Table) ShortDescription ¶ added in v0.17.0
func (*Table) TablesUsed ¶
type TableUser ¶
type TableUser interface {
TablesUsed() []string
}
TableUser is used to signal that this operator directly interacts with one or more tables
type TargetedRouting ¶ added in v0.17.0
type TargetedRouting struct { // targetDestination specifies an explicit target destination tablet type TargetDestination key.Destination // contains filtered or unexported fields }
TargetedRouting is used when the user has used syntax to target the Route against a specific set of shards and/or tablet type. Can't be merged with anything else.
func (*TargetedRouting) Clone ¶ added in v0.17.0
func (tr *TargetedRouting) Clone() Routing
func (*TargetedRouting) Cost ¶ added in v0.17.0
func (tr *TargetedRouting) Cost() int
func (*TargetedRouting) Keyspace ¶ added in v0.17.0
func (tr *TargetedRouting) Keyspace() *vindexes.Keyspace
func (*TargetedRouting) OpCode ¶ added in v0.17.0
func (tr *TargetedRouting) OpCode() engine.Opcode
func (*TargetedRouting) UpdateRoutingParams ¶ added in v0.17.0
func (tr *TargetedRouting) UpdateRoutingParams(_ *plancontext.PlanningContext, rp *engine.RoutingParameters) error
type Union ¶
type Union struct { Sources []ops.Operator // These are the select expressions coming from each source Selects []sqlparser.SelectExprs // contains filtered or unexported fields }
func (*Union) AddColumn ¶
func (u *Union) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, expr *sqlparser.AliasedExpr) (int, error)
func (*Union) AddPredicate ¶
func (u *Union) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
AddPredicate adds a predicate a UNION by pushing the predicate to all sources of the UNION.
this is done by offset and expression rewriting. Say we have a query like so:
select * (
select foo as col, bar from tbl1 union select id, baz from tbl2
) as X where X.col = 42
We want to push down the `X.col = 42` as far down the operator tree as possible. We want to end up with an operator tree that looks something like this:
select * (
select foo as col, bar from tbl1 where foo = 42 union select id, baz from tbl2 where id = 42
) as X
Notice how `X.col = 42` has been translated to `foo = 42` and `id = 42` on respective WHERE clause. The first SELECT of the union dictates the column names, and the second is whatever expression can be found on the same offset. The names of the RHS are discarded.
func (*Union) FindCol ¶ added in v0.18.0
func (u *Union) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Union) GetColumns ¶ added in v0.17.0
func (u *Union) GetColumns(ctx *plancontext.PlanningContext) (result []*sqlparser.AliasedExpr, err error)
func (*Union) GetSelectExprs ¶ added in v0.18.0
func (u *Union) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Union) NoLHSTableSet ¶ added in v0.17.0
func (u *Union) NoLHSTableSet()
func (*Union) ShortDescription ¶ added in v0.17.0
type Update ¶
type Update struct { QTable *QueryTable VTable *vindexes.Table Assignments []SetExpr ChangedVindexValues map[string]*engine.VindexValues OwnedVindexQuery string Ignore sqlparser.Ignore OrderBy sqlparser.OrderBy Limit *sqlparser.Limit // these subqueries cannot be merged as they are part of the changed vindex values // these values are needed to be sent over to lookup vindex for update. // On merging this information will be lost, so subquery merge is blocked. SubQueriesArgOnChangedVindex []string // contains filtered or unexported fields }
func (Update) AddColumn ¶
func (Update) AddColumn(*plancontext.PlanningContext, bool, bool, *sqlparser.AliasedExpr) (int, error)
AddColumn implements the Operator interface
func (Update) AddPredicate ¶
func (Update) AddPredicate(*plancontext.PlanningContext, sqlparser.Expr) (ops.Operator, error)
AddPredicate implements the Operator interface
func (Update) FindCol ¶ added in v0.18.0
func (Update) FindCol(*plancontext.PlanningContext, sqlparser.Expr, bool) (int, error)
func (Update) GetColumns ¶ added in v0.17.0
func (Update) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (Update) GetSelectExprs ¶ added in v0.18.0
func (Update) GetSelectExprs(*plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Update) ShortDescription ¶ added in v0.17.0
func (*Update) TablesUsed ¶
type VerifyOp ¶ added in v0.18.0
VerifyOp keeps the information about the foreign key verification operation. It is a Parent verification or a Child verification.
type Vindex ¶
type Vindex struct { OpCode engine.VindexOpcode Table VindexTable Vindex vindexes.Vindex Solved semantics.TableSet Columns []*sqlparser.ColName Value sqlparser.Expr // contains filtered or unexported fields }
func (*Vindex) AddColumn ¶
func (v *Vindex) AddColumn(ctx *plancontext.PlanningContext, reuse bool, gb bool, ae *sqlparser.AliasedExpr) (int, error)
func (*Vindex) AddPredicate ¶
func (v *Vindex) AddPredicate(ctx *plancontext.PlanningContext, expr sqlparser.Expr) (ops.Operator, error)
func (*Vindex) CheckValid ¶
func (*Vindex) FindCol ¶ added in v0.18.0
func (v *Vindex) FindCol(ctx *plancontext.PlanningContext, expr sqlparser.Expr, underRoute bool) (int, error)
func (*Vindex) GetColNames ¶ added in v0.17.0
func (*Vindex) GetColumns ¶
func (v *Vindex) GetColumns(*plancontext.PlanningContext) ([]*sqlparser.AliasedExpr, error)
func (*Vindex) GetSelectExprs ¶ added in v0.18.0
func (v *Vindex) GetSelectExprs(ctx *plancontext.PlanningContext) (sqlparser.SelectExprs, error)
func (*Vindex) ShortDescription ¶ added in v0.17.0
func (*Vindex) TablesUsed ¶
TablesUsed implements the Operator interface. It is not keyspace-qualified.
type VindexOption ¶
type VindexOption struct { Ready bool Values []evalengine.Expr // Columns that we have seen so far. Used only for multi-column vindexes so that we can track how many Columns part of the vindex we have seen ColsSeen map[string]any ValueExprs []sqlparser.Expr Predicates []sqlparser.Expr OpCode engine.Opcode FoundVindex vindexes.Vindex Cost Cost }
VindexOption stores the information needed to know if we have all the information needed to use a vindex
type VindexPlusPredicates ¶
type VindexPlusPredicates struct { TableID semantics.TableSet ColVindex *vindexes.ColumnVindex // during planning, we store the alternatives found for this route in this slice Options []*VindexOption }
VindexPlusPredicates is a struct used to store all the predicates that the vindex can be used to query
Source Files ¶
- SQL_builder.go
- aggregation_pushing.go
- aggregator.go
- apply_join.go
- ast_to_op.go
- comments.go
- delete.go
- distinct.go
- dml_planning.go
- expressions.go
- filter.go
- fk_cascade.go
- fk_verify.go
- helpers.go
- horizon.go
- horizon_expanding.go
- info_schema_planning.go
- insert.go
- join.go
- join_merging.go
- joins.go
- limit.go
- misc_routing.go
- offset_planning.go
- operator.go
- operator_funcs.go
- ordering.go
- phases.go
- projection.go
- query_planning.go
- querygraph.go
- queryprojection.go
- route.go
- route_planning.go
- sharded_routing.go
- subquery.go
- subquery_builder.go
- subquery_container.go
- subquery_planning.go
- table.go
- union.go
- union_merging.go
- update.go
- vindex.go