sqlparser

package
v0.0.0-...-3023ae2 Latest Latest
Warning

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

 Go to latest Published: Apr 2, 2020 License: GPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	StmtSelect = iota
	StmtInsert
	StmtReplace
	StmtUpdate
	StmtDelete
	StmtDDL
	StmtBegin
	StmtCommit
	StmtRollback
	StmtSet
	StmtShow
	StmtUse
	StmtOther
	StmtUnknown
)

These constants are used to identify the SQL statement type.

View Source 
const (
	DistinctStr      = "distinct "
	StraightJoinHint = "straight_join "
)

Select.Distinct

View Source 
const (
	ForUpdateStr = " for update"
	ShareModeStr = " lock in share mode"
)

Select.Lock

View Source 
const (
	SQLCacheStr   = "sql_cache "
	SQLNoCacheStr = "sql_no_cache "
)

Select.Cache

View Source 
const (
	UnionStr         = "union"
	UnionAllStr      = "union all"
	UnionDistinctStr = "union distinct"
)

Union.Type

View Source 
const (
	// InsertStr represents insert action.
	InsertStr = "insert"
	// ReplaceStr represents replace action.
	ReplaceStr = "replace"
)
View Source 
const (
	SessionStr = "session"
	GlobalStr  = "global"
)

Set.Scope or Show.Scope

View Source 
const (
	CreateDBStr             = "create database"
	CreateTableStr          = "create table"
	CreatePartitionTableStr = "create partition table"
	CreateIndexStr          = "create index"
	DropDBStr               = "drop database"
	DropTableStr            = "drop table"
	DropIndexStr            = "drop index"
	AlterStr                = "alter"
	AlterEngineStr          = "alter table"
	AlterCharsetStr         = "alter table charset"
	AlterAddColumnStr       = "alter table add column"
	AlterDropColumnStr      = "alter table drop column"
	AlterModifyColumnStr    = "alter table modify column"
	RenameStr               = "rename table"
	TruncateTableStr        = "truncate table"
	SingleTableType         = "singletable"
	GlobalTableType         = "globaltable"
	PartitionTableHash      = "partitiontablehash"
	NormalTableType         = "normaltable"
	PartitionTableList      = "partitiontablelist"
)

DDL strings.

View Source 
const (
	ShowDatabasesStr      = "databases"
	ShowCreateDatabaseStr = "create database"
	ShowTableStatusStr    = "table status"
	ShowTablesStr         = "tables"
	ShowColumnsStr        = "columns"
	ShowCreateTableStr    = "create table"
	ShowEnginesStr        = "engines"
	ShowStatusStr         = "status"
	ShowVersionsStr       = "versions"
	ShowProcesslistStr    = "processlist"
	ShowQueryzStr         = "queryz"
	ShowTxnzStr           = "txnz"
	ShowWarningsStr       = "warnings"
	ShowVariablesStr      = "variables"
	ShowBinlogEventsStr   = "binlog events"
	ShowUnsupportedStr    = "unsupported"
)

The following constants represent SHOW statements.

View Source 
const (
	JoinStr             = "join"
	StraightJoinStr     = "straight_join"
	LeftJoinStr         = "left join"
	RightJoinStr        = "right join"
	NaturalJoinStr      = "natural join"
	NaturalLeftJoinStr  = "natural left join"
	NaturalRightJoinStr = "natural right join"
)

JoinTableExpr.Join

View Source 
const (
	UseStr    = "use "
	IgnoreStr = "ignore "
	ForceStr  = "force "
)

Index hints.

View Source 
const (
	WhereStr  = "where"
	HavingStr = "having"
)

Where.Type

View Source 
const (
	EqualStr             = "="
	LessThanStr          = "<"
	GreaterThanStr       = ">"
	LessEqualStr         = "<="
	GreaterEqualStr      = ">="
	NotEqualStr          = "!="
	NullSafeEqualStr     = "<=>"
	InStr                = "in"
	NotInStr             = "not in"
	LikeStr              = "like"
	NotLikeStr           = "not like"
	RegexpStr            = "regexp"
	NotRegexpStr         = "not regexp"
	JSONExtractOp        = "->"
	JSONUnquoteExtractOp = "->>"
)

ComparisonExpr.Operator

View Source 
const (
	BetweenStr    = "between"
	NotBetweenStr = "not between"
)

RangeCond.Operator

View Source 
const (
	IsNullStr     = "is null"
	IsNotNullStr  = "is not null"
	IsTrueStr     = "is true"
	IsNotTrueStr  = "is not true"
	IsFalseStr    = "is false"
	IsNotFalseStr = "is not false"
)

IsExpr.Operator

View Source 
const (
	StrVal = ValType(iota)
	IntVal
	FloatVal
	HexNum
	HexVal
	ValArg
	StrValWithoutQuote
)

These are the possible Valtype values. HexNum represents a 0x... value. It cannot be treated as a simple value because it can be interpreted differently depending on the context.

View Source 
const (
	BitAndStr     = "&"
	BitOrStr      = "|"
	BitXorStr     = "^"
	PlusStr       = "+"
	MinusStr      = "-"
	MultStr       = "*"
	DivStr        = "/"
	IntDivStr     = "div"
	ModStr        = "%"
	ShiftLeftStr  = "<<"
	ShiftRightStr = ">>"
)

BinaryExpr.Operator

View Source 
const (
	UPlusStr  = "+"
	UMinusStr = "-"
	TildaStr  = "~"
	BangStr   = "!"
	BinaryStr = "binary "
)

UnaryExpr.Operator

View Source 
const (
	BooleanModeStr                           = " in boolean mode"
	NaturalLanguageModeStr                   = " in natural language mode"
	NaturalLanguageModeWithQueryExpansionStr = " in natural language mode with query expansion"
	QueryExpansionStr                        = " with query expansion"
)

MatchExpr.Option

View Source 
const (
	AscScr  = "asc"
	DescScr = "desc"
)

Order.Direction

View Source 
const (
	AttachStr     = "attach"
	DetachStr     = "detach"
	AttachListStr = "attachlist"
	ReshardStr    = "reshard"
	CleanupStr    = "cleanup"
)
View Source 
const (
	// DirectiveMultiShardAutocommit is the query comment directive to allow
	// single round trip autocommit with a multi-shard statement.
	DirectiveMultiShardAutocommit = "MULTI_SHARD_AUTOCOMMIT"
	// DirectiveSkipQueryPlanCache skips query plan cache when set.
	DirectiveSkipQueryPlanCache = "SKIP_QUERY_PLAN_CACHE"
	// DirectiveQueryTimeout sets a query timeout in vtgate. Only supported for SELECTS.
	DirectiveQueryTimeout = "QUERY_TIMEOUT_MS"
	// DirectiveScatterErrorsAsWarnings enables partial success scatter select queries
	DirectiveScatterErrorsAsWarnings = "SCATTER_ERRORS_AS_WARNINGS"
)
View Source 
const (
	// StartTxnStr represents the txn start transaction.
	StartTxnStr = "start transaction"

	// BeginTxnStr represents the txn begin.
	BeginTxnStr = "begin"

	// RollbackTxnStr represents the txn rollback.
	RollbackTxnStr = "rollback"

	// CommitTxnStr represents the txn commit.
	CommitTxnStr = "commit"
)
View Source 
const ADD = 57444
View Source 
const AGAINST = 57528
View Source 
const ALL = 57366
View Source 
const ALTER = 57440
View Source 
const ANALYZE = 57443
View Source 
const AND = 57413
View Source 
const APPROXNUM = 57499
View Source 
const AS = 57368
View Source 
const ASC = 57370
View Source 
const ATTACH = 57558
View Source 
const ATTACHLIST = 57559
View Source 
const AUTO_INCREMENT = 57498
View Source 
const BEGIN = 57549
View Source 
const BETWEEN = 57415
View Source 
const BIGINT = 57469
View Source 
const BINARY = 57435
View Source 
const BINLOG = 57508
View Source 
const BIT = 57463
View Source 
const BLOB = 57491
View Source 
const BOOL = 57482
View Source 
const BOOLEAN = 57529
View Source 
const BY = 57357
View Source 
const CASE = 57416
View Source 
const CAST = 57524
View Source 
const CHAR = 57480
View Source 
const CHARACTER = 57483
View Source 
const CHARSET = 57486
View Source 
const CHECKSUM = 57378
View Source 
const CLEANUP = 57562
View Source 
const COLLATE = 57434
View Source 
const COLUMN = 57454
View Source 
const COLUMNS = 57511
View Source 
const COMMENT = 57406
View Source 
const COMMENT_KEYWORD = 57407
View Source 
const COMMIT = 57552
View Source 
const CONVERT = 57523
View Source 
const CREATE = 57439
View Source 
const CROSS = 57393
View Source 
const CURRENT_DATE = 57515
View Source 
const CURRENT_TIME = 57516
View Source 
const CURRENT_TIMESTAMP = 57513
View Source 
const (
	CharacterSetStr = " character set"
)

