planbuilder

Documentation

Index

• Constants
• func BuildFromStmt(ctx context.Context, query string, stmt sqlparser.Statement, ...) (*engine.Plan, error)
• func GetShardRoute(vschema plancontext.VSchema, keyspace, shard string) (*vindexes.Keyspace, error)
• func SupplyProjection(eVindexFunc *engine.VindexFunc, expr *sqlparser.AliasedExpr, reuse bool) error
• func TestBuilder(query string, vschema plancontext.VSchema, keyspace string) (*engine.Plan, error)
• func WireupRoute(ctx *plancontext.PlanningContext, eroute *engine.Route, ...) (engine.Primitive, error)
• type UnsupportedSupplyWeightString
  • func (err UnsupportedSupplyWeightString) Error() string

Constants

const (
	// Gen4 uses the default Gen4 planner, which is the greedy planner
	Gen4 = querypb.ExecuteOptions_Gen4
	// Gen4GreedyOnly uses only the faster greedy planner
	Gen4GreedyOnly = querypb.ExecuteOptions_Gen4Greedy
	// Gen4Left2Right joins table in the order they are listed in the FROM-clause
	Gen4Left2Right = querypb.ExecuteOptions_Gen4Left2Right
)

const (
	ViewDifferentKeyspace string = "Select query does not belong to the same keyspace as the view statement"
	ViewComplex           string = "Complex select queries are not supported in create or alter view statements"
	DifferentDestinations string = "Tables or Views specified in the query do not belong to the same destination"
)

Error messages for CreateView queries

Functions

func BuildFromStmt

func BuildFromStmt(ctx context.Context, query string, stmt sqlparser.Statement, reservedVars *sqlparser.ReservedVars, vschema plancontext.VSchema, bindVarNeeds *sqlparser.BindVarNeeds, enableOnlineDDL, enableDirectDDL bool) (*engine.Plan, error)

BuildFromStmt builds a plan based on the AST provided.

func GetShardRoute

func GetShardRoute(vschema plancontext.VSchema, keyspace, shard string) (*vindexes.Keyspace, error)

func SupplyProjection

func SupplyProjection(eVindexFunc *engine.VindexFunc, expr *sqlparser.AliasedExpr, reuse bool) error

SupplyProjection pushes the given aliased expression into the fields and cols slices of the vindexFunc engine primitive. The method returns the offset of the new expression in the columns list.

func TestBuilder

func TestBuilder(query string, vschema plancontext.VSchema, keyspace string) (*engine.Plan, error)

TestBuilder builds a plan for a query based on the specified vschema. This method is only used from tests

func WireupRoute

func WireupRoute(ctx *plancontext.PlanningContext, eroute *engine.Route, sel sqlparser.SelectStatement) (engine.Primitive, error)

WireupRoute returns an engine primitive for the given route.

Types

type UnsupportedSupplyWeightString

type UnsupportedSupplyWeightString struct {
	Type string
}

UnsupportedSupplyWeightString represents the error where the supplying a weight string is not supported

func (UnsupportedSupplyWeightString) Error

func (err UnsupportedSupplyWeightString) Error() string

Error function implements the error interface