planbuilder

Documentation

Index

• Constants
• Variables
• func DeepCopyNode(node sql.Node) (sql.Node, error)
• func ExpressionToColumnDefaultValue(inputExpr sql.Expression, isLiteral, isParenthesized bool) *sql.ColumnDefaultValue
• func MustStringToColumnDefaultValue(ctx *sql.Context, exprStr string, outType sql.Type, nullable bool) *sql.ColumnDefaultValue
• func Parse(ctx *sql.Context, cat sql.Catalog, query string) (sql.Node, *sql.QueryFlags, error)
• func ParseColumnTypeString(columnType string) (sql.Type, error)
• func ParseWithOptions(ctx *sql.Context, cat sql.Catalog, query string, options ast.ParserOptions) (sql.Node, *sql.QueryFlags, error)
• func StringToColumnDefaultValue(ctx *sql.Context, exprStr string) (*sql.ColumnDefaultValue, error)
• type BindvarContext
  • func (bv *BindvarContext) GetSubstitute(s string) (sql.Expression, bool)
  • func (bv *BindvarContext) UnusedBindings() []string
• type Builder
  • func New(ctx *sql.Context, cat sql.Catalog, es sql.EventScheduler, p sql.Parser) *Builder
  • func (b *Builder) BindCtx() *BindvarContext
  • func (b *Builder) BindOnly(stmt ast.Statement, s string, queryFlags *sql.QueryFlags) (_ sql.Node, _ *sql.QueryFlags, err error)
  • func (b *Builder) BuildColumnDefaultValueWithTable(defExpr ast.Expr, tableExpr ast.TableExpr, typ sql.Type, nullable bool) *sql.ColumnDefaultValue
  • func (b *Builder) BuildScalarWithTable(expr ast.Expr, tableExpr ast.TableExpr) sql.Expression
  • func (b *Builder) ConvertVal(v *ast.SQLVal) sql.Expression
  • func (b *Builder) DisableAuth()
  • func (b *Builder) EnableAuth()
  • func (b *Builder) NewFrame(inScope *scope, f *ast.Frame) sql.WindowFrame
  • func (b *Builder) Parse(query string, qFlags *sql.QueryFlags, multi bool) (ret sql.Node, parsed, remainder string, qProps *sql.QueryFlags, err error)
  • func (b *Builder) ProcCtx() *ProcContext
  • func (b *Builder) Reset()
  • func (b *Builder) SetBindings(bindings map[string]ast.Expr)
  • func (b *Builder) SetBindingsWithExpr(bindings map[string]sql.Expression)
  • func (b *Builder) SetDebug(val bool)
  • func (b *Builder) SetParserOptions(opts ast.ParserOptions)
  • func (b *Builder) TriggerCtx() *TriggerContext
  • func (b *Builder) ViewCtx() *ViewContext
• type ProcContext
• type TriggerContext
• type ViewContext

Constants

const ExtendedTypeTag = "extended_"

ExtendedTypeTag is primarily used by ParseColumnTypeString when parsing strings representing extended types

const OnDupValuesPrefix = "__new_ins"

Variables

var (
	ErrPrimaryKeyOnNullField = errors.NewKind("All parts of PRIMARY KEY must be NOT NULL")

	// ErrUnionSchemasDifferentLength is returned when the two sides of a
	// UNION do not have the same number of columns in their schemas.
	ErrUnionSchemasDifferentLength = errors.NewKind(
		"cannot union two queries whose schemas are different lengths; left has %d column(s) right has %d column(s).",
	)

	ErrQualifiedOrderBy = errors.NewKind("Table '%s' from one of the SELECTs cannot be used in global ORDER clause")

	ErrOrderByBinding = errors.NewKind("bindings in sort clauses not supported yet")

	ErrFailedToParseStats = errors.NewKind("failed to parse data: %s\n%s")
)

var BinderFactory = &sync.Pool{New: func() interface{} {
	return &Builder{f: &factory{}}
}}

var ErrMaxAnalysisIters = errors.NewKind("exceeded max analysis iterations (%d)")

ErrMaxAnalysisIters is thrown when the analysis iterations are exceeded

Functions

func DeepCopyNode

func DeepCopyNode(node sql.Node) (sql.Node, error)

DeepCopyNode copies a sql.Node.

func ExpressionToColumnDefaultValue

func ExpressionToColumnDefaultValue(inputExpr sql.Expression, isLiteral, isParenthesized bool) *sql.ColumnDefaultValue

ExpressionToColumnDefaultValue takes in an Expression and returns the equivalent ColumnDefaultValue if the expression is valid for a default value. If the expression represents a literal (and not an expression that returns a literal, so "5" rather than "(5)"), then the parameter "isLiteral" should be true.