this string is "character set" and this comment is required

View Source 
const DATABASE = 57514
View Source 
const DATABASES = 57503
View Source 
const DATE = 57458
View Source 
const DATETIME = 57478
View Source 
const DECIMAL = 57474
View Source 
const DEFAULT = 57374
View Source 
const DELETE = 57351
View Source 
const DESC = 57371
View Source 
const DESCRIBE = 57456
View Source 
const DETACH = 57560
View Source 
const DISTINCT = 57367
View Source 
const DISTRIBUTED = 57540
View Source 
const DIV = 57431
View Source 
const DOUBLE = 57472
View Source 
const DROP = 57441
View Source 
const DUPLICATE = 57373
View Source 
const ELSE = 57419
View Source 
const END = 57420
View Source 
const ENGINE = 57547
View Source 
const ENGINES = 57541
View Source 
const ENUM = 57496
View Source 
const ESCAPE = 57459
View Source 
const EVENTS = 57507
View Source 
const EXISTS = 57369
View Source 
const EXPANSION = 57533
View Source 
const EXPLAIN = 57457
View Source 
const FALSE = 57410
View Source 
const FIELDS = 57512
View Source 
const FLOAT = 57402
View Source 
const FLOAT_TYPE = 57473
View Source 
const FOR = 57360
View Source 
const FORCE = 57396
View Source 
const FROM = 57352
View Source 
const FULL = 57377
View Source 
const FULLTEXT = 57361
View Source 
const GE = 57422
View Source 
const GLOBAL = 57554
View Source 
const GROUP = 57354
View Source 
const GROUP_CONCAT = 57525
View Source 
const GTID = 57509
View Source 
const HASH = 57537
View Source 
const HAVING = 57355
View Source 
const HEX = 57399
View Source 
const HEXNUM = 57403
View Source 
const ID = 57398
View Source 
const IF = 57451
View Source 
const IGNORE = 57450
View Source 
const IN = 57428
View Source 
const INDEX = 57447
View Source 
const INNER = 57391
View Source 
const INSERT = 57349
View Source 
const INT = 57467
View Source 
const INTEGER = 57468
View Source 
const INTEGRAL = 57401
View Source 
const INTERVAL = 57436
View Source 
const INTNUM = 57470
View Source 
const INTO = 57372
View Source 
const IS = 57425
View Source 
const JOIN = 57387
View Source 
const JSON = 57495
View Source 
const JSON_EXTRACT_OP = 57437
View Source 
const JSON_UNQUOTE_EXTRACT_OP = 57438
View Source 
const KEY = 57365
View Source 
const KILL = 57546
View Source 
const LANGUAGE = 57530
View Source 
const LAST_INSERT_ID = 57380
View Source 
const LE = 57421
View Source 
const LEFT = 57389
View Source 
const LEX_ERROR = 57346
View Source 
const LIKE = 57426
View Source 
const LIMIT = 57358
View Source 
const LIST = 57538
View Source 
const LIST_ARG = 57405
View Source 
const LOCALTIME = 57517
View Source 
const LOCALTIMESTAMP = 57518
View Source 
const LOCK = 57376
View Source 
const LONGBLOB = 57494
View Source 
const LONGTEXT = 57490
View Source 
const MATCH = 57527
View Source 
const MEDIUMBLOB = 57493
View Source 
const MEDIUMINT = 57466
View Source 
const MEDIUMTEXT = 57489
View Source 
const MOD = 57432
View Source 
const MODE = 57384
View Source 
const MODIFY = 57445
View Source 
const NAMES = 57556
View Source 
const NATURAL = 57394
View Source 
const NCHAR = 57485
View Source 
const NE = 57423
View Source 
const NEXT = 57381
View Source 
const NGRAM = 57363
View Source 
const NOT = 57414
View Source 
const NULL = 57408
View Source 
const NULLX = 57497
View Source 
const NULL_SAFE_EQUAL = 57424
View Source 
const NUMERIC = 57475
View Source 
const OFF = 57411
View Source 
const OFFSET = 57359
View Source 
const ON = 57397
View Source 
const OPTIMIZE = 57461
View Source 
const OR = 57412
View Source 
const ORDER = 57356
View Source 
const OUTER = 57392
View Source 
const PARSER = 57362
View Source 
const PARTITION = 57535
View Source 
const PARTITIONS = 57536
View Source 
const PRIMARY = 57453
View Source 
const PROCESSLIST = 57543
View Source 
const QUERY = 57532
View Source 
const QUERYZ = 57544
View Source 
const RADON = 57557
View Source 
const REAL = 57471
View Source 
const REGEXP = 57427
View Source 
const RENAME = 57442
View Source 
const REPAIR = 57460
View Source 
const REPLACE = 57522
View Source 
const RESHARD = 57561
View Source 
const RIGHT = 57390
View Source 
const ROLLBACK = 57553
View Source 
const SELECT = 57348
View Source 
const SEPARATOR = 57526
View Source 
const SESSION = 57555
View Source 
const SET = 57375
View Source 
const SHARE = 57383
View Source 
const SHIFT_LEFT = 57429
View Source 
const SHIFT_RIGHT = 57430
View Source 
const SHOW = 57455
View Source 
const SIGNED = 57500
View Source 
const SINGLE = 57548
View Source 
const SMALLINT = 57465
View Source 
const SQL_CACHE = 57386
View Source 
const SQL_NO_CACHE = 57385
View Source 
const START = 57550
View Source 
const STATUS = 57510
View Source 
const STRAIGHT_JOIN = 57388
View Source 
const STRING = 57400
View Source 
const TABLE = 57446
View Source 
const TABLES = 57504
View Source 
const TEXT = 57487
View Source 
const THEN = 57418
View Source 
const TIME = 57476
View Source 
const TIMESTAMP = 57477
View Source 
const TINYBLOB = 57492
View Source 
const TINYINT = 57464
View Source 
const TINYTEXT = 57488
View Source 
const TO = 57449
View Source 
const TRANSACTION = 57551
View Source 
const TRUE = 57409
View Source 
const TRUNCATE = 57462
View Source 
const TXNZ = 57545
View Source 
const UNARY = 57433
View Source 
const UNION = 57347
View Source 
const UNIQUE = 57364
View Source 
const UNSIGNED = 57501
View Source 
const UNUSED = 57534
View Source 
const UPDATE = 57350
View Source 
const USE = 57395
View Source 
const USING = 57452
View Source 
const UTC_DATE = 57519
View Source 
const UTC_TIME = 57520
View Source 
const UTC_TIMESTAMP = 57521
View Source 
const VALUE = 57382
View Source 
const VALUES = 57379
View Source 
const VALUE_ARG = 57404
View Source 
const VARBINARY = 57484
View Source 
const VARCHAR = 57481
View Source 
const VARIABLES = 57506
View Source 
const VERSIONS = 57542
View Source 
const VIEW = 57448
View Source 
const WARNINGS = 57505
View Source 
const WHEN = 57417
View Source 
const WHERE = 57353
View Source 
const WITH = 57531
View Source 
const XA = 57539
View Source 
const YEAR = 57479
View Source 
const ZEROFILL = 57502

Variables

View Source 
var Aggregates = map[string]bool{
	"avg":          true,
	"bit_and":      true,
	"bit_or":       true,
	"bit_xor":      true,
	"count":        true,
	"group_concat": true,
	"max":          true,
	"min":          true,
	"std":          true,
	"stddev_pop":   true,
	"stddev_samp":  true,
	"stddev":       true,
	"sum":          true,
	"var_pop":      true,
	"var_samp":     true,
	"variance":     true,
}

