plan

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 17, 2022 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

plan build & optimize logical plan

Index

Constants

View Source 
const (
	JoinSideNone       int8 = 0
	JoinSideLeft            = 1 << iota
	JoinSideRight           = 1 << iota
	JoinSideBoth            = JoinSideLeft | JoinSideRight
	JoinSideCorrelated      = 1 << iota
)
View Source 
const (
	NotFound      int32 = math.MaxInt32
	AmbiguousName int32 = math.MinInt32
)
View Source 
const MO_CATALOG_DB_NAME = "mo_catalog"
View Source 
const SF float64 = 1

Variables

View Source 
var (
	// errors may happen while building constant
	ErrDivByZero   = errors.New(errno.SyntaxErrororAccessRuleViolation, "division by zero")
	ErrZeroModulus = errors.New(errno.SyntaxErrororAccessRuleViolation, "zero modulus")
)
View Source 
var BuiltinFunctions = [...]*FunctionSig{}/* 149 elements not displayed */

Functions shipped by system.

Functions

func GetBindings added in v0.5.0 

func GetBindings(expr *plan.Expr) []int32

func MakePlan2DefaultExpr added in v0.5.0 

func MakePlan2DefaultExpr(expr engine.DefaultExpr) *plan.DefaultExpr

func NewGetParamRule added in v0.5.1 

func NewGetParamRule() getParamRule

func NewResetParamRule added in v0.5.1 

func NewResetParamRule(args map[int]int) resetParamRule

Types

type BaseOptimizer added in v0.5.0 

type BaseOptimizer struct {
	// contains filtered or unexported fields
}

BaseOptimizer is base optimizer, capable of handling only a few simple rules

func NewBaseOptimizer added in v0.5.0 

func NewBaseOptimizer(ctx CompilerContext) *BaseOptimizer

func (*BaseOptimizer) CurrentContext added in v0.5.0 

func (opt *BaseOptimizer) CurrentContext() CompilerContext

func (*BaseOptimizer) Optimize added in v0.5.0 

func (opt *BaseOptimizer) Optimize(stmt tree.Statement) (*Query, error)

type BindContext added in v0.5.0 

type BindContext struct {
	// contains filtered or unexported fields
}

func NewBindContext added in v0.5.0 

func NewBindContext(builder *QueryBuilder, parent *BindContext) *BindContext

type Binder added in v0.5.0 

type Binder interface {
	BindExpr(tree.Expr, int32, bool) (*plan.Expr, error)
	BindColRef(*tree.UnresolvedName, int32, bool) (*plan.Expr, error)
	BindAggFunc(string, *tree.FuncExpr, int32, bool) (*plan.Expr, error)
	BindWinFunc(string, *tree.FuncExpr, int32, bool) (*plan.Expr, error)
	BindSubquery(*tree.Subquery, bool) (*plan.Expr, error)
}

type Binding added in v0.5.0 

type Binding struct {
	// contains filtered or unexported fields
}

func NewBinding added in v0.5.0 

func NewBinding(tag, nodeID int32, table string, cols []string, types []*plan.Type) *Binding

func (*Binding) FindColumn added in v0.5.0 

func (b *Binding) FindColumn(col string) int32

type BindingTreeNode added in v0.5.0 

type BindingTreeNode struct {
	// contains filtered or unexported fields
}

type CTERef added in v0.5.0 

type CTERef struct {
	// contains filtered or unexported fields
}

type ColDef added in v0.5.0 

type ColDef = plan.ColDef

func GetResultColumnsFromPlan added in v0.5.0 

func GetResultColumnsFromPlan(p *Plan) []*ColDef

GetResultColumnsFromPlan

type ColRef added in v0.5.0 

type ColRef = plan.ColRef

type ColRefRemapping added in v0.5.0 

type ColRefRemapping struct {
	// contains filtered or unexported fields
}

type CompilerContext added in v0.5.0 

type CompilerContext interface {
	// Default database/schema in context
	DefaultDatabase() string
	// check if database exist
	DatabaseExists(name string) bool
	// get table definition by database/schema
	Resolve(schemaName string, tableName string) (*ObjectRef, *TableDef)
	// get the value of variable
	ResolveVariable(varName string, isSystemVar, isGlobalVar bool) (interface{}, error)
	// get the definition of primary key
	GetPrimaryKeyDef(dbName string, tableName string) []*ColDef
	// get the definition of hide key
	GetHideKeyDef(dbName string, tableName string) *ColDef
	// get estimated cost by table & expr
	Cost(obj *ObjectRef, e *Expr) *Cost
}

type Const added in v0.5.0 

type Const = plan.Const

type Cost added in v0.5.0 

type Cost = plan.Cost

type Expr added in v0.5.0 

