planbuilder

Documentation

Overview

Package planbuilder allows you to build execution plans that describe how to fulfill a query that may span multiple keyspaces or shards.

The main entry point for the planbuilder is the Build function that accepts a query and vschema and returns the plan.

Index

• func Build(query string, vschema VSchema) (*engine.Plan, error)
• func BuildFromStmt(query string, stmt sqlparser.Statement, vschema VSchema) (*engine.Plan, error)
• type VSchema

Functions

func Build

func Build(query string, vschema VSchema) (*engine.Plan, error)

Build builds a plan for a query based on the specified vschema. It's the main entry point for this package.

func BuildFromStmt

func BuildFromStmt(query string, stmt sqlparser.Statement, vschema VSchema) (*engine.Plan, error)

BuildFromStmt builds a plan based on the AST provided. TODO(sougou): The query input is trusted as the source of the AST. Maybe this function just returns instructions and engine.Plan can be built by the caller.

Types

type VSchema

type VSchema interface {
	Find(keyspace, tablename sqlparser.TableIdent) (table *vindexes.Table, err error)
}

VSchema defines the interface for this package to fetch info about tables.