Documentation
¶
Index ¶
- Constants
- Variables
- func Append(buf *strings.Builder, node SQLNode)
- func EncodeValue(buf *strings.Builder, value *querypb.BindVariable)
- func ExtractMysqlComment(sql string) (version string, innerSQL string)
- func ExtractSetValues(sql string) (keyValues map[SetKey]interface{}, scope string, err error)
- func FetchBindVar(name string, bindVariables map[string]*querypb.BindVariable) (val *querypb.BindVariable, isList bool, err error)
- func FormatImpossibleQuery(buf *TrackedBuffer, node SQLNode)
- func GetBindvars(stmt Statement) map[string]struct{}
- func IsColName(node Expr) bool
- func IsDML(sql string) bool
- func IsNull(node Expr) bool
- func IsSimpleTuple(node Expr) bool
- func IsValue(node Expr) bool
- func KeywordString(id int) string
- func LikeToRegexp(likeExpr string) *regexp.Regexp
- func NewPlanValue(node Expr) (sqltypes.PlanValue, error)
- func Normalize(stmt Statement, bindVars map[string]*querypb.BindVariable, prefix string)
- func ParseTokenizer(tokenizer *Tokenizer) int
- func RedactSQLQuery(sql string) (string, error)
- func SkipQueryPlanCacheDirective(stmt Statement) bool
- func SplitStatement(blob string) (string, string, error)
- func SplitStatementToPieces(blob string) (pieces []string, err error)
- func String(node SQLNode) string
- func StripComments(sql string) string
- func StripLeadingComments(sql string) string
- func TruncateForLog(query string) string
- func TruncateForUI(query string) string
- func Walk(visit Visit, nodes ...SQLNode) error
- type AliasedExpr
- type AliasedTableExpr
- type AndExpr
- type ApplyFunc
- type AutoIncSpec
- type Begin
- type BinaryExpr
- type BindVarNeeds
- type BoolVal
- type CaseExpr
- type ColIdent
- func (node ColIdent) CompliantName() string
- func (node ColIdent) Equal(in ColIdent) bool
- func (node ColIdent) EqualString(str string) bool
- func (node ColIdent) Format(buf *TrackedBuffer)
- func (node ColIdent) IsEmpty() bool
- func (node ColIdent) Lowered() string
- func (node ColIdent) MarshalJSON() ([]byte, error)
- func (node ColIdent) String() string
- func (node *ColIdent) UnmarshalJSON(b []byte) error
- type ColName
- type ColTuple
- type CollateExpr
- type ColumnDefinition
- type ColumnKeyOption
- type ColumnType
- type Columns
- type CommentDirectives
- type Comments
- type Commit
- type ComparisonExpr
- type ConstraintDefinition
- type ConstraintInfo
- type ConvertExpr
- type ConvertType
- type ConvertUsingExpr
- type CurTimeFuncExpr
- type Cursor
- type DBDDL
- type DDL
- type Default
- type Delete
- type Encodable
- type ExistsExpr
- type Expr
- type Exprs
- type ForeignKeyDefinition
- type FuncExpr
- type GroupBy
- type GroupConcatExpr
- type IndexColumn
- type IndexDefinition
- type IndexHints
- type IndexInfo
- type IndexOption
- type Insert
- type InsertRows
- type InsertValues
- type IntervalExpr
- type IsExpr
- type JoinCondition
- type JoinTableExpr
- type LengthScaleOption
- type Limit
- type ListArg
- type MarginComments
- type MatchExpr
- type Nextval
- type NodeFormatter
- type NotExpr
- type NullVal
- type OnDup
- type OptLike
- type OrExpr
- type Order
- type OrderBy
- type OtherAdmin
- type OtherRead
- type ParenExpr
- type ParenSelect
- type ParenTableExpr
- type ParsedQuery
- type PartitionDefinition
- type PartitionSpec
- type Partitions
- type PositionedErr
- type RangeCond
- type ReferenceAction
- type RewriteASTResult
- type Rollback
- type SQLNode
- type SQLVal
- type Select
- type SelectExpr
- type SelectExprs
- type SelectStatement
- type Set
- type SetExpr
- type SetExprs
- type SetKey
- type Show
- type ShowFilter
- type ShowTablesOpt
- type SimpleTableExpr
- type StarExpr
- type Statement
- type StatementType
- type Stream
- type Subquery
- type SubstrExpr
- type TableExpr
- type TableExprs
- type TableIdent
- type TableName
- type TableNames
- type TableSpec
- type TimestampFuncExpr
- type Tokenizer
- type TrackedBuffer
- type TupleEqualityList
- type UnaryExpr
- type Union
- type Update
- type UpdateExpr
- type UpdateExprs
- type Use
- type ValTuple
- type ValType
- type Values
- type ValuesFuncExpr
- type VindexParam
- type VindexSpec
- type Visit
- type When
- type Where
Constants ¶
const ( StrVal = ValType(iota) IntVal FloatVal HexNum HexVal ValArg BitVal )
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.
const ( // NoAt represents no @ NoAt atCount = iota // SingleAt represents @ SingleAt // DoubleAt represnts @@ DoubleAt )
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" )
const ( // Select.Distinct DistinctStr = "distinct " StraightJoinHint = "straight_join " // Select.Lock ForUpdateStr = " for update" // Select.Cache SQLCacheStr = "sql_cache " SQLNoCacheStr = "sql_no_cache " // Union.Type UnionStr = "union" UnionAllStr = "union all" UnionDistinctStr = "union distinct" // DDL strings. InsertStr = "insert" ReplaceStr = "replace" // Set.Scope or Show.Scope SessionStr = "session" GlobalStr = "global" VitessMetadataStr = "vitess_metadata" VariableStr = "variable" ImplicitStr = "" // DDL strings. CreateStr = "create" AlterStr = "alter" DropStr = "drop" RenameStr = "rename" TruncateStr = "truncate" FlushStr = "flush" CreateVindexStr = "create vindex" DropVindexStr = "drop vindex" AddVschemaTableStr = "add vschema table" DropVschemaTableStr = "drop vschema table" AddColVindexStr = "on table add vindex" DropColVindexStr = "on table drop vindex" AddSequenceStr = "add sequence" AddAutoIncStr = "add auto_increment" // Vindex DDL param to specify the owner of a vindex VindexOwnerStr = "owner" // Partition strings ReorganizeStr = "reorganize partition" // JoinTableExpr.Join JoinStr = "join" StraightJoinStr = "straight_join" LeftJoinStr = "left join" RightJoinStr = "right join" NaturalJoinStr = "natural join" NaturalLeftJoinStr = "natural left join" NaturalRightJoinStr = "natural right join" // Index hints. UseStr = "use " IgnoreStr = "ignore " ForceStr = "force " // Where.Type WhereStr = "where" HavingStr = "having" // ComparisonExpr.Operator EqualStr = "=" LessThanStr = "<" GreaterThanStr = ">" LessEqualStr = "<=" GreaterEqualStr = ">=" NotEqualStr = "!=" NullSafeEqualStr = "<=>" InStr = "in" NotInStr = "not in" LikeStr = "like" NotLikeStr = "not like" RegexpStr = "regexp" NotRegexpStr = "not regexp" JSONExtractOp = "->" JSONUnquoteExtractOp = "->>" // RangeCond.Operator BetweenStr = "between" NotBetweenStr = "not between" // IsExpr.Operator IsNullStr = "is null" IsNotNullStr = "is not null" IsTrueStr = "is true" IsNotTrueStr = "is not true" IsFalseStr = "is false" IsNotFalseStr = "is not false" // BinaryExpr.Operator BitAndStr = "&" BitOrStr = "|" BitXorStr = "^" PlusStr = "+" MinusStr = "-" MultStr = "*" DivStr = "/" IntDivStr = "div" ModStr = "%" ShiftLeftStr = "<<" ShiftRightStr = ">>" // UnaryExpr.Operator UPlusStr = "+" UMinusStr = "-" TildaStr = "~" BangStr = "!" BinaryStr = "binary " UBinaryStr = "_binary " Utf8mb4Str = "_utf8mb4 " // this string is "character set" and this comment is required CharacterSetStr = " character set" CharsetStr = "charset" // MatchExpr.Option BooleanModeStr = " in boolean mode" NaturalLanguageModeStr = " in natural language mode" NaturalLanguageModeWithQueryExpansionStr = " in natural language mode with query expansion" QueryExpansionStr = " with query expansion" // Order.Direction AscScr = "asc" DescScr = "desc" // SetExpr.Expr, for SET TRANSACTION ... or START TRANSACTION // TransactionStr is the Name for a SET TRANSACTION statement TransactionStr = "transaction" IsolationLevelReadUncommitted = "isolation level read uncommitted" IsolationLevelReadCommitted = "isolation level read committed" IsolationLevelRepeatableRead = "isolation level repeatable read" IsolationLevelSerializable = "isolation level serializable" TxReadOnly = "read only" TxReadWrite = "read write" )
const ( //LastInsertIDName is a reserved bind var name for last_insert_id() LastInsertIDName = "__lastInsertId" //DBVarName is a reserved bind var name for database() DBVarName = "__vtdbname" //FoundRowsName is a reserved bind var name for found_rows() FoundRowsName = "__vtfrows" //UserDefinedVariableName is what we prepend bind var names for user defined variables UserDefinedVariableName = "__vtudv" )
const ACTION = 57464
const ACTIVE = 57619
const ADD = 57448
const ADMIN = 57620
const AGAINST = 57587
const ALL = 57362
const ALTER = 57444
const ANALYZE = 57447
const AND = 57415
const APPROXNUM = 57540
const ARRAY = 57594
const AS = 57364
const ASC = 57366
const AT_AT_ID = 57399
const AT_ID = 57398
const AUTO_INCREMENT = 57539
const BEGIN = 57492
const BETWEEN = 57417
const BIGINT = 57503
const BINARY = 57437
const BIT = 57497
const BIT_LITERAL = 57409
const BLOB = 57524
const BOOL = 57516
const BOOLEAN = 57588
const BUCKETS = 57621
const BY = 57358
const CASCADE = 57465
const CASE = 57418
const CAST = 57579
const CHAR = 57514
const CHARACTER = 57517
const CHARSET = 57556
const CHECK = 57463
const CLONE = 57622
const COLLATE = 57436
const COLLATION = 57544
const COLUMN = 57459
const COLUMNS = 57551
const COMMENT = 57407
const COMMENT_KEYWORD = 57408
const COMMIT = 57495
const COMMITTED = 57565
const COMPONENT = 57623
const CONSTRAINT = 57466
const CONVERT = 57578
const CREATE = 57443
const CROSS = 57391
const CUME_DIST = 57595
const CURRENT_DATE = 57570
const CURRENT_TIME = 57571
const CURRENT_TIMESTAMP = 57568
const DATABASE = 57569
const DATABASES = 57545
const DATE = 57474
const DATETIME = 57512
const DECIMAL = 57508
const DEFAULT = 57371
const DEFINITION = 57624
const DELETE = 57352
const DENSE_RANK = 57597
const DESC = 57367
const DESCRIBE = 57472
const DESCRIPTION = 57596
const DISTINCT = 57363
const DISTINCTROW = 57376
const DIV = 57433
const DOUBLE = 57506
const DROP = 57445
const DUPLICATE = 57369
const ELSE = 57421
const EMPTY = 57598
const END = 57422
const ENFORCED = 57625
const ENGINES = 57553
const ENUM = 57529
const ESCAPE = 57475
const EXCEPT = 57599
const EXCLUDE = 57626
const EXISTS = 57365
const EXPANSION = 57592
const EXPLAIN = 57473
const FALSE = 57412
const FIELDS = 57552
const FIRST_VALUE = 57600
const FLOAT = 57403
const FLOAT_TYPE = 57507
const FLUSH = 57449
const FOLLOWING = 57627
const FOR = 57361
const FORCE = 57394
const FOREIGN = 57467
const FROM = 57353
const FULL = 57549
const FULLTEXT = 57461
const GE = 57424
const GEOMCOLLECTION = 57628
const GEOMETRY = 57530
const GEOMETRYCOLLECTION = 57534
const GET_MASTER_PUBLIC_KEY = 57629
const GLOBAL = 57557
const GROUP = 57355
const GROUPING = 57601
const GROUPS = 57602
const GROUP_CONCAT = 57582
const HAVING = 57356
const HEX = 57400
const HEXNUM = 57404
const HISTOGRAM = 57630
const HISTORY = 57631
const ID = 57397
const IF = 57456
const IGNORE = 57455
const IN = 57430
const INACTIVE = 57632
const INDEX = 57452
const INNER = 57389
const INSERT = 57350
const INT = 57501
const INTEGER = 57502
const INTEGRAL = 57402
const INTERVAL = 57440
const INTNUM = 57504
const INTO = 57368
const INVISIBLE = 57633
const IS = 57427
const ISOLATION = 57559
const JOIN = 57385
const JSON = 57528
const JSON_EXTRACT_OP = 57441
const JSON_TABLE = 57603
const JSON_UNQUOTE_EXTRACT_OP = 57442
const KEY = 57370
const KEYS = 57375
const KEY_BLOCK_SIZE = 57462
const LAG = 57604
const LANGUAGE = 57589
const LAST_INSERT_ID = 57378
const LAST_VALUE = 57605
const LATERAL = 57606
const LE = 57423
const LEAD = 57607
const LEFT = 57387
const LESS = 57482
const LEVEL = 57560
const LEX_ERROR = 57346
const LIKE = 57428
const LIMIT = 57359
const LINESTRING = 57532
const LIST_ARG = 57406
const LOCALTIME = 57572
const LOCALTIMESTAMP = 57573
const LOCK = 57373
const LOCKED = 57634
const LONGBLOB = 57527
const LONGTEXT = 57523
const MASTER_COMPRESSION_ALGORITHMS = 57635
const MASTER_PUBLIC_KEY_PATH = 57636
const MASTER_TLS_CIPHERSUITES = 57637
const MASTER_ZSTD_COMPRESSION_LEVEL = 57638
const MATCH = 57586
const MAXVALUE = 57479
const MEDIUMBLOB = 57526
const MEDIUMINT = 57500
const MEDIUMTEXT = 57522
const MEMBER = 57608
const MOD = 57434
const MODE = 57382
const MULTILINESTRING = 57536
const MULTIPOINT = 57535
const MULTIPOLYGON = 57537
const NAMES = 57555
const NATURAL = 57392
const NCHAR = 57519
const NE = 57425
const NESTED = 57639
const NETWORK_NAMESPACE = 57640
const NEXT = 57379
const NO = 57468
const NOT = 57416
const NOWAIT = 57641
const NTH_VALUE = 57609
const NTILE = 57610
const NULL = 57410
const NULLS = 57642
const NULLX = 57538
const NULL_SAFE_EQUAL = 57426
const NUMERIC = 57509
const OF = 57611
const OFF = 57413
const OFFSET = 57360
const OJ = 57643
const OLD = 57644
const ON = 57395
const ONLY = 57563
const OPTIMIZE = 57477
const OPTIONAL = 57645
const OR = 57414
const ORDER = 57357
const ORDINALITY = 57646
const ORGANIZATION = 57647
const OTHERS = 57648
const OUTER = 57390
const OVER = 57612
const PARTITION = 57480
const PATH = 57649
const PERCENT_RANK = 57613
const PERSIST = 57650
const PERSIST_ONLY = 57651
const PLUGINS = 57554
const POINT = 57531
const POLYGON = 57533
const PRECEDING = 57652
const PRIMARY = 57458
const PRIVILEGE_CHECKS_USER = 57653
const PROCEDURE = 57484
const PROCESS = 57654
const PROCESSLIST = 57550
const QUERY = 57591
const RANDOM = 57655
const RANK = 57614
const READ = 57561
const REAL = 57505
const RECURSIVE = 57615
const REFERENCE = 57656
const REFERENCES = 57469
const REGEXP = 57429
const RENAME = 57446
const REORGANIZE = 57481
const REPAIR = 57476
const REPEATABLE = 57564
const REPLACE = 57577
const REQUIRE_ROW_FORMAT = 57657
const RESOURCE = 57658
const RESPECT = 57659
const RESTART = 57660
const RESTRICT = 57470
const RETAIN = 57661
const REUSE = 57662
const RIGHT = 57388
const ROLE = 57663
const ROLLBACK = 57496
const ROW_NUMBER = 57616
const SCHEMA = 57450
const SECONDARY = 57664
const SECONDARY_ENGINE = 57665
const SECONDARY_LOAD = 57666
const SECONDARY_UNLOAD = 57667
const SELECT = 57348
const SEPARATOR = 57583
const SEQUENCE = 57491
const SERIALIZABLE = 57567
const SESSION = 57558
const SET = 57372
const SHARE = 57381
const SHIFT_LEFT = 57431
const SHIFT_RIGHT = 57432
const SHOW = 57471
const SIGNED = 57541
const SKIP = 57668
const SMALLINT = 57499
const SPATIAL = 57460
const SQL_CACHE = 57384
const SQL_NO_CACHE = 57383
const SRID = 57669
const START = 57493
const STATUS = 57488
const STRAIGHT_JOIN = 57386
const STREAM = 57349
const STRING = 57401
const SUBSTR = 57580
const SUBSTRING = 57581
const SYSTEM = 57617
const TABLE = 57451
const TABLES = 57546
const TEXT = 57520
const THAN = 57483
const THEN = 57420
const THREAD_PRIORITY = 57670
const TIES = 57671
const TIME = 57510
const TIMESTAMP = 57511
const TIMESTAMPADD = 57584
const TIMESTAMPDIFF = 57585
const TINYBLOB = 57525
const TINYINT = 57498
const TINYTEXT = 57521
const TO = 57454
const TRANSACTION = 57494
const TRIGGER = 57485
const TRUE = 57411
const TRUNCATE = 57478
const UNARY = 57435
const UNBOUNDED = 57672
const UNCOMMITTED = 57566
const UNDERSCORE_BINARY = 57438
const UNDERSCORE_UTF8MB4 = 57439
const UNION = 57347
const UNIQUE = 57457
const UNLOCK = 57374
const UNSIGNED = 57542
const UNUSED = 57593
const UPDATE = 57351
const USE = 57393
const USING = 57396
const UTC_DATE = 57574
const UTC_TIME = 57575
const UTC_TIMESTAMP = 57576
const VALUE = 57380
const VALUES = 57377
const VALUE_ARG = 57405
const VARBINARY = 57518
const VARCHAR = 57515
const VARIABLES = 57489
const VCPU = 57673
const VIEW = 57453
const VINDEX = 57486
const VINDEXES = 57487
const VISIBLE = 57674
const VITESS_METADATA = 57547
const VSCHEMA = 57548
const WARNINGS = 57490
const WHEN = 57419
const WHERE = 57354
const WINDOW = 57618
const WITH = 57590
const WRITE = 57562
const YEAR = 57513
const ZEROFILL = 57543
Variables ¶
var ( // TruncateUILen truncate queries in debug UIs to the given length. 0 means unlimited. TruncateUILen = flag.Int("sql-max-length-ui", 512, "truncate queries in debug UIs to the given length (default 512)") // TruncateErrLen truncate queries in error logs to the given length. 0 means unlimited. TruncateErrLen = flag.Int("sql-max-length-errors", 0, "truncate queries in error logs to the given length (default unlimited)") )
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.
var ErrEmpty = errors.New("empty statement")
ErrEmpty is a sentinel error returned when parsing empty statements.
Functions ¶
func EncodeValue ¶
func EncodeValue(buf *strings.Builder, value *querypb.BindVariable)
EncodeValue encodes one bind variable value into the query.
func ExtractMysqlComment ¶
ExtractMysqlComment extracts the version and SQL from a comment-only query such as /*!50708 sql here */
func ExtractSetValues ¶
ExtractSetValues returns a map of key-value pairs if the query is a SET statement. Values can be bool, int64 or string. Since set variable names are case insensitive, all keys are returned as lower case.
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 ¶
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 IsSimpleTuple ¶
IsSimpleTuple returns true if the Expr is a ValTuple that contains simple values or if it's a list arg.
func IsValue ¶
IsValue returns true if the Expr is a string, integral or value arg. NULL is not considered to be a value.
func KeywordString ¶
KeywordString returns the string corresponding to the given keyword
func LikeToRegexp ¶ added in v1.0.1
LikeToRegexp converts a like sql expression to regular expression
func NewPlanValue ¶
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. Within Select constructs, bind vars are deduped. This allows us to identify vindex equality. Otherwise, every value is treated as distinct.
func ParseTokenizer ¶
ParseTokenizer is a raw interface to parse from the given tokenizer. This does not used pooled parsers, and should not be used in general.
func RedactSQLQuery ¶
RedactSQLQuery returns a sql string with the params stripped out for display
func SkipQueryPlanCacheDirective ¶
SkipQueryPlanCacheDirective returns true if skip query plan cache directive is set to true in query.
func SplitStatement ¶
SplitStatement returns the first sql statement up to either a ; or EOF and the remainder from the given buffer
func SplitStatementToPieces ¶
SplitStatementToPieces split raw sql statement that may have multi sql pieces to sql pieces returns the sql pieces blob contains; or error if sql cannot be parsed
func StripComments ¶
StripComments removes all comments from the string regardless of where they occur
func StripLeadingComments ¶
StripLeadingComments trims the SQL string and removes any leading comments
func TruncateForLog ¶
TruncateForLog is used when displaying queries as part of error logs to avoid overwhelming logging systems with potentially long queries and bind value data.
func TruncateForUI ¶
TruncateForUI is used when displaying queries on various Vitess status pages to keep the pages small enough to load and render properly
Types ¶
type AliasedExpr ¶
AliasedExpr defines an aliased SELECT expression.
func (*AliasedExpr) Format ¶
func (node *AliasedExpr) Format(buf *TrackedBuffer)
Format formats the node.
type AliasedTableExpr ¶
type AliasedTableExpr struct {
Expr SimpleTableExpr
Partitions Partitions
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) RemoveHints ¶
func (node *AliasedTableExpr) RemoveHints() *AliasedTableExpr
RemoveHints returns a new AliasedTableExpr with the hints removed.
type ApplyFunc ¶ added in v1.0.1
An ApplyFunc is invoked by Rewrite for each node n, even if n is nil, before and/or after the node's children, using a Cursor describing the current node and providing operations on it.
The return value of ApplyFunc controls the syntax tree traversal. See Rewrite for details.
type AutoIncSpec ¶ added in v1.0.1
AutoIncSpec defines and autoincrement value for a ADD AUTO_INCREMENT statement
func (*AutoIncSpec) Format ¶ added in v1.0.1
func (node *AutoIncSpec) Format(buf *TrackedBuffer)
Format formats the node.
type BinaryExpr ¶
BinaryExpr represents a binary value expression.
func (*BinaryExpr) Format ¶
func (node *BinaryExpr) Format(buf *TrackedBuffer)
Format formats the node.
type BindVarNeeds ¶ added in v1.0.1
type BindVarNeeds struct {
NeedLastInsertID bool
NeedDatabase bool
NeedFoundRows bool
NeedUserDefinedVariables bool
}
BindVarNeeds represents the bind vars that need to be provided as the result of expression rewriting.
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 NewColIdentWithAt ¶ added in v1.0.1
NewColIdentWithAt makes a new ColIdent.
func (ColIdent) CompliantName ¶
CompliantName returns a compliant id name that can be used for a bind var.
func (ColIdent) EqualString ¶
EqualString performs a case-insensitive compare with str.
func (ColIdent) Lowered ¶
Lowered returns a lower-cased column name. This function should generally be used only for optimizing comparisons.
func (ColIdent) MarshalJSON ¶
MarshalJSON marshals into JSON.
func (ColIdent) 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 ¶
UnmarshalJSON unmarshals from JSON.
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.
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 ¶
CollateExpr represents dynamic collate operator.
func (*CollateExpr) Format ¶
func (node *CollateExpr) Format(buf *TrackedBuffer)
Format formats the node.
type ColumnDefinition ¶
type ColumnDefinition struct {
Name ColIdent
// TODO: Should this not be a reference?
Type ColumnType
}
ColumnDefinition describes a column in a CREATE TABLE statement
func (*ColumnDefinition) Format ¶
func (col *ColumnDefinition) Format(buf *TrackedBuffer)
Format formats the node.
type ColumnKeyOption ¶
type ColumnKeyOption int
ColumnKeyOption indicates whether or not the given column is defined as an index element and contains the type of the option
type ColumnType ¶
type ColumnType struct {
// The base type string
Type string
// Generic field options.
NotNull BoolVal
Autoincrement BoolVal
Default Expr
OnUpdate Expr
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
KeyOpt ColumnKeyOption
}
ColumnType represents a sql type in a CREATE TABLE statement All optional fields are nil if not specified
func (*ColumnType) DescribeType ¶
func (ct *ColumnType) DescribeType() string
DescribeType returns the abbreviated type information as required for describe table
func (*ColumnType) Format ¶
func (ct *ColumnType) Format(buf *TrackedBuffer)
Format returns a canonical string representation of the type and all relevant options
func (*ColumnType) SQLType ¶
func (ct *ColumnType) SQLType() querypb.Type
SQLType returns the sqltypes type code for the given column
type Columns ¶
type Columns []ColIdent
Columns represents an insert column list.
func (Columns) FindColumn ¶
FindColumn finds a column in the column list, returning the index if it exists or -1 otherwise
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 ComparisonExpr ¶
ComparisonExpr represents a two-value comparison expression.
func (*ComparisonExpr) Format ¶
func (node *ComparisonExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ComparisonExpr) IsImpossible ¶ added in v1.0.1
func (node *ComparisonExpr) IsImpossible() bool
IsImpossible returns true if the comparison in the expression can never evaluate to true. Note that this is not currently exhaustive to ALL impossible comparisons.
type ConstraintDefinition ¶
type ConstraintDefinition struct {
Name string
Details ConstraintInfo
}
ConstraintDefinition describes a constraint in a CREATE TABLE statement
func (*ConstraintDefinition) Format ¶
func (c *ConstraintDefinition) Format(buf *TrackedBuffer)
Format formats the node.
type ConstraintInfo ¶
type ConstraintInfo interface {
SQLNode
// contains filtered or unexported methods
}
ConstraintInfo details a constraint in a CREATE TABLE statement
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.
type ConvertType ¶
ConvertType represents the type in call to CONVERT(expr, type)
func (*ConvertType) Format ¶
func (node *ConvertType) Format(buf *TrackedBuffer)
Format formats the node.
type ConvertUsingExpr ¶
ConvertUsingExpr represents a call to CONVERT(expr USING charset).
func (*ConvertUsingExpr) Format ¶
func (node *ConvertUsingExpr) Format(buf *TrackedBuffer)
Format formats the node.
type CurTimeFuncExpr ¶ added in v1.0.1
type CurTimeFuncExpr struct {
Name ColIdent
Fsp Expr // fractional seconds precision, integer from 0 to 6
}
CurTimeFuncExpr represents the function and arguments for CURRENT DATE/TIME functions supported functions are documented in the grammar
func (*CurTimeFuncExpr) Format ¶ added in v1.0.1
func (node *CurTimeFuncExpr) Format(buf *TrackedBuffer)
Format formats the node.
type Cursor ¶ added in v1.0.1
type Cursor struct {
// contains filtered or unexported fields
}
A Cursor describes a node encountered during Apply. Information about the node and its parent is available from the Node and Parent methods.
type DDL ¶
type DDL struct {
Action string
// FromTables is set if Action is RenameStr or DropStr.
FromTables TableNames
// ToTables is set if Action is RenameStr.
ToTables TableNames
// Table is set if Action is other than RenameStr or DropStr.
Table TableName
// The following fields are set if a DDL was fully analyzed.
IfExists bool
TableSpec *TableSpec
OptLike *OptLike
PartitionSpec *PartitionSpec
// VindexSpec is set for CreateVindexStr, DropVindexStr, AddColVindexStr, DropColVindexStr.
VindexSpec *VindexSpec
// VindexCols is set for AddColVindexStr.
VindexCols []ColIdent
// AutoIncSpec is set for AddAutoIncStr.
AutoIncSpec *AutoIncSpec
}
DDL represents a CREATE, ALTER, DROP, RENAME, TRUNCATE or ANALYZE statement.
func (*DDL) AffectedTables ¶
func (node *DDL) AffectedTables() TableNames
AffectedTables returns the list table names affected by the DDL.
type Delete ¶
type Delete struct {
Comments Comments
Targets TableNames
TableExprs TableExprs
Partitions Partitions
Where *Where
OrderBy OrderBy
Limit *Limit
}
Delete represents a DELETE statement. If you add fields here, consider adding them to calls to validateUnshardedRoute.
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.
type Expr ¶
type Expr interface {
SQLNode
// contains filtered or unexported methods
}
Expr represents an expression.
func ExprFromValue ¶
ExprFromValue converts the given Value into an Expr or returns an error.
func ReplaceExpr ¶
ReplaceExpr finds the from expression from root and replaces it with to. If from matches root, then to is returned.
func SplitAndExpression ¶ added in v1.0.1
SplitAndExpression breaks up the Expr into AND-separated conditions and appends them to filters. Outer parenthesis are removed. Precedence should be taken into account if expressions are recombined.
type Exprs ¶
type Exprs []Expr
Exprs represents a list of value expressions. It's not a valid expression because it's not parenthesized.
type ForeignKeyDefinition ¶
type ForeignKeyDefinition struct {
Source Columns
ReferencedTable TableName
ReferencedColumns Columns
OnDelete ReferenceAction
OnUpdate ReferenceAction
}
ForeignKeyDefinition describes a foreign key in a CREATE TABLE statement
func (*ForeignKeyDefinition) Format ¶
func (f *ForeignKeyDefinition) Format(buf *TrackedBuffer)
Format formats the node.
type FuncExpr ¶
type FuncExpr struct {
Qualifier TableIdent
Name ColIdent
Distinct bool
Exprs SelectExprs
}
FuncExpr represents a function call.
func (*FuncExpr) IsAggregate ¶
IsAggregate returns true if the function is an aggregate.
type GroupConcatExpr ¶
type GroupConcatExpr struct {
Distinct string
Exprs SelectExprs
OrderBy OrderBy
Separator string
Limit *Limit
}
GroupConcatExpr represents a call to GROUP_CONCAT
func (*GroupConcatExpr) Format ¶
func (node *GroupConcatExpr) Format(buf *TrackedBuffer)
Format formats the node
type IndexColumn ¶
IndexColumn describes a column in an index definition with optional length
type IndexDefinition ¶
type IndexDefinition struct {
Info *IndexInfo
Columns []*IndexColumn
Options []*IndexOption
}
IndexDefinition describes an index in a CREATE TABLE statement
func (*IndexDefinition) Format ¶
func (idx *IndexDefinition) Format(buf *TrackedBuffer)
Format formats the node.
type IndexHints ¶
IndexHints represents a list of index hints.
func (*IndexHints) Format ¶
func (node *IndexHints) Format(buf *TrackedBuffer)
Format formats the node.
type IndexOption ¶
IndexOption is used for trailing options for indexes: COMMENT, KEY_BLOCK_SIZE, USING
type Insert ¶
type Insert struct {
Action string
Comments Comments
Ignore string
Table TableName
Partitions Partitions
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. If you add fields here, consider adding them to calls to validateUnshardedRoute.
type InsertRows ¶
type InsertRows interface {
SQLNode
// contains filtered or unexported methods
}
InsertRows represents the rows for an INSERT statement.
type InsertValues ¶
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 ¶
IntervalExpr represents a date-time INTERVAL expression.
func (*IntervalExpr) Format ¶
func (node *IntervalExpr) Format(buf *TrackedBuffer)
Format formats the node.
type JoinCondition ¶
JoinCondition represents the join conditions (either a ON or USING clause) of a JoinTableExpr.
func (JoinCondition) Format ¶
func (node JoinCondition) Format(buf *TrackedBuffer)
Format formats the node.
type JoinTableExpr ¶
type JoinTableExpr struct {
LeftExpr TableExpr
Join string
RightExpr TableExpr
Condition JoinCondition
}
JoinTableExpr represents a TableExpr that's a JOIN operation.
func (*JoinTableExpr) Format ¶
func (node *JoinTableExpr) Format(buf *TrackedBuffer)
Format formats the node.
type LengthScaleOption ¶
LengthScaleOption is used for types that have an optional length and scale
type MarginComments ¶
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
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 OptLike ¶
type OptLike struct {
LikeTable TableName
}
OptLike works for create table xxx like xxx
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.
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.
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.
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
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.
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) Append ¶ added in v1.0.1
func (pq *ParsedQuery) Append(buf *strings.Builder, bindVariables map[string]*querypb.BindVariable, extras map[string]Encodable) error
Append appends the generated query to the provided buffer.
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 ¶
PartitionDefinition describes a very minimal partition definition
func (*PartitionDefinition) Format ¶
func (node *PartitionDefinition) Format(buf *TrackedBuffer)
Format formats the node
type PartitionSpec ¶
type PartitionSpec struct {
Action string
Name ColIdent
Definitions []*PartitionDefinition
}
PartitionSpec describe partition actions (for alter and create)
func (*PartitionSpec) Format ¶
func (node *PartitionSpec) Format(buf *TrackedBuffer)
Format formats the node.
type Partitions ¶
type Partitions Columns
Partitions is a type alias for Columns so we can handle printing efficiently
func (Partitions) Format ¶
func (node Partitions) Format(buf *TrackedBuffer)
Format formats the node
type PositionedErr ¶ added in v1.0.1
PositionedErr holds context related to parser errors
func (PositionedErr) Error ¶ added in v1.0.1
func (p PositionedErr) Error() string
type RangeCond ¶
RangeCond represents a BETWEEN or a NOT BETWEEN expression.
func (*RangeCond) Format ¶
func (node *RangeCond) Format(buf *TrackedBuffer)
Format formats the node.
type ReferenceAction ¶
type ReferenceAction int
ReferenceAction indicates the action takes by a referential constraint e.g. the `CASCADE` in a `FOREIGN KEY .. ON DELETE CASCADE` table definition.
const ( // DefaultAction indicates no action was explicitly specified. DefaultAction ReferenceAction = iota Restrict Cascade NoAction SetNull SetDefault )
These map to the SQL-defined reference actions. See https://dev.mysql.com/doc/refman/8.0/en/create-table-foreign-keys.html#foreign-keys-referential-actions
func (ReferenceAction) Format ¶
func (a ReferenceAction) Format(buf *TrackedBuffer)
Format formats the node.
type RewriteASTResult ¶ added in v1.0.1
type RewriteASTResult struct {
BindVarNeeds
AST Statement // The rewritten AST
}
RewriteASTResult contains the rewritten ast and meta information about it
func PrepareAST ¶ added in v1.0.1
func PrepareAST(in Statement, bindVars map[string]*querypb.BindVariable, prefix string) (*RewriteASTResult, error)
PrepareAST will normalize the query
func RewriteAST ¶ added in v1.0.1
func RewriteAST(in Statement) (*RewriteASTResult, error)
RewriteAST rewrites the whole AST, replacing function calls and adding column aliases to queries
type SQLNode ¶
type SQLNode interface {
Format(buf *TrackedBuffer)
}
SQLNode defines the interface for all nodes generated by the parser.
func Rewrite ¶ added in v1.0.1
Rewrite traverses a syntax tree recursively, starting with root, and calling pre and post for each node as described below. Rewrite returns the syntax tree, possibly modified.
If pre is not nil, it is called for each node before the node's children are traversed (pre-order). If pre returns false, no children are traversed, and post is not called for that node.
If post is not nil, and a prior call of pre didn't return false, post is called for each node after its children are traversed (post-order). If post returns false, traversal is terminated and Apply returns immediately.
Only fields that refer to AST nodes are considered children; i.e., fields of basic types (strings, []byte, etc.) are ignored.
type SQLVal ¶
SQLVal represents a single value.
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
}
Select represents a SELECT statement.
func (*Select) AddHaving ¶
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.
type SelectExpr ¶
type SelectExpr interface {
SQLNode
// contains filtered or unexported methods
}
SelectExpr represents a SELECT expression.
type SelectExprs ¶
type SelectExprs []SelectExpr
SelectExprs represents SELECT expressions.
func (SelectExprs) Format ¶
func (node SelectExprs) Format(buf *TrackedBuffer)
Format formats the node.
type SelectStatement ¶
type SelectStatement interface {
AddOrder(*Order)
SetLimit(*Limit)
SQLNode
// contains filtered or unexported methods
}
SelectStatement any SELECT statement.
type Show ¶
type Show struct {
Type string
OnTable TableName
Table TableName
ShowTablesOpt *ShowTablesOpt
Scope string
ShowCollationFilterOpt *Expr // TODO: this should not be a pointer
}
Show represents a show statement.
func (*Show) HasOnTable ¶
HasOnTable returns true if the show statement has an "on" clause
type ShowFilter ¶
ShowFilter is show tables filter
func (*ShowFilter) Format ¶
func (node *ShowFilter) Format(buf *TrackedBuffer)
Format formats the node.
type ShowTablesOpt ¶
type ShowTablesOpt struct {
Full string
DbName string
Filter *ShowFilter
}
ShowTablesOpt is show tables option
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.
type Statement ¶
type Statement interface {
SQLNode
// contains filtered or unexported methods
}
Statement represents a statement.
func Parse ¶
Parse parses the SQL in full 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 ParseNext ¶
ParseNext parses a single SQL statement from the tokenizer returning a Statement which is the AST representation of the query. The tokenizer will always read up to the end of the statement, allowing for the next call to ParseNext to parse any subsequent SQL statements. When there are no more statements to parse, a error of io.EOF is returned.
func ParseNextStrictDDL ¶
ParseNextStrictDDL is the same as ParseNext except it errors on partially parsed DDL statements.
func ParseStrictDDL ¶
ParseStrictDDL is the same as Parse except it errors on partially parsed DDL statements.
type StatementType ¶ added in v1.0.1
type StatementType int
StatementType encodes the type of a SQL statement
const ( StmtSelect StatementType = iota StmtStream StmtInsert StmtReplace StmtUpdate StmtDelete StmtDDL StmtBegin StmtCommit StmtRollback StmtSet StmtShow StmtUse StmtOther StmtUnknown StmtComment StmtPriv )
These constants are used to identify the SQL statement type. Changing this list will require reviewing all calls to Preview.
func Preview ¶
func Preview(sql string) StatementType
Preview analyzes the beginning of the query using a simpler and faster textual comparison to identify the statement type.
func (StatementType) String ¶ added in v1.0.1
func (s StatementType) String() string
type Stream ¶
type Stream struct {
Comments Comments
SelectExpr SelectExpr
Table TableName
}
Stream represents a SELECT statement.
type SubstrExpr ¶
SubstrExpr represents a call to SubstrExpr(column, value_expression) or SubstrExpr(column, value_expression,value_expression) also supported syntax SubstrExpr(column from value_expression for value_expression). Additionally to column names, SubstrExpr is also supported for string values, e.g.: SubstrExpr('static string value', value_expression, value_expression) In this case StrVal will be set instead of Name.
func (*SubstrExpr) Format ¶
func (node *SubstrExpr) Format(buf *TrackedBuffer)
Format formats the node.
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.
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.
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 TableFromStatement ¶ added in v1.0.1
TableFromStatement returns the qualified table name for the query. This works only for select statements.
func (TableName) ToViewName ¶
ToViewName returns a TableName acceptable for use as a VIEW. VIEW names are always lowercase, so ToViewName lowercasese the name. Databases are case-sensitive so Qualifier is left untouched.
type TableNames ¶
type TableNames []TableName
TableNames is a list of TableName.
func (TableNames) Format ¶
func (node TableNames) Format(buf *TrackedBuffer)
Format formats the node.
type TableSpec ¶
type TableSpec struct {
Columns []*ColumnDefinition
Indexes []*IndexDefinition
Constraints []*ConstraintDefinition
Options string
}
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) AddConstraint ¶
func (ts *TableSpec) AddConstraint(cd *ConstraintDefinition)
AddConstraint appends the given index 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
type TimestampFuncExpr ¶ added in v1.0.1
TimestampFuncExpr represents the function and arguments for TIMESTAMP{ADD,DIFF} functions.
func (*TimestampFuncExpr) Format ¶ added in v1.0.1
func (node *TimestampFuncExpr) Format(buf *TrackedBuffer)
Format formats the node.
type Tokenizer ¶
type Tokenizer struct {
InStream io.Reader
AllowComments bool
SkipSpecialComments bool
SkipToEnd bool
Position int
LastError error
ParseTree Statement
// contains filtered or unexported fields
}
Tokenizer is the struct used to generate SQL tokens for the parser.
func NewStringTokenizer ¶
NewStringTokenizer creates a new Tokenizer for the sql string.
func NewTokenizer ¶
NewTokenizer creates a new Tokenizer reading a sql string from the io.Reader.
type TrackedBuffer ¶
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 TupleEqualityList ¶
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 ¶
UnaryExpr represents a unary value expression.
func (*UnaryExpr) Format ¶
func (node *UnaryExpr) Format(buf *TrackedBuffer)
Format formats the node.
type Union ¶
type Union struct {
Type string
Left, Right SelectStatement
OrderBy OrderBy
Limit *Limit
Lock string
}
Union represents a UNION statement.
type Update ¶
type Update struct {
Comments Comments
Ignore string
TableExprs TableExprs
Exprs UpdateExprs
Where *Where
OrderBy OrderBy
Limit *Limit
}
Update represents an UPDATE statement. If you add fields here, consider adding them to calls to validateUnshardedRoute.
type UpdateExpr ¶
UpdateExpr represents an update expression.
func (*UpdateExpr) Format ¶
func (node *UpdateExpr) Format(buf *TrackedBuffer)
Format formats the node.
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.
type ValuesFuncExpr ¶
type ValuesFuncExpr struct {
Name *ColName
}
ValuesFuncExpr represents a function call.
func (*ValuesFuncExpr) Format ¶
func (node *ValuesFuncExpr) Format(buf *TrackedBuffer)
Format formats the node.
type VindexParam ¶
VindexParam defines a key/value parameter for a CREATE VINDEX statement
func (VindexParam) Format ¶
func (node VindexParam) Format(buf *TrackedBuffer)
Format formats the node.
type VindexSpec ¶
type VindexSpec struct {
Name ColIdent
Type ColIdent
Params []VindexParam
}
VindexSpec defines a vindex for a CREATE VINDEX or DROP VINDEX statement
func (*VindexSpec) Format ¶
func (node *VindexSpec) Format(buf *TrackedBuffer)
Format formats the node. The "CREATE VINDEX" preamble was formatted in the containing DDL node Format, so this just prints the type, any parameters, and optionally the owner
func (*VindexSpec) ParseParams ¶
func (node *VindexSpec) ParseParams() (string, map[string]string)
ParseParams parses the vindex parameter list, pulling out the special-case "owner" parameter
type Visit ¶
Visit defines the signature of a function that can be used to visit all nodes of a parse tree.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package visitorgen is responsible for taking the ast.go of Vitess and and producing visitor infrastructure for it.
|
Package visitorgen is responsible for taking the ast.go of Vitess and and producing visitor infrastructure for it. |