type Expr = plan.Expr

func DeepCopyExpr added in v0.5.0 

func DeepCopyExpr(expr *Expr) *Expr

type FuncExplainLayout added in v0.5.0 

type FuncExplainLayout int32
const (
	STANDARD_FUNCTION          FuncExplainLayout = 0 //standard function
	UNARY_ARITHMETIC_OPERATOR  FuncExplainLayout = 1 //unary arithmetic operator
	BINARY_ARITHMETIC_OPERATOR FuncExplainLayout = 2 //binary arithmetic operator
	UNARY_LOGICAL_OPERATOR     FuncExplainLayout = 3 // unary logical operator
	BINARY_LOGICAL_OPERATOR    FuncExplainLayout = 4 // binary logical operator
	COMPARISON_OPERATOR        FuncExplainLayout = 5 // comparison operator
	CAST_EXPRESSION            FuncExplainLayout = 6 // cast expression
	CASE_WHEN_EXPRESSION       FuncExplainLayout = 7 // case when expression
	BETWEEN_AND_EXPRESSION     FuncExplainLayout = 8
	IN_PREDICATE               FuncExplainLayout = 9  //query 'in' predicate
	EXISTS_ANY_PREDICATE       FuncExplainLayout = 10 //query predicate,such as exist,all,any
	IS_NULL_EXPRESSION         FuncExplainLayout = 11 // is null expression
	NOPARAMETER_FUNCTION       FuncExplainLayout = 12 // noparameter function
	DATE_INTERVAL_EXPRESSION   FuncExplainLayout = 13 // date expression,interval expression
	EXTRACT_FUNCTION           FuncExplainLayout = 14 // extract function,such as extract(MONTH/DAY/HOUR/MINUTE/SECOND FROM p)
	POSITION_FUNCTION          FuncExplainLayout = 15 // position function, such as POSITION(substr IN str)
	UNKNOW_KIND_FUNCTION       FuncExplainLayout = 16
)

type FunctionSig added in v0.5.0 

type FunctionSig struct {
	Name         string
	Flag         plan.Function_FuncFlag
	Layout       FuncExplainLayout
	ArgTypeClass []plan.Type_TypeId
	ArgType      []int8
}

Function signature. ArgTypeClass and ArgType need some explanation. ArgTypeClass defines type equivalent class for this function. The first equivlent class is the return type. For each argument of this function it has a arg type, which is an index into the ArgTypeClass. Let's use an example, 

"=", STRICT, {BOOL, ANY}, {1, 1}}

means, 

function name is "=".
it is a STRICT function, that is, it will return null iff
        it has a null arguments
Two type equivalent class
        first is BOOL, means the the return type is BOOL
        second is ANY, means any type
{1, 1}, means the function take two arguments.
        first arg is of type class 1, which is ANY
        second arg is of type class 1 too, which is ANY
        both arg is of same class, means they must be same
        type.

Therefore, it means "=" is a strict function, taking two arguments of ANY type (but both arguments must be of SAME type), and return BOOL.

type GroupBinder added in v0.5.0 

type GroupBinder struct {
	// contains filtered or unexported fields
}

func NewGroupBinder added in v0.5.0 

func NewGroupBinder(builder *QueryBuilder, ctx *BindContext) *GroupBinder

func (*GroupBinder) BindAggFunc added in v0.5.0 

func (b *GroupBinder) BindAggFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

func (*GroupBinder) BindColRef added in v0.5.0 

func (b *GroupBinder) BindColRef(astExpr *tree.UnresolvedName, depth int32, isRoot bool) (*plan.Expr, error)

func (*GroupBinder) BindExpr added in v0.5.0 

func (b *GroupBinder) BindExpr(astExpr tree.Expr, depth int32, isRoot bool) (*plan.Expr, error)

func (*GroupBinder) BindSubquery added in v0.5.0 

func (b *GroupBinder) BindSubquery(astExpr *tree.Subquery, isRoot bool) (*plan.Expr, error)

func (*GroupBinder) BindWinFunc added in v0.5.0 

func (b *GroupBinder) BindWinFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

type HavingBinder added in v0.5.0 

type HavingBinder struct {
	// contains filtered or unexported fields
}

func NewHavingBinder added in v0.5.0 

func NewHavingBinder(builder *QueryBuilder, ctx *BindContext) *HavingBinder

func (*HavingBinder) BindAggFunc added in v0.5.0 

func (b *HavingBinder) BindAggFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

func (*HavingBinder) BindColRef added in v0.5.0 

func (b *HavingBinder) BindColRef(astExpr *tree.UnresolvedName, depth int32, isRoot bool) (*plan.Expr, error)

func (*HavingBinder) BindExpr added in v0.5.0 