func MustStringToColumnDefaultValue

func MustStringToColumnDefaultValue(ctx *sql.Context, exprStr string, outType sql.Type, nullable bool) *sql.ColumnDefaultValue

MustStringToColumnDefaultValue is used for creating default values on tables that do not go through the analyzer. Does not handle function nor column references.

func Parse

func Parse(ctx *sql.Context, cat sql.Catalog, query string) (sql.Node, *sql.QueryFlags, error)

Parse parses the given SQL |query| using the default parsing settings and returns the corresponding node.

func ParseColumnTypeString

func ParseColumnTypeString(columnType string) (sql.Type, error)

func ParseWithOptions

func ParseWithOptions(ctx *sql.Context, cat sql.Catalog, query string, options ast.ParserOptions) (sql.Node, *sql.QueryFlags, error)

func StringToColumnDefaultValue

func StringToColumnDefaultValue(ctx *sql.Context, exprStr string) (*sql.ColumnDefaultValue, error)

StringToColumnDefaultValue takes in a string representing a default value and returns the equivalent Expression.

Types

type BindvarContext

type BindvarContext struct {
	Bindings map[string]sql.Expression
	// contains filtered or unexported fields
}

BindvarContext holds bind variable replacement literals.

func (*BindvarContext) GetSubstitute

func (bv *BindvarContext) GetSubstitute(s string) (sql.Expression, bool)

func (*BindvarContext) UnusedBindings

func (bv *BindvarContext) UnusedBindings() []string

type Builder

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

func New

func New(ctx *sql.Context, cat sql.Catalog, es sql.EventScheduler, p sql.Parser) *Builder

New takes ctx, catalog, event scheduler, and parser. If the parser is nil, then default parser is mysql parser.

func (*Builder) BindCtx

func (b *Builder) BindCtx() *BindvarContext

func (*Builder) BindOnly

func (b *Builder) BindOnly(stmt ast.Statement, s string, queryFlags *sql.QueryFlags) (_ sql.Node, _ *sql.QueryFlags, err error)

func (*Builder) BuildColumnDefaultValueWithTable

func (b *Builder) BuildColumnDefaultValueWithTable(defExpr ast.Expr, tableExpr ast.TableExpr, typ sql.Type, nullable bool) *sql.ColumnDefaultValue

func (*Builder) BuildScalarWithTable

func (b *Builder) BuildScalarWithTable(expr ast.Expr, tableExpr ast.TableExpr) sql.Expression

func (*Builder) ConvertVal

func (b *Builder) ConvertVal(v *ast.SQLVal) sql.Expression

func (*Builder) DisableAuth

func (b *Builder) DisableAuth()

DisableAuth disables all authorization checks.

func (*Builder) EnableAuth

func (b *Builder) EnableAuth()

EnableAuth enables all authorization checks. Auth is enabled by default, so this only needs to be called when it was previously disabled using DisableAuth.

func (*Builder) NewFrame

func (b *Builder) NewFrame(inScope *scope, f *ast.Frame) sql.WindowFrame

func (*Builder) Parse

func (b *Builder) Parse(query string, qFlags *sql.QueryFlags, multi bool) (ret sql.Node, parsed, remainder string, qProps *sql.QueryFlags, err error)

func (*Builder) ProcCtx

func (b *Builder) ProcCtx() *ProcContext

func (*Builder) Reset

func (b *Builder) Reset()

func (*Builder) SetBindings

func (b *Builder) SetBindings(bindings map[string]ast.Expr)

func (*Builder) SetBindingsWithExpr

func (b *Builder) SetBindingsWithExpr(bindings map[string]sql.Expression)

func (*Builder) SetDebug

func (b *Builder) SetDebug(val bool)

func (*Builder) SetParserOptions

func (b *Builder) SetParserOptions(opts ast.ParserOptions)

func (*Builder) TriggerCtx

func (b *Builder) TriggerCtx() *TriggerContext

func (*Builder) ViewCtx

func (b *Builder) ViewCtx() *ViewContext

type ProcContext

type ProcContext struct {
	AsOf   interface{}
	DbName string
}

ProcContext allows nested CALLs to use the same database for resolving procedure definitions without changing the underlying database roots.

type TriggerContext

type TriggerContext struct {
	Active           bool
	Call             bool
	UnresolvedTables []string
	ResolveErr       error
}

type ViewContext

type ViewContext struct {
	AsOf   interface{}
	DbName string
}

ViewContext overwrites database root source of nested calls.