Aggregates is a map of all aggregate functions.

Functions

func Append 

func Append(buf *strings.Builder, node SQLNode)

Append appends the SQLNode to the buffer.

func Backtick 

func Backtick(in string) string

Backtick produces a backticked literal given an input string.

func EncodeValue 

func EncodeValue(buf *strings.Builder, value *querypb.BindVariable)

EncodeValue encodes one bind variable value into the query.

func ExtractMysqlComment 

func ExtractMysqlComment(sql string) (version string, innerSQL string)

ExtractMysqlComment extracts the version and SQL from a comment-only query such as /*!50708 sql here */

func FetchBindVar 

func FetchBindVar(name string, bindVariables map[string]*querypb.BindVariable) (val *querypb.BindVariable, isList bool, err error)

FetchBindVar resolves the bind variable by fetching it from bindVariables.

func FormatImpossibleQuery 

func FormatImpossibleQuery(buf *TrackedBuffer, node SQLNode)

FormatImpossibleQuery creates an impossible query in a TrackedBuffer. An impossible query is a modified version of a query where all selects have where clauses that are impossible for mysql to resolve. This is used in the vtgate and vttablet:

- In the vtgate it's used for joins: if the first query returns no result, then vtgate uses the impossible query just to fetch field info from vttablet - In the vttablet, it's just an optimization: the field info is fetched once form MySQL, cached and reused for subsequent queries

func GetBindvars 

func GetBindvars(stmt Statement) map[string]struct{}

GetBindvars returns a map of the bind vars referenced in the statement. TODO(sougou); This function gets called again from vtgate/planbuilder. Ideally, this should be done only once.

func IsColName 

func IsColName(node Expr) bool

IsColName returns true if the Expr is a *ColName.

func IsDML 

func IsDML(sql string) bool

IsDML returns true if the query is an INSERT, UPDATE or DELETE statement.

func IsNull 

func IsNull(node Expr) bool

IsNull returns true if the Expr is SQL NULL

func IsSimpleTuple 

func IsSimpleTuple(node Expr) bool

IsSimpleTuple returns true if the Expr is a ValTuple that contains simple values or if it's a list arg.

func IsValue 

func IsValue(node Expr) bool

IsValue returns true if the Expr is a string, integral or value arg. NULL is not considered to be a value.

func NewPlanValue 

func NewPlanValue(node Expr) (sqltypes.PlanValue, error)

NewPlanValue builds a sqltypes.PlanValue from an Expr.

func Normalize 

func Normalize(stmt Statement, bindVars map[string]*querypb.BindVariable, prefix string)

Normalize changes the statement to use bind values, and updates the bind vars to those values. The supplied prefix is used to generate the bind var names. The function ensures that there are no collisions with existing bind vars.

func Preview 

func Preview(sql string) int

Preview analyzes the beginning of the query using a simpler and faster textual comparison to identify the statement type.

func SkipQueryPlanCacheDirective 

func SkipQueryPlanCacheDirective(stmt Statement) bool

SkipQueryPlanCacheDirective returns true if skip query plan cache directive is set to true in query.

func String 

func String(node SQLNode) string

String returns a string representation of an SQLNode.

func StringIn 

func StringIn(str string, values ...string) bool

StringIn is a convenience function that returns true if str matches any of the values.

func StripComments 

func StripComments(sql string) string

StripComments removes all comments from the string regardless of where they occur

func StripLeadingComments 

func StripLeadingComments(sql string) string

StripLeadingComments trims the SQL string and removes any leading comments

func Walk 

func Walk(visit Visit, nodes ...SQLNode) error

Walk calls visit on every node. If visit returns true, the underlying nodes are also visited. If it returns an error, walking is interrupted, and the error is returned.

Types

type AliasedExpr 

type AliasedExpr struct {
	Expr Expr
	As   ColIdent
}

AliasedExpr defines an aliased SELECT expression.

func (*AliasedExpr) Format 

func (node *AliasedExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*AliasedExpr) WalkSubtree 