func (b *HavingBinder) BindExpr(astExpr tree.Expr, depth int32, isRoot bool) (*plan.Expr, error)

func (*HavingBinder) BindSubquery added in v0.5.0 

func (b *HavingBinder) BindSubquery(astExpr *tree.Subquery, isRoot bool) (*plan.Expr, error)

func (*HavingBinder) BindWinFunc added in v0.5.0 

func (b *HavingBinder) BindWinFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

type LimitBinder added in v0.5.0 

type LimitBinder struct {
	// contains filtered or unexported fields
}

func NewLimitBinder added in v0.5.0 

func NewLimitBinder() *LimitBinder

func (*LimitBinder) BindAggFunc added in v0.5.0 

func (b *LimitBinder) BindAggFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

func (*LimitBinder) BindColRef added in v0.5.0 

func (b *LimitBinder) BindColRef(astExpr *tree.UnresolvedName, depth int32, isRoot bool) (*plan.Expr, error)

func (*LimitBinder) BindExpr added in v0.5.0 

func (b *LimitBinder) BindExpr(astExpr tree.Expr, depth int32, isRoot bool) (*plan.Expr, error)

func (*LimitBinder) BindSubquery added in v0.5.0 

func (b *LimitBinder) BindSubquery(astExpr *tree.Subquery, isRoot bool) (*plan.Expr, error)

func (*LimitBinder) BindWinFunc added in v0.5.0 

func (b *LimitBinder) BindWinFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

type MockCompilerContext added in v0.5.0 

type MockCompilerContext struct {
	// contains filtered or unexported fields
}

func NewEmptyCompilerContext added in v0.5.0 

func NewEmptyCompilerContext() *MockCompilerContext

NewEmptyCompilerContext for test create/drop statement

func NewMockCompilerContext added in v0.5.0 

func NewMockCompilerContext() *MockCompilerContext

func (*MockCompilerContext) Cost added in v0.5.0 

func (m *MockCompilerContext) Cost(obj *ObjectRef, e *Expr) *Cost

func (*MockCompilerContext) DatabaseExists added in v0.5.0 

func (m *MockCompilerContext) DatabaseExists(name string) bool

func (*MockCompilerContext) DefaultDatabase added in v0.5.0 

func (m *MockCompilerContext) DefaultDatabase() string

func (*MockCompilerContext) GetHideKeyDef added in v0.5.0 

func (m *MockCompilerContext) GetHideKeyDef(dbName string, tableName string) *ColDef

func (*MockCompilerContext) GetPrimaryKeyDef added in v0.5.0 

func (m *MockCompilerContext) GetPrimaryKeyDef(dbName string, tableName string) []*ColDef

func (*MockCompilerContext) Resolve added in v0.5.0 

func (m *MockCompilerContext) Resolve(dbName string, tableName string) (*ObjectRef, *TableDef)

func (*MockCompilerContext) ResolveVariable added in v0.5.0 

func (m *MockCompilerContext) ResolveVariable(varName string, isSystemVar, isGlobalVar bool) (interface{}, error)

type MockOptimizer added in v0.5.0 

type MockOptimizer struct {
	// contains filtered or unexported fields
}

func NewEmptyMockOptimizer added in v0.5.0 

func NewEmptyMockOptimizer() *MockOptimizer

func NewMockOptimizer added in v0.5.0 

func NewMockOptimizer() *MockOptimizer

func (*MockOptimizer) CurrentContext added in v0.5.0 

func (moc *MockOptimizer) CurrentContext() CompilerContext

func (*MockOptimizer) Optimize added in v0.5.0 

func (moc *MockOptimizer) Optimize(stmt tree.Statement) (*Query, error)

type NameTuple added in v0.5.0 

type NameTuple struct {
	// contains filtered or unexported fields
}

type Node added in v0.5.0 

type Node = plan.Node

type ObjectRef added in v0.5.0 

type ObjectRef = plan.ObjectRef

type Optimizer added in v0.5.0 

type Optimizer interface {
	Optimize(stmt tree.Statement) (*Query, error)
	CurrentContext() CompilerContext
}

type OrderBinder added in v0.5.0 

type OrderBinder struct {
	*ProjectionBinder
	// contains filtered or unexported fields
}

func NewOrderBinder added in v0.5.0 

func NewOrderBinder(projectionBinder *ProjectionBinder, selectList tree.SelectExprs) *OrderBinder

func (*OrderBinder) BindExpr added in v0.5.0 

func (b *OrderBinder) BindExpr(astExpr tree.Expr) (*plan.Expr, error)

type Plan 

type Plan = plan.Plan

func BuildPlan added in v0.5.0 

func BuildPlan(ctx CompilerContext, stmt tree.Statement) (*Plan, error)

type Plan_Query added in v0.5.0 

