Documentation ¶
Index ¶
- Constants
- Variables
- func Append(buf *bytes.Buffer, node SQLNode)
- func EncodeValue(buf *bytes.Buffer, 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 NewPlanValue(node Expr) (sqltypes.PlanValue, error)
- func Normalize(stmt Statement, bindVars map[string]*querypb.BindVariable, prefix string)
- func Preview(sql string) int
- func RedactSQLQuery(sql string) (string, error)
- func SetDefaultDialect(dialect dialect.Dialect)
- func SetSQLParserErrorVerboseLevel(verbose bool)
- func SetTokenizerVerbosity(verbose bool)
- func SkipQueryPlanCacheDirective(stmt Statement) bool
- func SplitStatement(blob string) (string, string, error)
- func SplitStatementToPieces(blob string) (pieces []string, err error)
- func StmtType(stmtType int) string
- func String(node SQLNode) string
- func StringIn(str string, values ...string) bool
- func StringWithDialect(dialect dialect.Dialect, node SQLNode) string
- func StripLeadingComments(sql string) string
- func Walk(visit Visit, nodes ...SQLNode) error
- type AliasedExpr
- type AliasedTableExpr
- type AndExpr
- type Begin
- type BinaryExpr
- 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) FormatForDialect(dialect dialect.Dialect, 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
- func (node *ColIdent) ValueForConfig() string
- type ColName
- type ColTuple
- type CollateExpr
- type ColumnDefinition
- type ColumnKeyOption
- type ColumnType
- type ColumnTypes
- type Columns
- type CommentDirectives
- type Comments
- type Commit
- type ComparisonExpr
- type ConvertExpr
- type ConvertType
- type ConvertUsingExpr
- type DBDDL
- type DDL
- type DeallocatePrepare
- type Default
- type Delete
- type DialectFormat
- type EmptyStatement
- type Encodable
- type Execute
- type ExistsExpr
- type Expr
- type Exprs
- 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 LimitType
- type ListArg
- type MarginComments
- type MatchExpr
- type Mode
- type Nextval
- type NodeFormatter
- type NotExpr
- type NotParsedStatement
- type NullVal
- type OnDup
- type OrExpr
- type Order
- type OrderBy
- type OtherAdmin
- type OtherRead
- type ParenExpr
- type ParenSelect
- type ParenTableExpr
- type ParsedQuery
- type Parser
- type PartitionDefinition
- type PartitionSpec
- type Partitions
- type Prepare
- type PreparedQuery
- type RangeCond
- type Returning
- type Rollback
- type SQLNode
- type SQLVal
- func NewBitVal(in []byte) *SQLVal
- func NewCastVal(val Expr, castType []byte) *SQLVal
- func NewDollarExpr(value string) (*SQLVal, error)
- func NewFloatVal(in []byte) *SQLVal
- func NewHexNum(in []byte) *SQLVal
- func NewHexVal(in []byte) *SQLVal
- func NewIntVal(in []byte) *SQLVal
- func NewMySQLDoubleQuotedStrVal(in []byte) (*SQLVal, error)
- func NewPgEscapeString(in []byte) *SQLVal
- func NewStrVal(in []byte) *SQLVal
- func NewValArg(in []byte) *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 Stream
- type Subquery
- type SubstrExpr
- type TableExpr
- type TableExprs
- type TableIdent
- func (node TableIdent) CompliantName() string
- func (node TableIdent) Format(buf *TrackedBuffer)
- func (node TableIdent) FormatForDialect(dialect dialect.Dialect, buf *TrackedBuffer)
- func (node TableIdent) IsEmpty() bool
- func (node *TableIdent) Lowered() string
- func (node TableIdent) MarshalJSON() ([]byte, error)
- func (node TableIdent) RawValue() string
- func (node TableIdent) String() string
- func (node *TableIdent) UnmarshalJSON(b []byte) error
- func (node *TableIdent) ValueForConfig() string
- type TableName
- type TableNames
- type TableSpec
- type Tokenizer
- type TrackedBuffer
- func (buf *TrackedBuffer) HasBindVars() bool
- func (buf *TrackedBuffer) Myprintf(format string, values ...interface{})
- func (buf *TrackedBuffer) ParsedQuery() *ParsedQuery
- func (buf *TrackedBuffer) SetDialect(dialect dialect.Dialect)
- func (buf *TrackedBuffer) WriteArg(arg string)
- func (buf *TrackedBuffer) WriteNode(node SQLNode) *TrackedBuffer
- type TupleEqualityList
- type UnaryExpr
- type Union
- type Update
- type UpdateExpr
- type UpdateExprs
- type Use
- type UsingInExecuteList
- type ValTuple
- type ValType
- type Values
- type ValuesFuncExpr
- type VindexParam
- type VindexSpec
- type Visit
- type When
- type Where
Examples ¶
Constants ¶
const ( StmtSelect = iota StmtStream StmtInsert StmtReplace StmtUpdate StmtDelete StmtDDL StmtBegin StmtCommit StmtRollback StmtSet StmtShow StmtUse StmtOther StmtUnknown StmtComment StmtDeallocatePrepare StmtPrepare StmtExecute )
These constants are used to identify the SQL statement type.
const ( DistinctStr = "distinct " StraightJoinHint = "straight_join " )
Select.Distinct
const ( ForUpdateStr = " for update" )
Select.Lock
const ( SQLCacheStr = "sql_cache " SQLNoCacheStr = "sql_no_cache " )
Select.Cache
const ( UnionStr = "union" UnionAllStr = "union all" UnionDistinctStr = "union distinct" )
Union.Type
const ( InsertStr = "insert" ReplaceStr = "replace" )
DDL strings.
const ( SessionStr = "session" GlobalStr = "global" LocalStr = "local" )
Set.Scope or Show.Scope
const ( CreateStr = "create" AlterStr = "alter" DropStr = "drop" RenameStr = "rename" TruncateStr = "truncate" CreateVindexStr = "create vindex" AddColVindexStr = "add vindex" DropColVindexStr = "drop vindex" // Vindex DDL param to specify the owner of a vindex VindexOwnerStr = "owner" )
DDL strings.
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
const ( UseStr = "use " IgnoreStr = "ignore " ForceStr = "force " )
Index hints.
const ( WhereStr = "where" HavingStr = "having" )
Where.Type
const ( EqualStr = "=" LessThanStr = "<" GreaterThanStr = ">" LessEqualStr = "<=" GreaterEqualStr = ">=" NotEqualStr = "!=" NullSafeEqualStr = "<=>" InStr = "in" NotInStr = "not in" LikeStr = "like" ILikeStr = "ilike" NotLikeStr = "not like" NotILikeStr = "not ilike" RegexpStr = "regexp" NotRegexpStr = "not regexp" JSONExtractOp = "->" JSONUnquoteExtractOp = "->>" )
ComparisonExpr.Operator
const ( BetweenStr = "between" NotBetweenStr = "not between" )
RangeCond.Operator
const ( IsNullStr = "is null" IsNotNullStr = "is not null" IsTrueStr = "is true" IsNotTrueStr = "is not true" IsFalseStr = "is false" IsNotFalseStr = "is not false" )
IsExpr.Operator
const ( StrVal = ValType(iota) IntVal FloatVal HexNum HexVal ValArg BitVal PgEscapeString PgPlaceholder // Use this type for casted values that are different from SQLVal. // because we have existing logic of comparison and formatting SQLVal // and it easier to extend this one instead of propagating postgresql value conversion // to all kinds of Expr. Maybe in a future when we will know more cases when it useful for // our data manipulation, we will refactor it. Now it's just to support generic queries and avoid // a lot of refactoring of sql.y and SQL grammar UnknownVal )
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 ( BitAndStr = "&" BitOrStr = "|" BitXorStr = "^" PlusStr = "+" MinusStr = "-" MultStr = "*" DivStr = "/" IntDivStr = "div" ModStr = "%" ShiftLeftStr = "<<" ShiftRightStr = ">>" )
BinaryExpr.Operator
const ( UPlusStr = "+" UMinusStr = "-" TildaStr = "~" BangStr = "!" BinaryStr = "binary " UBinaryStr = "_binary " )
UnaryExpr.Operator
const ( BooleanModeStr = " in boolean mode" NaturalLanguageModeStr = " in natural language mode" NaturalLanguageModeWithQueryExpansionStr = " in natural language mode with query expansion" QueryExpansionStr = " with query expansion" )
MatchExpr.Option
const ( AscScr = "asc" DescScr = "desc" DescNullsFirstScr = "desc nulls first" DescNullsLastScr = "desc nulls last" AscNullsFirstScr = "asc nulls first" AscNullsLastScr = "asc nulls last" )
Order.Direction
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" )
const ADD = 57470
const AGAINST = 57599
const ALL = 57362
const ALTER = 57466
const ANALYZE = 57469
const AND = 57438
const APPROXNUM = 57555
const AS = 57364
const ASC = 57366
const AUTO_INCREMENT = 57554
const BACK_QUOTE_STRING = 57404
const BEGIN = 57505
const BETWEEN = 57440
const BIGINT = 57519
const BINARY = 57461
const BIT = 57513
const BIT_LITERAL = 57411
const BLOB = 57539
const BOOL = 57531
const BOOLEAN = 57600
const BY = 57358
const CASE = 57441
const CAST = 57593
const CHAR = 57529
const CHARACTER = 57532
const CHARSET = 57569
const COLLATE = 57460
const COLUMN = 57480
const COMMENT = 57409
const COMMENT_KEYWORD = 57410
const COMMIT = 57508
const COMMITTED = 57579
const CONSTRAINT = 57481
const CONVERT = 57592
const CREATE = 57465
const CROSS = 57392
const CURRENT_DATE = 57584
const CURRENT_TIME = 57585
const CURRENT_TIMESTAMP = 57582
const (
CharacterSetStr = " character set"
)
this string is "character set" and this comment is required
const DATABASE = 57583
const DATABASES = 57559
const DATE = 57489
const DATETIME = 57528
const DAY = 57421
const DAY_HOUR = 57434
const DAY_MICROSECOND = 57431
const DAY_MINUTE = 57433
const DAY_SECOND = 57432
const DEALLOCATE = 57510
const DECIMAL = 57524
const DEFAULT = 57371
const DELETE = 57352
const DESC = 57367
const DESCRIBE = 57487
const DISTINCT = 57363
const DIV = 57457
const DOLLAR_SIGN = 57412
const DOUBLE = 57522
const DOUBLE_QUOTE_STRING = 57403
const DROP = 57467
const DUPLICATE = 57369
const ELSE = 57444
const END = 57445
const ENUM = 57544
const ESCAPE = 57490
const EXECUTE = 57512
const EXISTS = 57365
const EXPANSION = 57604
const EXPLAIN = 57488
const EXTENDED = 57565
const FALSE = 57416
const FIRST = 57376
const FLOAT = 57406
const FLOAT_TYPE = 57523
const FOR = 57361
const FORCE = 57395
const FOREIGN = 57484
const FROM = 57353
const FULL = 57566
const FULLTEXT = 57483
const GE = 57447
const GEOMETRY = 57545
const GEOMETRYCOLLECTION = 57549
const GLOBAL = 57570
const GROUP = 57355
const GROUP_CONCAT = 57596
const HAVING = 57356
const HEX = 57401
const HEXNUM = 57407
const HOUR = 57420
const HOUR_MICROSECOND = 57428
const HOUR_MINUTE = 57430
const HOUR_SECOND = 57429
const ID = 57399
const IF = 57477
const IGNORE = 57476
const ILIKE = 57452
const IN = 57454
const INDEX = 57473
const INNER = 57390
const INSERT = 57350
const INT = 57517
const INTEGER = 57518
const INTEGRAL = 57405
const INTERVAL = 57398
const INTNUM = 57520
const INTO = 57368
const IS = 57450
const ISOLATION = 57573
const JOIN = 57386
const JSON = 57543
const JSON_EXTRACT_OP = 57463
const JSON_UNQUOTE_EXTRACT_OP = 57464
const KEY = 57370
const KEYS = 57374
const KEY_BLOCK_SIZE = 57485
const LANGUAGE = 57601
const LAST = 57377
const LAST_INSERT_ID = 57379
const LE = 57446
const LEFT = 57388
const LESS = 57497
const LEVEL = 57574
const LEX_ERROR = 57346
const LIKE = 57451
const LIMIT = 57359
const LINESTRING = 57547
const LIST_ARG = 57413
const LOCAL = 57572
const LOCALTIME = 57586
const LOCALTIMESTAMP = 57587
const LOCK = 57373
const LONGBLOB = 57542
const LONGTEXT = 57538
const MATCH = 57598
const MAXVALUE = 57494
const MEDIUMBLOB = 57541
const MEDIUMINT = 57516
const MEDIUMTEXT = 57537
const MICROSECOND = 57417
const MINUTE = 57419
const MINUTE_MICROSECOND = 57426
const MINUTE_SECOND = 57427
const MOD = 57458
const MODE = 57383
const MONTH = 57423
const MULTILINESTRING = 57551
const MULTIPOINT = 57550
const MULTIPOLYGON = 57552
const NAMES = 57568
const NATURAL = 57393
const NCHAR = 57534
const NE = 57448
const NEXT = 57380
const NOT = 57439
const NULL = 57414
const NULLS = 57375
const NULLX = 57553
const NULL_SAFE_EQUAL = 57449
const NUMERIC = 57525
const OFFSET = 57360
const ON = 57396
const ONLY = 57577
const OPTIMIZE = 57492
const OR = 57437
const ORDER = 57357
const OUTER = 57391
const PARTITION = 57495
const PG_ESCAPE_STRING = 57400
const POINT = 57546
const POLYGON = 57548
const PREPARE = 57511
const PRIMARY = 57479
const PROCEDURE = 57499
const PROCESSLIST = 57567
const QUARTER = 57424
const QUERY = 57603
const READ = 57575
const REAL = 57521
const REGEXP = 57453
const RENAME = 57468
const REORGANIZE = 57496
const REPAIR = 57491
const REPEATABLE = 57578
const REPLACE = 57591
const RETURNING = 57606
const RIGHT = 57389
const ROLLBACK = 57509
const (
ReorganizeStr = "reorganize partition"
)
Partition strings
const SCHEMA = 57471
const SECOND = 57418
const SECOND_MICROSECOND = 57425
const SELECT = 57348
const SEPARATOR = 57597
const SERIALIZABLE = 57581
const SESSION = 57571
const SET = 57372
const SHARE = 57382
const SHIFT_LEFT = 57455
const SHIFT_RIGHT = 57456
const SHOW = 57486
const SIGNED = 57556
const SINGLE_QUOTE_STRING = 57402
const SMALLINT = 57515
const SPATIAL = 57482
const SQL_CACHE = 57385
const SQL_NO_CACHE = 57384
const START = 57506
const STATUS = 57503
const STRAIGHT_JOIN = 57387
const STREAM = 57349
const SUBSTR = 57594
const SUBSTRING = 57595
const TABLE = 57472
const TABLES = 57560
const TEXT = 57535
const THAN = 57498
const THEN = 57443
const TIME = 57526
const TIMESTAMP = 57527
const TINYBLOB = 57540
const TINYINT = 57514
const TINYTEXT = 57536
const TO = 57475
const TRANSACTION = 57507
const TRIGGER = 57500
const TRUE = 57415
const TRUNCATE = 57493
const UNARY = 57459
const UNCOMMITTED = 57580
const UNDERSCORE_BINARY = 57462
const UNION = 57347
const UNIQUE = 57478
const UNSIGNED = 57557
const UNUSED = 57605
const UPDATE = 57351
const USE = 57394
const USING = 57397
const UTC_DATE = 57588
const UTC_TIME = 57589
const UTC_TIMESTAMP = 57590
const VALUE = 57381
const VALUES = 57378
const VALUE_ARG = 57408
const VARBINARY = 57533
const VARCHAR = 57530
const VARIABLES = 57504
const VIEW = 57474
const VINDEX = 57501
const VINDEXES = 57502
const VITESS_KEYSPACES = 57561
const VITESS_SHARDS = 57562
const VITESS_TABLETS = 57563
const VSCHEMA_TABLES = 57564
const ValueMask = "replaced"
ValueMask is used to mask real Values from SQL queries before logging to syslog.
const WEEK = 57422
const WHEN = 57442
const WHERE = 57354
const WITH = 57602
const WRITE = 57576
const YEAR = 57436
const YEAR_MONTH = 57435
const ZEROFILL = 57558
Variables ¶
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 ErrInvalidStringLiteralQuotes = errors.New("invalid string literal quotes")
ErrInvalidStringLiteralQuotes if used string token as literal with incorrect quotes
var ErrQuerySyntaxError = errors.New("fail to parse specified query")
ErrQuerySyntaxError error returned by sqlparser.Parser
Functions ¶
func EncodeValue ¶
func EncodeValue(buf *bytes.Buffer, 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 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 Preview ¶
Preview analyzes the beginning of the query using a simpler and faster textual comparison to identify the statement type.
func RedactSQLQuery ¶
RedactSQLQuery returns a sql string with the params stripped out for display
func SetDefaultDialect ¶
SetDefaultDialect set globally default dialect used in old functions with default dialect
func SetSQLParserErrorVerboseLevel ¶
func SetSQLParserErrorVerboseLevel(verbose bool)
setErrorVerbose configures format of ErrorMessages from parser. If false then only "syntax error" will be shown. Default is false
func SetTokenizerVerbosity ¶
func SetTokenizerVerbosity(verbose bool)
SetTokenizerVerbosity turns on/off tokenizer's error messages verbosity
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 StringIn ¶
StringIn is a convenience function that returns true if str matches any of the values.
func StringWithDialect ¶
StringWithDialect returns a string representation of an SQLNode for specified dialect
func StripLeadingComments ¶
StripLeadingComments trims the SQL string and removes any leading comments
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 BinaryExpr ¶
BinaryExpr represents a binary value expression.
func (*BinaryExpr) Format ¶
func (node *BinaryExpr) Format(buf *TrackedBuffer)
Format formats the node.
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 NewColIdentUnquote ¶
NewColIdentUnquote makes a new ColIdent.
func NewColIdentWithQuotes ¶
NewColIdentWithQuotes create ColIdent with quotes to escape column name in Postgresql style
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) FormatForDialect ¶
func (node ColIdent) FormatForDialect(dialect dialect.Dialect, buf *TrackedBuffer)
FormatForDialect formats the node for specified dialect
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.
func (*ColIdent) ValueForConfig ¶
ValueForConfig returns lowercased or non-lowercased value depending on configuration (MySQL only) and which quotes were used to wrap the name in SQL, suitable for usage when checking whether the column should be encrypted.
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 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 *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 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 ColumnTypes ¶
type ColumnTypes []ColumnType
ColumnTypes represents list of column types, eg (int, bool, text, numeric) - dictated by Postgres
func (ColumnTypes) Format ¶
func (node ColumnTypes) Format(buf *TrackedBuffer)
Format formats the node.
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.
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 DDL ¶
type DDL struct { Action string Table TableName NewName TableName IfExists bool TableSpec *TableSpec PartitionSpec *PartitionSpec VindexSpec *VindexSpec VindexCols []ColIdent }
DDL represents a CREATE, ALTER, DROP, RENAME or TRUNCATE statement. Table is set for AlterStr, DropStr, RenameStr, TruncateStr NewName is set for AlterStr, CreateStr, RenameStr. VindexSpec is set for CreateVindexStr, DropVindexStr, AddColVindexStr, DropColVindexStr VindexCols is set for AddColVindexStr
type DeallocatePrepare ¶
type DeallocatePrepare struct {
PreparedStatementName TableIdent
}
DeallocatePrepare deallocates memory that stores compiled prepared statement
func (*DeallocatePrepare) Format ¶
func (node *DeallocatePrepare) Format(buf *TrackedBuffer)
Format formats the node.
type Delete ¶
type Delete struct { Comments Comments Targets TableExprs TableExprs TableExprs Partitions Partitions Where *Where OrderBy OrderBy Limit *Limit Returning Returning }
Delete represents a DELETE statement. If you add fields here, consider adding them to calls to validateSubquerySamePlan.
type DialectFormat ¶
type DialectFormat interface {
FormatForDialect(dialect dialect.Dialect, buf *TrackedBuffer)
}
DialectFormat interface for nodes which can format itself for different dialects
type EmptyStatement ¶
type EmptyStatement struct{}
EmptyStatement represent empty query passed in Postgresql ExtendedProtocol with empty Query field Should not be used and expected from MySQL. MySQL doesn't allow empty query and returns: error_code=1065 sql_state=42000 error_message="Query was empty"
func (EmptyStatement) Format ¶
func (EmptyStatement) Format(*TrackedBuffer)
Format actually do nothing
type Execute ¶
type Execute struct { PreparedStatementName TableIdent Values ValTuple Using UsingInExecuteList }
Execute executes prepared statement
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.
type Exprs ¶
type Exprs []Expr
Exprs represents a list of value expressions. It's not a valid expression because it's not parenthesized.
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 }
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 Default bool Partitions Partitions Columns Columns Rows InsertRows OnDup OnDup Returning Returning }
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 validateSubquerySamePlan.
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 *bytes.Buffer)
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 LimitType ¶
type LimitType int8
LimitType represents type of statements format
const ( // LimitTypeLimitOnly is type of LIMIT row_count format LimitTypeLimitOnly LimitType = iota //LimitTypeCommaSeparated is type of LIMIT {[offset,] row_count}, MySQL format // https://dev.mysql.com/doc/refman/8.0/en/select.html LimitTypeCommaSeparated // LimitTypeLimitAndOffset is type of LIMIT row_count OFFSET offset LimitTypeLimitAndOffset // LimitTypeLimitAll is type of LIMIT ALL, PostgreSQL format // https://www.postgresql.org/docs/current/sql-select.html#SQL-LIMIT LimitTypeLimitAll // LimitTypeLimitAllAndOffset is type of LIMIT ALL OFFSET offset LimitTypeLimitAllAndOffset )
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 NotParsedStatement ¶
type NotParsedStatement struct{ Query string }
NotParsedStatement represent query that can't be parsed by current sqlparser
func (NotParsedStatement) Format ¶
func (s NotParsedStatement) Format(buf *TrackedBuffer)
Format format NotParsedStatement method
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) GenerateQuery ¶
func (pq *ParsedQuery) GenerateQuery(bindVariables map[string]*querypb.BindVariable, extras map[string]Encodable) ([]byte, error)
GenerateQuery generates a query by substituting the specified bindVariables. The extras parameter specifies special parameters that can perform custom encoding.
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
Parser object used to handle strict/non-strict flow for any sql parse errors
func (Parser) HandleRawSQLQuery ¶
func (p Parser) HandleRawSQLQuery(sql string) (normalizedQuery, redactedQuery string, parsedQuery Statement, err error)
HandleRawSQLQuery returns a normalized (lowercases SQL commands) SQL string, and redacted SQL string with the params stripped out for display. Taken from sqlparser package
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 Prepare ¶
type Prepare struct { PreparedStatementName TableIdent ColumnTypes ColumnTypes PreparedStatementQuery PreparedQuery }
Prepare prepares statement for future execution
type PreparedQuery ¶
type PreparedQuery interface { SQLNode // contains filtered or unexported methods }
PreparedQuery represents FROM statement in Prepare
func NewPreparedQueryFromString ¶
func NewPreparedQueryFromString(query string) (PreparedQuery, error)
NewPreparedQueryFromString creates typed statement based on query inside Prepare statement
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 Returning ¶
type Returning SelectExprs
Returning represents RETURNING clause from postgresql syntax
type SQLNode ¶
type SQLNode interface { Format(buf *TrackedBuffer) // contains filtered or unexported methods }
SQLNode defines the interface for all nodes generated by the parser.
type SQLVal ¶
type SQLVal struct { Type ValType Val []byte CastType []byte // contains filtered or unexported fields }
SQLVal represents a single value.
func NewDollarExpr ¶
NewDollarExpr creates new SQLVal from input string
func NewMySQLDoubleQuotedStrVal ¶
NewMySQLDoubleQuotedStrVal check that literal may be wrapped with double quotes and return SQLVal if may otherwise error
func NewPgEscapeString ¶
NewPgEscapeString builds a new PgEscapeString
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 ShowTablesOpt *ShowTablesOpt Scope string }
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 { Extended string 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 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.
Example ¶
ExampleParseNext is the second example from the README.md.
r := strings.NewReader("INSERT INTO table1 VALUES (1, 'a'); INSERT INTO table2 VALUES (3, 4);") tokens := NewTokenizer(r) for { stmt, err := ParseNext(tokens) if err == io.EOF { break } // Do something with stmt or err. _ = stmt }
Output:
func ParseStrictDDL ¶
ParseStrictDDL is the same as Parse except it errors on partially parsed DDL statements.
func ParseWithDialect ¶
ParseWithDialect parses the SQL in full withc specified dialect 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.
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)
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 NewTableIdentWithQuotes ¶
func NewTableIdentWithQuotes(str string, quote byte) TableIdent
NewTableIdentWithQuotes creates a new TableIdent with flag to escape name
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) FormatForDialect ¶
func (node TableIdent) FormatForDialect(dialect dialect.Dialect, buf *TrackedBuffer)
FormatForDialect formats the node for specified dialect
func (TableIdent) IsEmpty ¶
func (node TableIdent) IsEmpty() bool
IsEmpty returns true if TabIdent is empty.
func (*TableIdent) Lowered ¶
func (node *TableIdent) Lowered() string
Lowered returns a lower-cased table name. This function should generally be used only for optimizing comparisons.
func (TableIdent) MarshalJSON ¶
func (node TableIdent) MarshalJSON() ([]byte, error)
MarshalJSON marshals into JSON.
func (TableIdent) RawValue ¶
func (node TableIdent) RawValue() string
RawValue returns unescaped value
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) ValueForConfig ¶
func (node *TableIdent) ValueForConfig() string
ValueForConfig returns lowercased or non-lowercased value depending on configuration (MySQL only) and which quotes were used to wrap the name in SQL, suitable for usage when checking whether the column should be encrypted.
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) 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 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) AddIndex ¶
func (ts *TableSpec) AddIndex(id *IndexDefinition)
AddIndex appends the given index to the list in the spec
type Tokenizer ¶
type Tokenizer struct { InStream io.Reader AllowComments bool ForceEOF 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 NewMySQLStringTokenizer ¶
NewMySQLStringTokenizer create mysql tokenizer for string
func NewPostgreSQLStringTokenizer ¶
NewPostgreSQLStringTokenizer create postgresql tokenizer for string
func NewStringTokenizer ¶
NewStringTokenizer creates a new Tokenizer for the sql string. Set dialect MySQL to backward compatibility
func NewStringTokenizerWithDialect ¶
NewStringTokenizerWithDialect create Tokenizer for string with specific dialect
func NewTokenizer ¶
NewTokenizer creates a new Tokenizer reading a sql string from the io.Reader.
func (*Tokenizer) IsPostgreSQL ¶
IsPostgreSQL return true if tokenizer configured with PostgreSQL dialect
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) SetDialect ¶
func (buf *TrackedBuffer) SetDialect(dialect dialect.Dialect)
SetDialect which will be used for formatting
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 *bytes.Buffer)
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 TableExprs TableExprs Exprs UpdateExprs From TableExprs Where *Where OrderBy OrderBy Limit *Limit Returning Returning }
Update represents an UPDATE statement. If you add fields here, consider adding them to calls to validateSubquerySamePlan.
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 UsingInExecuteList ¶
type UsingInExecuteList []TableIdent
UsingInExecuteList is a set of case sensitive SQL identifiers
func (UsingInExecuteList) Format ¶
func (node UsingInExecuteList) 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 |
---|---|
dependency
|
|
hack
Package hack gives you some efficient functionality at the cost of breaking some Go rules.
|
Package hack gives you some efficient functionality at the cost of breaking some Go rules. |
querypb
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. |