func (node *AliasedExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type AliasedTableExpr 

type AliasedTableExpr struct {
	Expr  SimpleTableExpr
	As    TableIdent
	Hints *IndexHints
}

AliasedTableExpr represents a table expression coupled with an optional alias or index hint. If As is empty, no alias was used.

func (*AliasedTableExpr) Format 

func (node *AliasedTableExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*AliasedTableExpr) WalkSubtree 

func (node *AliasedTableExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type AndExpr 

type AndExpr struct {
	Left, Right Expr
}

AndExpr represents an AND expression.

func (*AndExpr) Format 

func (node *AndExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*AndExpr) WalkSubtree 

func (node *AndExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type BinaryExpr 

type BinaryExpr struct {
	Operator    string
	Left, Right Expr
}

BinaryExpr represents a binary value expression.

func (*BinaryExpr) Format 

func (node *BinaryExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*BinaryExpr) WalkSubtree 

func (node *BinaryExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type BoolVal 

type BoolVal bool

BoolVal is true or false.

func (BoolVal) Format 

func (node BoolVal) Format(buf *TrackedBuffer)

Format formats the node.

func (BoolVal) WalkSubtree 

func (node BoolVal) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type CaseExpr 

type CaseExpr struct {
	Expr  Expr
	Whens []*When
	Else  Expr
}

CaseExpr represents a CASE expression.

func (*CaseExpr) Format 

func (node *CaseExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*CaseExpr) WalkSubtree 

func (node *CaseExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Checksum 

type Checksum struct {
	Table TableName
}

Checksum represents a CHECKSUM statement.

func (*Checksum) Format 

func (node *Checksum) Format(buf *TrackedBuffer)

Format formats the node.

func (*Checksum) WalkSubtree 

func (node *Checksum) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ColIdent 

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

ColIdent is a case insensitive SQL identifier. It will be escaped with backquotes if necessary.

func NewColIdent 

func NewColIdent(str string) ColIdent

NewColIdent makes a new ColIdent.

func (ColIdent) CompliantName 

func (node ColIdent) CompliantName() string

CompliantName returns a compliant id name that can be used for a bind var.

func (ColIdent) Equal 

func (node ColIdent) Equal(in ColIdent) bool

Equal performs a case-insensitive compare.

func (ColIdent) EqualString 

func (node ColIdent) EqualString(str string) bool

EqualString performs a case-insensitive compare with str.

func (ColIdent) Format 

func (node ColIdent) Format(buf *TrackedBuffer)

Format formats the node.

func (ColIdent) IsEmpty 

func (node ColIdent) IsEmpty() bool

IsEmpty returns true if the name is empty.

func (ColIdent) Lowered 

func (node ColIdent) Lowered() string

Lowered returns a lower-cased column name. This function should generally be used only for optimizing comparisons.

func (ColIdent) MarshalJSON 

func (node ColIdent) MarshalJSON() ([]byte, error)

MarshalJSON marshals into JSON.

func (ColIdent) String 

func (node ColIdent) String() string

String returns the unescaped column name. It must not be used for SQL generation. Use sqlparser.String instead. The Stringer conformance is for usage in templates.

func (*ColIdent) UnmarshalJSON 

func (node *ColIdent) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals from JSON.

func (ColIdent) WalkSubtree 

func (node ColIdent) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ColName 

type ColName struct {
	// Metadata is not populated by the parser.
	// It's a placeholder for analyzers to store
	// additional data, typically info about which
	// table or column this node references.
	Metadata  interface{}
	Name      ColIdent
	Qualifier TableName
}

ColName represents a column name.

func (*ColName) Equal 

func (node *ColName) Equal(c *ColName) bool

Equal returns true if the column names match.

func (*ColName) Format 

func (node *ColName) Format(buf *TrackedBuffer)

Format formats the node.

func (*ColName) WalkSubtree 

func (node *ColName) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ColTuple 

type ColTuple interface {
	Expr
	// contains filtered or unexported methods
}

ColTuple represents a list of column values. It can be ValTuple, Subquery, ListArg.

type CollateExpr 

type CollateExpr struct {
	Expr    Expr
	Charset string
}

CollateExpr represents dynamic collate operator.

func (*CollateExpr) Format 

func (node *CollateExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*CollateExpr) WalkSubtree 

func (node *CollateExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ColumnDefinition 

type ColumnDefinition struct {
	Name ColIdent
	Type ColumnType
}

ColumnDefinition describes a column in a CREATE TABLE statement

func (*ColumnDefinition) Format 

func (col *ColumnDefinition) Format(buf *TrackedBuffer)

Format formats the node.

func (*ColumnDefinition) WalkSubtree 

func (col *ColumnDefinition) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ColumnOpt 

type ColumnOpt int
const (
	ColumnOptionNone ColumnOpt = iota

	// NotNull enum.
	ColumnOptionNotNull

	// Autoincrement enum.
	ColumnOptionAutoincrement

	// Default enum.
	ColumnOptionDefault

	// Comment enum.
	ColumnOptionComment

	// OnUpdate enum
	ColumnOptionOnUpdate

	// PrimarykeyOption enum.
	ColumnOptionKeyPrimaryOpt

	// UniquekeyOption enum.
	ColumnOptionKeyUniqueOpt
)

type ColumnOption 

type ColumnOption struct {

	// Generic field options.
	NotNull       BoolVal
	Autoincrement BoolVal
	Default       *SQLVal
	Comment       *SQLVal
	OnUpdate      *SQLVal
	// Key specification
	PrimaryKeyOpt ColumnPrimaryKeyOption
	UniqueKeyOpt  ColumnUniqueKeyOption
	// contains filtered or unexported fields
}

func (ColumnOption) GetOptType 

func (col ColumnOption) GetOptType() ColumnOpt

type ColumnOptionList 

type ColumnOptionList []*ColumnOption

type ColumnOptionListOpt 

type ColumnOptionListOpt struct {
	ColOptList ColumnOptionList
}

func (*ColumnOptionListOpt) GetColumnOption 

func (co *ColumnOptionListOpt) GetColumnOption(opt ColumnOpt) *ColumnOption

type ColumnPrimaryKeyOption 

type ColumnPrimaryKeyOption int

ColumnPrimaryKeyOption and ColumnUniqueKeyOption indicates whether or not the given column is defined as an index element and contains the type of the option 

const (
	// ColKeyPrimaryNone enum.
	ColKeyPrimaryNone ColumnPrimaryKeyOption = iota

	// ColKeyPrimary enum.
	ColKeyPrimary
)

type ColumnType 

type ColumnType struct {
	// The base type string
	Type string

	// Generic field options.
	NotNull       BoolVal
	Autoincrement BoolVal
	Default       *SQLVal
	OnUpdate      *SQLVal
	Comment       *SQLVal

	// Numeric field options
	Length   *SQLVal
	Unsigned BoolVal
	Zerofill BoolVal
	Scale    *SQLVal

	// Text field options
	Charset string
	Collate string

	// Enum values
	EnumValues []string

	// Key specification
	PrimaryKeyOpt ColumnPrimaryKeyOption
	UniqueKeyOpt  ColumnUniqueKeyOption
}

ColumnType represents a sql type in a CREATE TABLE statement All optional fields are nil if not specified

func (*ColumnType) Format 

func (ct *ColumnType) Format(buf *TrackedBuffer)

Format returns a canonical string representation of the type and all relevant options

func (*ColumnType) WalkSubtree 

func (ct *ColumnType) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ColumnUniqueKeyOption 

type ColumnUniqueKeyOption int
const (
	// ColUniqueKeyNone enum.
	ColKeyUniqueNone ColumnUniqueKeyOption = iota

	// ColKeyUniqueKey enum.
	ColKeyUniqueKey
)

type Columns 

type Columns []ColIdent

Columns represents an insert column list.

func (Columns) FindColumn 

func (node Columns) FindColumn(col ColIdent) int

FindColumn finds a column in the column list, returning the index if it exists or -1 otherwise

func (Columns) Format 

func (node Columns) Format(buf *TrackedBuffer)

Format formats the node.

func (Columns) WalkSubtree 

func (node Columns) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type CommentDirectives 

type CommentDirectives map[string]interface{}

CommentDirectives is the parsed representation for execution directives conveyed in query comments

func ExtractCommentDirectives 

func ExtractCommentDirectives(comments Comments) CommentDirectives

ExtractCommentDirectives parses the comment list for any execution directives of the form: 

/*vt+ OPTION_ONE=1 OPTION_TWO OPTION_THREE=abcd */

It returns the map of the directive values or nil if there aren't any.

func (CommentDirectives) IsSet 

func (d CommentDirectives) IsSet(key string) bool

IsSet checks the directive map for the named directive and returns true if the directive is set and has a true/false or 0/1 value

type Comments 

type Comments [][]byte

Comments represents a list of comments.

func (Comments) Format 

func (node Comments) Format(buf *TrackedBuffer)

Format formats the node.

func (Comments) WalkSubtree 

func (node Comments) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ComparisonExpr 

type ComparisonExpr struct {
	Operator    string
	Left, Right Expr
	Escape      Expr
}

ComparisonExpr represents a two-value comparison expression.

func (*ComparisonExpr) Format 

func (node *ComparisonExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*ComparisonExpr) WalkSubtree 

func (node *ComparisonExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ConvertExpr 

type ConvertExpr struct {
	Expr Expr
	Type *ConvertType
}

ConvertExpr represents a call to CONVERT(expr, type) or it's equivalent CAST(expr AS type). Both are rewritten to the former.

func (*ConvertExpr) Format 

func (node *ConvertExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*ConvertExpr) WalkSubtree 

func (node *ConvertExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ConvertType 

type ConvertType struct {
	Type     string
	Length   *SQLVal
	Scale    *SQLVal
	Operator string
	Charset  string
}

ConvertType represents the type in call to CONVERT(expr, type)

func (*ConvertType) Format 

func (node *ConvertType) Format(buf *TrackedBuffer)

Format formats the node.

func (*ConvertType) WalkSubtree 

func (node *ConvertType) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ConvertUsingExpr 

type ConvertUsingExpr struct {
	Expr Expr
	Type string
}

ConvertUsingExpr represents a call to CONVERT(expr USING charset).

func (*ConvertUsingExpr) Format 

func (node *ConvertUsingExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*ConvertUsingExpr) WalkSubtree 

func (node *ConvertUsingExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type DDL 

type DDL struct {
	Action          string
	Engine          string
	Charset         string
	IndexName       string
	PartitionName   string
	BackendName     string
	IfExists        bool
	IfNotExists     bool
	Table           TableName
	NewName         TableName
	Database        TableIdent
	DatabaseOptions DatabaseOptionListOpt
	TableSpec       *TableSpec

	// Tables is set if Action is DropStr.
	Tables TableNames

	// table column operation
	DropColumnName  string
	ModifyColumnDef *ColumnDefinition

	// Partition options.
	PartitionOptions PartitionOptions
	PartitionNum     *SQLVal
}

DDL represents a CREATE, ALTER, DROP or RENAME statement. Table is set for AlterStr, DropStr, RenameStr. NewName is set for AlterStr, CreateStr, RenameStr.

func (*DDL) Format 

func (node *DDL) Format(buf *TrackedBuffer)

Format formats the node.

func (*DDL) WalkSubtree 

func (node *DDL) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type DatabaseOption 

type DatabaseOption struct {
	Value            string
	CharsetOrCollate string
}

DatabaseOption represents database option. See: https://dev.mysql.com/doc/refman/5.7/en/create-database.html

type DatabaseOptionList 

type DatabaseOptionList []*DatabaseOption

type DatabaseOptionListOpt 

type DatabaseOptionListOpt struct {
	DBOptList DatabaseOptionList
}

func (DatabaseOptionListOpt) Format 

func (optList DatabaseOptionListOpt) Format(buf *TrackedBuffer)

Format formats the node

type Default 

type Default struct {
	ColName string
}

Default represents a DEFAULT expression.

func (*Default) Format 

func (node *Default) Format(buf *TrackedBuffer)

Format formats the node.

func (*Default) WalkSubtree 

func (node *Default) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Delete 

type Delete struct {
	Comments Comments
	Table    TableName
	Where    *Where
	OrderBy  OrderBy
	Limit    *Limit
}

Delete represents a DELETE statement.

func (*Delete) Format 

func (node *Delete) Format(buf *TrackedBuffer)

Format formats the node.

func (*Delete) WalkSubtree 

func (node *Delete) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Encodable 

type Encodable interface {
	EncodeSQL(buf *strings.Builder)
}

Encodable defines the interface for types that can be custom-encoded into SQL.

type ExistsExpr 

type ExistsExpr struct {
	Subquery *Subquery
}

ExistsExpr represents an EXISTS expression.

func (*ExistsExpr) Format 

func (node *ExistsExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*ExistsExpr) WalkSubtree 

func (node *ExistsExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Explain 

type Explain struct {
}

Explain represents a explain statement.

func (*Explain) Format 

func (node *Explain) Format(buf *TrackedBuffer)

Format formats the node.

func (*Explain) WalkSubtree 

func (node *Explain) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Expr 

type Expr interface {
	SQLNode
	// contains filtered or unexported methods
}

Expr represents an expression.

func CloneExpr 

func CloneExpr(node Expr) Expr

CloneExpr used to copy a new Expr.

func ReplaceExpr 

func ReplaceExpr(root, from, to Expr) Expr

ReplaceExpr finds the from expression from root and replaces it with to. If from matches root, then to is returned.

type Exprs 

type Exprs []Expr

Exprs represents a list of value expressions. It's not a valid expression because it's not parenthesized.

func (Exprs) Format 

func (node Exprs) Format(buf *TrackedBuffer)

Format formats the node.

func (Exprs) WalkSubtree 

func (node Exprs) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type FuncExpr 

type FuncExpr struct {
	Qualifier TableIdent
	Name      ColIdent
	Distinct  bool
	Exprs     SelectExprs
}

FuncExpr represents a function call.

func (*FuncExpr) Format 

func (node *FuncExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*FuncExpr) IsAggregate 

func (node *FuncExpr) IsAggregate() bool

IsAggregate returns true if the function is an aggregate.

func (*FuncExpr) WalkSubtree 

func (node *FuncExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type GroupBy 

type GroupBy []Expr

GroupBy represents a GROUP BY clause.

func (GroupBy) Format 

func (node GroupBy) Format(buf *TrackedBuffer)

Format formats the node.

func (GroupBy) WalkSubtree 

func (node GroupBy) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type GroupConcatExpr 

type GroupConcatExpr struct {
	Distinct  string
	Exprs     SelectExprs
	OrderBy   OrderBy
	Separator string
}

GroupConcatExpr represents a call to GROUP_CONCAT

func (*GroupConcatExpr) Format 

func (node *GroupConcatExpr) Format(buf *TrackedBuffer)

Format formats the node

func (*GroupConcatExpr) WalkSubtree 

func (node *GroupConcatExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type IndexColumn 

type IndexColumn struct {
	Column ColIdent
	Length *SQLVal
}

IndexColumn describes a column in an index definition with optional length

type IndexDefinition 

type IndexDefinition struct {
	Info    *IndexInfo
	Columns []*IndexColumn
}

IndexDefinition describes an index in a CREATE TABLE statement

func (*IndexDefinition) Format 

func (idx *IndexDefinition) Format(buf *TrackedBuffer)

Format formats the node.

func (*IndexDefinition) WalkSubtree 

func (idx *IndexDefinition) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type IndexHints 

type IndexHints struct {
	Type    string
	Indexes []ColIdent
}

IndexHints represents a list of index hints.

func (*IndexHints) Format 

func (node *IndexHints) Format(buf *TrackedBuffer)

Format formats the node.

func (*IndexHints) WalkSubtree 

func (node *IndexHints) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type IndexInfo 

type IndexInfo struct {
	Type     string
	Name     ColIdent
	Primary  bool
	Unique   bool
	Fulltext bool
}

IndexInfo describes the name and type of an index in a CREATE TABLE statement

func (*IndexInfo) Format 

func (ii *IndexInfo) Format(buf *TrackedBuffer)

Format formats the node.

func (*IndexInfo) WalkSubtree 

func (ii *IndexInfo) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Insert 

type Insert struct {
	Action   string
	Comments Comments
	Ignore   string
	Table    TableName
	Columns  Columns
	Rows     InsertRows
	OnDup    OnDup
}

Insert represents an INSERT or REPLACE statement. Per the MySQL docs, http://dev.mysql.com/doc/refman/5.7/en/replace.html Replace is the counterpart to `INSERT IGNORE`, and works exactly like a normal INSERT except if the row exists. In that case it first deletes the row and re-inserts with new values. For that reason we keep it as an Insert struct. Replaces are currently disallowed in sharded schemas because of the implications the deletion part may have on vindexes.

func (*Insert) Format 

func (node *Insert) Format(buf *TrackedBuffer)

Format formats the node.

func (*Insert) WalkSubtree 

func (node *Insert) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type InsertRows 

type InsertRows interface {
	SQLNode
	// contains filtered or unexported methods
}

InsertRows represents the rows for an INSERT statement.

type InsertValues 

type InsertValues [][]sqltypes.Value

InsertValues is a custom SQL encoder for the values of an insert statement.

func (InsertValues) EncodeSQL 

func (iv InsertValues) EncodeSQL(buf *strings.Builder)

EncodeSQL performs the SQL encoding for InsertValues.

type IntervalExpr 

type IntervalExpr struct {
	Expr Expr
	Unit string
}

IntervalExpr represents a date-time INTERVAL expression.

func (*IntervalExpr) Format 

func (node *IntervalExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*IntervalExpr) WalkSubtree 

func (node *IntervalExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type IsExpr 

type IsExpr struct {
	Operator string
	Expr     Expr
}

IsExpr represents an IS ... or an IS NOT ... expression.

func (*IsExpr) Format 

func (node *IsExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*IsExpr) WalkSubtree 

func (node *IsExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type JoinTableExpr 

type JoinTableExpr struct {
	LeftExpr  TableExpr
	Join      string
	RightExpr TableExpr
	On        Expr
}

JoinTableExpr represents a TableExpr that's a JOIN operation.

func (*JoinTableExpr) Format 

func (node *JoinTableExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*JoinTableExpr) WalkSubtree 

func (node *JoinTableExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Kill 

type Kill struct {
	QueryID *NumVal
}

Kill represents a KILL statement.

func (*Kill) Format 

func (node *Kill) Format(buf *TrackedBuffer)

Format formats the node.

func (*Kill) WalkSubtree 

func (node *Kill) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type LengthScaleOption 

type LengthScaleOption struct {
	Length *SQLVal
	Scale  *SQLVal
}

LengthScaleOption is used for types that have an optional length and scale

type Limit 

type Limit struct {
	Offset, Rowcount Expr
}

Limit represents a LIMIT clause.

func (*Limit) Format 

func (node *Limit) Format(buf *TrackedBuffer)

Format formats the node.

func (*Limit) WalkSubtree 

func (node *Limit) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ListArg 

type ListArg []byte

ListArg represents a named list argument.

func (ListArg) Format 

func (node ListArg) Format(buf *TrackedBuffer)

Format formats the node.

func (ListArg) WalkSubtree 

func (node ListArg) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type MarginComments 

type MarginComments struct {
	Leading  string
	Trailing string
}

MarginComments holds the leading and trailing comments that surround a query.

func SplitMarginComments 

func SplitMarginComments(sql string) (query string, comments MarginComments)

SplitMarginComments pulls out any leading or trailing comments from a raw sql query. This function also trims leading (if there's a comment) and trailing whitespace.

type MatchExpr 

type MatchExpr struct {
	Columns SelectExprs
	Expr    Expr
	Option  string
}

MatchExpr represents a call to the MATCH function

func (*MatchExpr) Format 

func (node *MatchExpr) Format(buf *TrackedBuffer)

Format formats the node

func (*MatchExpr) WalkSubtree 

func (node *MatchExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Nextval 

type Nextval struct {
	Expr Expr
}

Nextval defines the NEXT VALUE expression.

func (Nextval) Format 

func (node Nextval) Format(buf *TrackedBuffer)

Format formats the node.

func (Nextval) WalkSubtree 

func (node Nextval) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type NodeFormatter 

type NodeFormatter func(buf *TrackedBuffer, node SQLNode)

NodeFormatter defines the signature of a custom node formatter function that can be given to TrackedBuffer for code generation.

type NotExpr 

type NotExpr struct {
	Expr Expr
}

NotExpr represents a NOT expression.

func (*NotExpr) Format 

func (node *NotExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*NotExpr) WalkSubtree 

func (node *NotExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type NullVal 

type NullVal struct{}

NullVal represents a NULL value.

func (*NullVal) Format 

func (node *NullVal) Format(buf *TrackedBuffer)

Format formats the node.

func (*NullVal) WalkSubtree 

func (node *NullVal) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type NumVal 

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

NumVal represents numval tuple.

func (*NumVal) AsUint64 

func (exp *NumVal) AsUint64() uint64

AsUint64 returns uint64 value.

type OnDup 

type OnDup UpdateExprs

OnDup represents an ON DUPLICATE KEY clause.

func (OnDup) Format 

func (node OnDup) Format(buf *TrackedBuffer)

Format formats the node.

func (OnDup) WalkSubtree 

func (node OnDup) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type OrExpr 

type OrExpr struct {
	Left, Right Expr
}

OrExpr represents an OR expression.

func (*OrExpr) Format 

func (node *OrExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*OrExpr) WalkSubtree 

func (node *OrExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Order 

type Order struct {
	Expr      Expr
	Direction string
}

Order represents an ordering expression.

func (*Order) Format 

func (node *Order) Format(buf *TrackedBuffer)

Format formats the node.

func (*Order) WalkSubtree 

func (node *Order) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type OrderBy 

type OrderBy []*Order

OrderBy represents an ORDER By clause.

func (OrderBy) Format 

func (node OrderBy) Format(buf *TrackedBuffer)

Format formats the node.

func (OrderBy) WalkSubtree 

func (node OrderBy) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type OtherAdmin 

type OtherAdmin struct{}

OtherAdmin represents a misc statement that relies on ADMIN privileges, such as REPAIR, OPTIMIZE, or TRUNCATE statement. It should be used only as an indicator. It does not contain the full AST for the statement.

func (*OtherAdmin) Format 

func (node *OtherAdmin) Format(buf *TrackedBuffer)

Format formats the node.

func (*OtherAdmin) WalkSubtree 

func (node *OtherAdmin) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type OtherRead 

type OtherRead struct{}

OtherRead represents a DESCRIBE, or EXPLAIN statement. It should be used only as an indicator. It does not contain the full AST for the statement.

func (*OtherRead) Format 

func (node *OtherRead) Format(buf *TrackedBuffer)

Format formats the node.

func (*OtherRead) WalkSubtree 

func (node *OtherRead) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ParenExpr 

type ParenExpr struct {
	Expr Expr
}

ParenExpr represents a parenthesized boolean expression.

func (*ParenExpr) Format 

func (node *ParenExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*ParenExpr) WalkSubtree 

func (node *ParenExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ParenSelect 

type ParenSelect struct {
	Select SelectStatement
}

ParenSelect is a parenthesized SELECT statement.

func (*ParenSelect) AddOrder 

func (node *ParenSelect) AddOrder(order *Order)

AddOrder adds an order by element

func (*ParenSelect) Format 

func (node *ParenSelect) Format(buf *TrackedBuffer)

Format formats the node.

func (*ParenSelect) SetLimit 

func (node *ParenSelect) SetLimit(limit *Limit)

SetLimit sets the limit clause

func (*ParenSelect) WalkSubtree 

func (node *ParenSelect) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ParenTableExpr 

type ParenTableExpr struct {
	Exprs TableExprs
}

ParenTableExpr represents a parenthesized list of TableExpr.

func (*ParenTableExpr) Format 

func (node *ParenTableExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*ParenTableExpr) WalkSubtree 

func (node *ParenTableExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ParsedQuery 

type ParsedQuery struct {
	Query string
	// contains filtered or unexported fields
}

ParsedQuery represents a parsed query where bind locations are precompued for fast substitutions.

func BuildParsedQuery 

func BuildParsedQuery(in string, vars ...interface{}) *ParsedQuery

BuildParsedQuery builds a ParsedQuery from the input.

func NewParsedQuery 

func NewParsedQuery(node SQLNode) *ParsedQuery

NewParsedQuery returns a ParsedQuery of the ast.

func (*ParsedQuery) GenerateQuery 

func (pq *ParsedQuery) GenerateQuery(bindVariables map[string]*querypb.BindVariable, extras map[string]Encodable) (string, error)

GenerateQuery generates a query by substituting the specified bindVariables. The extras parameter specifies special parameters that can perform custom encoding.

func (*ParsedQuery) MarshalJSON 

func (pq *ParsedQuery) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshaler for ParsedQuery. Note that any queries longer that 512 bytes will be truncated.

type PartitionDefinition 

type PartitionDefinition struct {
	Backend string
	Row     ValTuple
}

PartitionDefinition defines a single partition.

type PartitionOptions 

type PartitionOptions []*PartitionDefinition

PartitionOptions specifies the partition options.

type Radon 

type Radon struct {
	Action  string
	Row     ValTuple
	Table   TableName
	NewName TableName
}

Radon represents the radon statement.

func (*Radon) Format 

func (node *Radon) Format(buf *TrackedBuffer)

Format formats the node.

func (*Radon) WalkSubtree 

func (node *Radon) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type RangeCond 

type RangeCond struct {
	Operator string
	Left     Expr
	From, To Expr
}

RangeCond represents a BETWEEN or a NOT BETWEEN expression.

func (*RangeCond) Format 

func (node *RangeCond) Format(buf *TrackedBuffer)

Format formats the node.

func (*RangeCond) WalkSubtree 

func (node *RangeCond) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type SQLNode 

type SQLNode interface {
	Format(buf *TrackedBuffer)
	// WalkSubtree calls visit on all underlying nodes
	// of the subtree, but not the current one. Walking
	// must be interrupted if visit returns an error.
	WalkSubtree(visit Visit) error
}

SQLNode defines the interface for all nodes generated by the parser.

type SQLVal 

type SQLVal struct {
	Type ValType
	Val  []byte
}

SQLVal represents a single value.

func NewFloatVal 

func NewFloatVal(in []byte) *SQLVal

NewFloatVal builds a new FloatVal.

func NewHexNum 

func NewHexNum(in []byte) *SQLVal

NewHexNum builds a new HexNum.

func NewHexVal 

func NewHexVal(in []byte) *SQLVal

NewHexVal builds a new HexVal.

func NewIntVal 

func NewIntVal(in []byte) *SQLVal

NewIntVal builds a new IntVal.

func NewStrVal 

func NewStrVal(in []byte) *SQLVal

NewStrVal builds a new StrVal.

func NewStrValWithoutQuote 

func NewStrValWithoutQuote(in []byte) *SQLVal

NewStrValWithoutQuote builds a new string that will be output without quote later in Format.

func NewValArg 

func NewValArg(in []byte) *SQLVal

NewValArg builds a new ValArg.

func (*SQLVal) Format 

func (node *SQLVal) Format(buf *TrackedBuffer)

Format formats the node.

func (*SQLVal) HexDecode 

func (node *SQLVal) HexDecode() ([]byte, error)

HexDecode decodes the hexval into bytes.

func (*SQLVal) WalkSubtree 

func (node *SQLVal) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Select 

type Select struct {
	Cache       string
	Comments    Comments
	Distinct    string
	Hints       string
	SelectExprs SelectExprs
	From        TableExprs
	Where       *Where
	GroupBy     GroupBy
	Having      *Where
	OrderBy     OrderBy
	Limit       *Limit
	Lock        string
	ForBackup   string
}

Select represents a SELECT statement.

func (*Select) AddHaving 

func (node *Select) AddHaving(expr Expr)

AddHaving adds the boolean expression to the HAVING clause as an AND condition. If the expression is an OR clause, it parenthesizes it. Currently, the OR operator is the only one that's lower precedence than AND.

func (*Select) AddOrder 

func (node *Select) AddOrder(order *Order)

AddOrder adds an order by element

func (*Select) AddWhere 

func (node *Select) AddWhere(expr Expr)

AddWhere adds the boolean expression to the WHERE clause as an AND condition. If the expression is an OR clause, it parenthesizes it. Currently, the OR operator is the only one that's lower precedence than AND.

func (*Select) Format 

func (node *Select) Format(buf *TrackedBuffer)

Format formats the node.

func (*Select) SetLimit 

func (node *Select) SetLimit(limit *Limit)

SetLimit sets the limit clause

func (*Select) WalkSubtree 

func (node *Select) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type SelectExpr 

type SelectExpr interface {
	SQLNode
	// contains filtered or unexported methods
}

SelectExpr represents a SELECT expression.

func CloneSelectExpr 

func CloneSelectExpr(node SelectExpr) SelectExpr

CloneSelectExpr used to copy a new SelectExpr.

type SelectExprs 

type SelectExprs []SelectExpr

SelectExprs represents SELECT expressions.

func (SelectExprs) Format 

func (node SelectExprs) Format(buf *TrackedBuffer)

Format formats the node.

func (SelectExprs) WalkSubtree 

func (node SelectExprs) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type SelectStatement 

type SelectStatement interface {
	AddOrder(*Order)
	SetLimit(*Limit)
	SQLNode
	// contains filtered or unexported methods
}

SelectStatement any SELECT statement.

type Set 

type Set struct {
	Comments Comments
	Exprs    SetExprs
}

Set represents a SET statement.

func (*Set) Format 

func (node *Set) Format(buf *TrackedBuffer)

Format formats the node.

func (*Set) WalkSubtree 

func (node *Set) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type SetExpr 

type SetExpr struct {
	Name ColIdent
	Expr Expr
}

SetExpr represents a set expression.

func (*SetExpr) Format 

func (node *SetExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*SetExpr) WalkSubtree 

func (node *SetExpr) WalkSubtree(visit Visit) error

type SetExprs 

type SetExprs []*SetExpr

SetExprs represents a list of set expressions.

func (SetExprs) Format 

func (node SetExprs) Format(buf *TrackedBuffer)

Format formats the node.

func (SetExprs) WalkSubtree 

func (node SetExprs) WalkSubtree(visit Visit) error

type Show 

type Show struct {
	Type     string
	Full     string
	Table    TableName
	Database TableName
	From     string
	Limit    *Limit
	Filter   *ShowFilter
}

Show represents a show statement.

func (*Show) Format 

func (node *Show) Format(buf *TrackedBuffer)

Format formats the node.

func (*Show) WalkSubtree 

func (node *Show) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ShowFilter 

type ShowFilter struct {
	Like   string
	Filter Expr
}

ShowFilter is show tables filter

func (*ShowFilter) Format 

func (node *ShowFilter) Format(buf *TrackedBuffer)

Format formats the node.

func (*ShowFilter) WalkSubtree 

func (node *ShowFilter) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type SimpleTableExpr 

type SimpleTableExpr interface {
	SQLNode
	// contains filtered or unexported methods
}

SimpleTableExpr represents a simple table expression.

type StarExpr 

type StarExpr struct {
	TableName TableName
}

StarExpr defines a '*' or 'table.*' expression.

func (*StarExpr) Format 

func (node *StarExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*StarExpr) WalkSubtree 

func (node *StarExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Statement 

type Statement interface {
	SQLNode
	// contains filtered or unexported methods
}

Statement represents a statement.

func Parse 

func Parse(sql string) (Statement, error)

Parse parses the sql and returns a Statement, which is the AST representation of the query. If a DDL statement is partially parsed but still contains a syntax error, the error is ignored and the DDL is returned anyway.

func ParseStrictDDL 

func ParseStrictDDL(sql string) (Statement, error)

ParseStrictDDL is the same as Parse except it errors on partially parsed DDL statements.

type Subquery 

type Subquery struct {
	Select SelectStatement
}

Subquery represents a subquery.

func (*Subquery) Format 

func (node *Subquery) Format(buf *TrackedBuffer)

Format formats the node.

func (*Subquery) WalkSubtree 

func (node *Subquery) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type TableExpr 

type TableExpr interface {
	SQLNode
	// contains filtered or unexported methods
}

TableExpr represents a table expression.

type TableExprs 

type TableExprs []TableExpr

TableExprs represents a list of table expressions.

func (TableExprs) Format 

func (node TableExprs) Format(buf *TrackedBuffer)

Format formats the node.

func (TableExprs) WalkSubtree 

func (node TableExprs) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type TableIdent 

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

TableIdent is a case sensitive SQL identifier. It will be escaped with backquotes if necessary.

func GetTableName 

func GetTableName(node SimpleTableExpr) TableIdent

GetTableName returns the table name from the SimpleTableExpr only if it's a simple expression. Otherwise, it returns "".

func NewTableIdent 

func NewTableIdent(str string) TableIdent

NewTableIdent creates a new TableIdent.

func (TableIdent) CompliantName 

func (node TableIdent) CompliantName() string

CompliantName returns a compliant id name that can be used for a bind var.

func (TableIdent) Format 

func (node TableIdent) Format(buf *TrackedBuffer)

Format formats the node.

func (TableIdent) IsEmpty 

func (node TableIdent) IsEmpty() bool

IsEmpty returns true if TabIdent is empty.

func (TableIdent) MarshalJSON 

func (node TableIdent) MarshalJSON() ([]byte, error)

MarshalJSON marshals into JSON.

func (TableIdent) String 

func (node TableIdent) String() string

String returns the unescaped table name. It must not be used for SQL generation. Use sqlparser.String instead. The Stringer conformance is for usage in templates.

func (*TableIdent) UnmarshalJSON 

func (node *TableIdent) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals from JSON.

func (TableIdent) WalkSubtree 

func (node TableIdent) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type TableName 

type TableName struct {
	Name, Qualifier TableIdent
}

TableName represents a table name. Qualifier, if specified, represents a database or keyspace. TableName is a value struct whose fields are case sensitive. This means two TableName vars can be compared for equality and a TableName can also be used as key in a map.

func (TableName) Format 

func (node TableName) Format(buf *TrackedBuffer)

Format formats the node.

func (TableName) IsEmpty 

func (node TableName) IsEmpty() bool

IsEmpty returns true if TableName is nil or empty.

func (TableName) WalkSubtree 

func (node TableName) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type TableNames 

type TableNames []TableName

TableNames is a list of TableName.

func (TableNames) Format 

func (node TableNames) Format(buf *TrackedBuffer)

Format formats the node.

func (TableNames) WalkSubtree 

func (node TableNames) WalkSubtree(visit Visit) error

type TableOption 

type TableOption struct {
	Type TableOptionType
	Val  *SQLVal
}

TableOption represents the table options. See https://dev.mysql.com/doc/refman/5.7/en/create-table.html

type TableOptionList 

type TableOptionList []*TableOption

type TableOptionListOpt 

type TableOptionListOpt struct {
	TblOptList TableOptionList
}

func (*TableOptionListOpt) CheckIfTableOptDuplicate 

func (tblOptList *TableOptionListOpt) CheckIfTableOptDuplicate() string

Although each option can be appeared many times in MySQL, we make a constraint that each option should only be appeared just one time in RadonDB.

func (*TableOptionListOpt) GetTableOptValByType 

func (tblOptList *TableOptionListOpt) GetTableOptValByType(optType TableOptionType) *SQLVal

type TableOptionType 

type TableOptionType int

TableOptionType is the type for table_options 

const (
	TableOptionNone TableOptionType = iota
	TableOptionComment
	TableOptionEngine
	TableOptionCharset
	TableOptionTableType
	TableOptionAutoInc
)

type TableOptions 

type TableOptions struct {
	Comment string
	Engine  string
	Charset string
	Type    string
}

TableOptions is used by TableSpec

func (TableOptions) Format 

func (opts TableOptions) Format(buf *TrackedBuffer)

Format formats the node.

func (TableOptions) WalkSubtree 

func (opts TableOptions) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type TableSpec 

type TableSpec struct {
	Columns []*ColumnDefinition
	Indexes []*IndexDefinition
	Options TableOptions
}

TableSpec describes the structure of a table from a CREATE TABLE statement

func (*TableSpec) AddColumn 

func (ts *TableSpec) AddColumn(cd *ColumnDefinition)

AddColumn appends the given column to the list in the spec

func (*TableSpec) AddIndex 

func (ts *TableSpec) AddIndex(id *IndexDefinition)

AddIndex appends the given index to the list in the spec

func (*TableSpec) Format 

func (ts *TableSpec) Format(buf *TrackedBuffer)

Format formats the node.

func (*TableSpec) WalkSubtree 

func (ts *TableSpec) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Tokenizer 

type Tokenizer struct {
	InStream      *strings.Reader
	AllowComments bool
	ForceEOF      bool

	Position int

	LastError string

	ParseTree Statement
	// contains filtered or unexported fields
}

Tokenizer is the struct used to generate SQL tokens for the parser.

func NewStringTokenizer 

func NewStringTokenizer(sql string) *Tokenizer

NewStringTokenizer creates a new Tokenizer for the sql string.

func (*Tokenizer) Error 

func (tkn *Tokenizer) Error(err string)

Error is called by go yacc if there's a parsing error.

func (*Tokenizer) Lex 

func (tkn *Tokenizer) Lex(lval *yySymType) int

Lex returns the next token form the Tokenizer. This function is used by go yacc.

func (*Tokenizer) Scan 

func (tkn *Tokenizer) Scan() (int, []byte)

Scan scans the tokenizer for the next token and returns the token type and an optional value.

type TrackedBuffer 

type TrackedBuffer struct {
	*strings.Builder
	// contains filtered or unexported fields
}

TrackedBuffer is used to rebuild a query from the ast. bindLocations keeps track of locations in the buffer that use bind variables for efficient future substitutions. nodeFormatter is the formatting function the buffer will use to format a node. By default(nil), it's FormatNode. But you can supply a different formatting function if you want to generate a query that's different from the default.

func NewTrackedBuffer 

func NewTrackedBuffer(nodeFormatter NodeFormatter) *TrackedBuffer

NewTrackedBuffer creates a new TrackedBuffer.

func (*TrackedBuffer) HasBindVars 

func (buf *TrackedBuffer) HasBindVars() bool

HasBindVars returns true if the parsed query uses bind vars.

func (*TrackedBuffer) Myprintf 

func (buf *TrackedBuffer) Myprintf(format string, values ...interface{})

Myprintf mimics fmt.Fprintf(buf, ...), but limited to Node(%v), Node.Value(%s) and string(%s). It also allows a %a for a value argument, in which case it adds tracking info for future substitutions.

The name must be something other than the usual Printf() to avoid "go vet" warnings due to our custom format specifiers.

func (*TrackedBuffer) ParsedQuery 

func (buf *TrackedBuffer) ParsedQuery() *ParsedQuery

ParsedQuery returns a ParsedQuery that contains bind locations for easy substitution.

func (*TrackedBuffer) WriteArg 

func (buf *TrackedBuffer) WriteArg(arg string)

WriteArg writes a value argument into the buffer along with tracking information for future substitutions. arg must contain the ":" or "::" prefix.

func (*TrackedBuffer) WriteNode 

func (buf *TrackedBuffer) WriteNode(node SQLNode) *TrackedBuffer

WriteNode function, initiates the writing of a single SQLNode tree by passing through to Myprintf with a default format string

type Transaction 

type Transaction struct {
	Action string
}

Transaction represents the transaction tuple.

func (*Transaction) Format 

func (node *Transaction) Format(buf *TrackedBuffer)

Format formats the node.

func (*Transaction) WalkSubtree 

func (node *Transaction) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type TupleEqualityList 

type TupleEqualityList struct {
	Columns []ColIdent
	Rows    [][]sqltypes.Value
}

TupleEqualityList is for generating equality constraints for tables that have composite primary keys.

func (*TupleEqualityList) EncodeSQL 

func (tpl *TupleEqualityList) EncodeSQL(buf *strings.Builder)

EncodeSQL generates the where clause constraints for the tuple equality.

type UnaryExpr 

type UnaryExpr struct {
	Operator string
	Expr     Expr
}

UnaryExpr represents a unary value expression.

func (*UnaryExpr) Format 

func (node *UnaryExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*UnaryExpr) WalkSubtree 

func (node *UnaryExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Union 

type Union struct {
	Type        string
	Left, Right SelectStatement
	OrderBy     OrderBy
	Limit       *Limit
	Lock        string
}

Union represents a UNION statement.

func (*Union) AddOrder 

func (node *Union) AddOrder(order *Order)

AddOrder adds an order by element

func (*Union) Format 

func (node *Union) Format(buf *TrackedBuffer)

Format formats the node.

func (*Union) SetLimit 

func (node *Union) SetLimit(limit *Limit)

SetLimit sets the limit clause

func (*Union) WalkSubtree 

func (node *Union) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Update 

type Update struct {
	Comments Comments
	Table    TableName
	Exprs    UpdateExprs
	Where    *Where
	OrderBy  OrderBy
	Limit    *Limit
}

Update represents an UPDATE statement.

func (*Update) Format 

func (node *Update) Format(buf *TrackedBuffer)

Format formats the node.

func (*Update) WalkSubtree 

func (node *Update) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type UpdateExpr 

type UpdateExpr struct {
	Name *ColName
	Expr Expr
}

UpdateExpr represents an update expression.

func (*UpdateExpr) Format 

func (node *UpdateExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*UpdateExpr) WalkSubtree 

func (node *UpdateExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type UpdateExprs 

type UpdateExprs []*UpdateExpr

UpdateExprs represents a list of update expressions.

func (UpdateExprs) Format 

func (node UpdateExprs) Format(buf *TrackedBuffer)

Format formats the node.

func (UpdateExprs) WalkSubtree 

func (node UpdateExprs) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Use 

type Use struct {
	DBName TableIdent
}

Use represents a use statement.

func (*Use) Format 

func (node *Use) Format(buf *TrackedBuffer)

Format formats the node.

func (*Use) WalkSubtree 

func (node *Use) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ValTuple 

type ValTuple Exprs

ValTuple represents a tuple of actual values.

func (ValTuple) Format 

func (node ValTuple) Format(buf *TrackedBuffer)

Format formats the node.

func (ValTuple) WalkSubtree 

func (node ValTuple) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ValType 

type ValType int

ValType specifies the type for SQLVal.

type Values 

type Values []ValTuple

Values represents a VALUES clause.

func (Values) Format 

func (node Values) Format(buf *TrackedBuffer)

Format formats the node.

func (Values) WalkSubtree 

func (node Values) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type ValuesFuncExpr 

type ValuesFuncExpr struct {
	Name     ColIdent
	Resolved Expr
}

ValuesFuncExpr represents a function call.

func (*ValuesFuncExpr) Format 

func (node *ValuesFuncExpr) Format(buf *TrackedBuffer)

Format formats the node.

func (*ValuesFuncExpr) WalkSubtree 

func (node *ValuesFuncExpr) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Visit 

type Visit func(node SQLNode) (kontinue bool, err error)

Visit defines the signature of a function that can be used to visit all nodes of a parse tree.

type When 

type When struct {
	Cond Expr
	Val  Expr
}

When represents a WHEN sub-expression.

func (*When) Format 

func (node *When) Format(buf *TrackedBuffer)

Format formats the node.

func (*When) WalkSubtree 

func (node *When) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Where 

type Where struct {
	Type string
	Expr Expr
}

Where represents a WHERE or HAVING clause.

func NewWhere 

func NewWhere(typ string, expr Expr) *Where

NewWhere creates a WHERE or HAVING clause out of a Expr. If the expression is nil, it returns nil.

func (*Where) Format 

func (node *Where) Format(buf *TrackedBuffer)

Format formats the node.

func (*Where) WalkSubtree 

func (node *Where) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

type Xa 

type Xa struct {
}

Xa represents a XA statement.

func (*Xa) Format 

func (node *Xa) Format(buf *TrackedBuffer)

Format formats the node.

func (*Xa) WalkSubtree 

func (node *Xa) WalkSubtree(visit Visit) error

WalkSubtree walks the nodes of the subtree.

Source Files

View all Source files

Directories

Path Synopsis
depends
bytes2
common
query
Package query is a generated protocol buffer package.
 Package query is a generated protocol buffer package.
sqltypes
Package sqltypes implements interfaces and types that represent SQL values.
 Package sqltypes implements interfaces and types that represent SQL values.

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.