type Plan_Query = plan.Plan_Query

type ProjectionBinder added in v0.5.0 

type ProjectionBinder struct {
	// contains filtered or unexported fields
}

func NewProjectionBinder added in v0.5.0 

func NewProjectionBinder(builder *QueryBuilder, ctx *BindContext, havingBinder *HavingBinder) *ProjectionBinder

func (*ProjectionBinder) BindAggFunc added in v0.5.0 

func (b *ProjectionBinder) BindAggFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

func (*ProjectionBinder) BindColRef added in v0.5.0 

func (b *ProjectionBinder) BindColRef(astExpr *tree.UnresolvedName, depth int32, isRoot bool) (*plan.Expr, error)

func (*ProjectionBinder) BindExpr added in v0.5.0 

func (b *ProjectionBinder) BindExpr(astExpr tree.Expr, depth int32, isRoot bool) (*plan.Expr, error)

func (*ProjectionBinder) BindSubquery added in v0.5.0 

func (b *ProjectionBinder) BindSubquery(astExpr *tree.Subquery, isRoot bool) (*plan.Expr, error)

func (*ProjectionBinder) BindWinFunc added in v0.5.0 

func (b *ProjectionBinder) BindWinFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

type Query 

type Query = plan.Query

type QueryBuilder added in v0.5.0 

type QueryBuilder struct {
	// contains filtered or unexported fields
}

func NewQueryBuilder added in v0.5.0 

func NewQueryBuilder(queryType plan.Query_StatementType, ctx CompilerContext) *QueryBuilder

type RowsetData added in v0.5.0 

type RowsetData = plan.RowsetData

type Rule added in v0.5.0 

type Rule interface {
	Match(*Node) bool    // rule match?
	Apply(*Node, *Query) // apply the rule
}

type Schema added in v0.5.0 

type Schema struct {
	// contains filtered or unexported fields
}

type TableBinder added in v0.5.0 

type TableBinder struct {
	// contains filtered or unexported fields
}

func NewTableBinder added in v0.5.0 

func NewTableBinder(builder *QueryBuilder, ctx *BindContext) *TableBinder

func (*TableBinder) BindAggFunc added in v0.5.0 

func (b *TableBinder) BindAggFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

func (*TableBinder) BindColRef added in v0.5.0 

func (b *TableBinder) BindColRef(astExpr *tree.UnresolvedName, depth int32, isRoot bool) (*plan.Expr, error)

func (*TableBinder) BindExpr added in v0.5.0 

func (b *TableBinder) BindExpr(astExpr tree.Expr, depth int32, isRoot bool) (*plan.Expr, error)

func (*TableBinder) BindSubquery added in v0.5.0 

func (b *TableBinder) BindSubquery(astExpr *tree.Subquery, isRoot bool) (*plan.Expr, error)

func (*TableBinder) BindWinFunc added in v0.5.0 

func (b *TableBinder) BindWinFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

type TableDef added in v0.5.0 

type TableDef = plan.TableDef

type Type added in v0.5.0 

type Type = plan.Type

type VisitQuery added in v0.5.1 

type VisitQuery struct {
	// contains filtered or unexported fields
}

func NewVisitQuery added in v0.5.1 

func NewVisitQuery(qry *Query, rule Rule) *VisitQuery

func (*VisitQuery) Visit added in v0.5.1 

func (vq *VisitQuery) Visit() (*Query, error)

type WhereBinder added in v0.5.0 

type WhereBinder struct {
	// contains filtered or unexported fields
}

func NewWhereBinder added in v0.5.0 

func NewWhereBinder(builder *QueryBuilder, ctx *BindContext) *WhereBinder

func (*WhereBinder) BindAggFunc added in v0.5.0 

func (b *WhereBinder) BindAggFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

func (*WhereBinder) BindColRef added in v0.5.0 

func (b *WhereBinder) BindColRef(astExpr *tree.UnresolvedName, depth int32, isRoot bool) (*plan.Expr, error)

func (*WhereBinder) BindExpr added in v0.5.0 

func (b *WhereBinder) BindExpr(astExpr tree.Expr, depth int32, isRoot bool) (*plan.Expr, error)

func (*WhereBinder) BindSubquery added in v0.5.0 

func (b *WhereBinder) BindSubquery(astExpr *tree.Subquery, isRoot bool) (*plan.Expr, error)

func (*WhereBinder) BindWinFunc added in v0.5.0 

func (b *WhereBinder) BindWinFunc(funcName string, astExpr *tree.FuncExpr, depth int32, isRoot bool) (*plan.Expr, error)

Source Files

View all Source files

Directories

Path Synopsis
explain explain statement
 explain explain statement
builtin/binary
builtin/multi
builtin/unary
operator

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.