Documentation
¶
Index ¶
- Constants
- Variables
- func Append(buf *bytes.Buffer, node SQLNode)
- func Backtick(in string) string
- func String(node SQLNode) string
- func Walk(visit Visit, nodes ...SQLNode) error
- type AliasedExpr
- type AliasedTableExpr
- type AndExpr
- 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) 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) WalkSubtree(visit Visit) error
- type ColName
- type ColTuple
- type CollateExpr
- type ColumnDef
- type ColumnOption
- type ColumnOptionType
- type Columns
- type Comments
- type ComparisonExpr
- type Constraint
- type ConstraintType
- type ConvertExpr
- type ConvertType
- type ConvertUsingExpr
- type CreateTable
- type DDL
- type Default
- type Delete
- type Encodable
- type ExistsExpr
- type Expr
- type Exprs
- type FuncExpr
- type GroupBy
- type GroupConcatExpr
- type IWhere
- type IndexHints
- type Insert
- type InsertRows
- type InsertValues
- type IntervalExpr
- type IsExpr
- type JoinTableExpr
- type Limit
- type ListArg
- type MatchExpr
- type Nextval
- type NotExpr
- type NullVal
- type OnDup
- type OrExpr
- type Order
- type OrderBy
- type OtherAdmin
- type OtherRead
- type ParenExpr
- type ParenSelect
- type ParenTableExpr
- type ParsedQuery
- type RangeCond
- type RowFormatType
- type SQLNode
- type SQLVal
- type Select
- func (node *Select) AddHaving(expr Expr)
- func (node *Select) AddOrder(order *Order)
- func (node *Select) AddWhere(expr Expr)
- func (node *Select) Format(buf *TrackedBuffer)
- func (node *Select) GetWhere() *Where
- func (node *Select) SetLimit(limit *Limit)
- func (node *Select) SetWhere(w *Where)
- func (node *Select) WalkSubtree(visit Visit) error
- type SelectExpr
- type SelectExprs
- type SelectStatement
- type Set
- type Show
- type SimpleTableExpr
- type StarExpr
- type Statement
- type Subquery
- type TableExpr
- type TableExprs
- type TableIdent
- func (node TableIdent) CompliantName() string
- func (node TableIdent) Format(buf *TrackedBuffer)
- func (node TableIdent) IsEmpty() bool
- func (node TableIdent) MarshalJSON() ([]byte, error)
- func (node TableIdent) String() string
- func (node *TableIdent) UnmarshalJSON(b []byte) error
- func (node TableIdent) WalkSubtree(visit Visit) error
- type TableName
- type TableNames
- type TableOption
- type TableOptionType
- type Tokenizer
- type TrackedBuffer
- type TruncateTable
- type TupleEqualityList
- type UnaryExpr
- type Union
- type Update
- type UpdateExpr
- type UpdateExprs
- type Use
- type ValTuple
- type ValType
- type Values
- type ValuesFuncExpr
- type Visit
- type When
- type Where
Constants ¶
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 ( CreateStr = "create" AlterStr = "alter" DropStr = "drop" RenameStr = "rename" )
DDL strings.
const ( ShowDatabasesStr = "databases" ShowKeyspacesStr = "vitess_keyspaces" ShowShardsStr = "vitess_shards" ShowTablesStr = "tables" ShowVSchemaTablesStr = "vschema_tables" ShowUnsupportedStr = "unsupported" )
The frollowing constants represent SHOW statements.
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 string = "where" HavingStr string = "having" )
const ( EqualStr = "=" LessThanStr = "<" GreaterThanStr = ">" LessEqualStr = "<=" GreaterEqualStr = ">=" NotEqualStr = "!=" NullSafeEqualStr = "<=>" InStr = "in" NotInStr = "not in" LikeStr = "like" NotLikeStr = "not like" RegexpStr = "regexp" NotRegexpStr = "not regexp" JSONExtractOp = "->" JSONUnquoteExtractOp = "->>" )
ComparisonExpr.Operator
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 )
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 " )
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" )
Order.Direction
const ( LEX_ERROR = 57346 UNION = 57347 SELECT = 57348 INSERT = 57349 UPDATE = 57350 DELETE = 57351 FROM = 57352 WHERE = 57353 GROUP = 57354 HAVING = 57355 ORDER = 57356 BY = 57357 LIMIT = 57358 OFFSET = 57359 FOR = 57360 ALL = 57361 DISTINCT = 57362 AS = 57363 EXISTS = 57364 ASC = 57365 DESC = 57366 INTO = 57367 DUPLICATE = 57368 KEY = 57369 DEFAULT = 57370 SET = 57371 LOCK = 57372 VALUES = 57373 LAST_INSERT_ID = 57374 NEXT = 57375 VALUE = 57376 SHARE = 57377 MODE = 57378 SQL_NO_CACHE = 57379 SQL_CACHE = 57380 JOIN = 57381 STRAIGHT_JOIN = 57382 LEFT = 57383 RIGHT = 57384 INNER = 57385 OUTER = 57386 CROSS = 57387 NATURAL = 57388 USE = 57389 FORCE = 57390 ON = 57391 ID = 57392 HEX = 57393 STRING = 57394 INTEGRAL = 57395 FLOAT = 57396 HEXNUM = 57397 VALUE_ARG = 57398 LIST_ARG = 57399 COMMENT = 57400 NULL = 57401 TRUE = 57402 FALSE = 57403 OR = 57404 AND = 57405 NOT = 57406 BETWEEN = 57407 CASE = 57408 WHEN = 57409 THEN = 57410 ELSE = 57411 END = 57412 LE = 57413 GE = 57414 NE = 57415 NULL_SAFE_EQUAL = 57416 IS = 57417 LIKE = 57418 REGEXP = 57419 IN = 57420 SHIFT_LEFT = 57421 SHIFT_RIGHT = 57422 DIV = 57423 MOD = 57424 UNARY = 57425 COLLATE = 57426 BINARY = 57427 INTERVAL = 57428 JSON_EXTRACT_OP = 57429 JSON_UNQUOTE_EXTRACT_OP = 57430 CREATE = 57431 ALTER = 57432 DROP = 57433 RENAME = 57434 ANALYZE = 57435 TABLE = 57436 INDEX = 57437 VIEW = 57438 TO = 57439 IGNORE = 57440 IF = 57441 UNIQUE = 57442 USING = 57443 SHOW = 57444 DESCRIBE = 57445 EXPLAIN = 57446 DATE = 57447 ESCAPE = 57448 REPAIR = 57449 OPTIMIZE = 57450 TRUNCATE = 57451 DATABASES = 57452 TABLES = 57453 VITESS_KEYSPACES = 57454 VITESS_SHARDS = 57455 VSCHEMA_TABLES = 57456 INTEGER = 57457 CHARACTER = 57458 CURRENT_TIMESTAMP = 57459 DATABASE = 57460 CURRENT_DATE = 57461 CURRENT_TIME = 57462 LOCALTIME = 57463 LOCALTIMESTAMP = 57464 UTC_DATE = 57465 UTC_TIME = 57466 UTC_TIMESTAMP = 57467 REPLACE = 57468 CONVERT = 57469 CAST = 57470 GROUP_CONCAT = 57471 SEPARATOR = 57472 MATCH = 57473 AGAINST = 57474 BOOLEAN = 57475 LANGUAGE = 57476 WITH = 57477 QUERY = 57478 EXPANSION = 57479 UNUSED = 57480 )
const (
CharacterSetStr = " character set"
)
this string is "character set" and this comment is required
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.
Functions ¶
Types ¶
type AliasedExpr ¶
AliasedExpr defines an aliased SELECT expression.
func (*AliasedExpr) Format ¶
func (node *AliasedExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*AliasedExpr) WalkSubtree ¶
func (node *AliasedExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type AliasedTableExpr ¶
type AliasedTableExpr struct {
Expr SimpleTableExpr
As TableIdent
Hints *IndexHints
}
AliasedTableExpr represents a table expression coupled with an optional alias or index hint. If As is empty, no alias was used.
func (*AliasedTableExpr) Format ¶
func (node *AliasedTableExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*AliasedTableExpr) WalkSubtree ¶
func (node *AliasedTableExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type AndExpr ¶
type AndExpr struct {
Left, Right Expr
}
AndExpr represents an AND expression.
func (*AndExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type BinaryExpr ¶
BinaryExpr represents a binary value expression.
func (*BinaryExpr) Format ¶
func (node *BinaryExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*BinaryExpr) WalkSubtree ¶
func (node *BinaryExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type BoolVal ¶
type BoolVal bool
BoolVal is true or false.
func (BoolVal) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type CaseExpr ¶
CaseExpr represents a CASE expression.
func (*CaseExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ColIdent ¶
type ColIdent struct {
// contains filtered or unexported fields
}
ColIdent is a case insensitive SQL identifier. It will be escaped with backquotes if necessary.
func (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.
func (ColIdent) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ColName ¶
type ColName struct {
// Metadata is not populated by the parser.
// It's a placeholder for analyzers to store
// additional data, typically info about which
// table or column this node references.
Metadata interface{}
Name ColIdent
Qualifier TableName
}
ColName represents a column name.
func (*ColName) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ColTuple ¶
type ColTuple interface {
Expr
// contains filtered or unexported methods
}
ColTuple represents a list of column values. It can be ValTuple, Subquery, ListArg.
type CollateExpr ¶
CollateExpr represents dynamic collate operator.
func (*CollateExpr) Format ¶
func (node *CollateExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*CollateExpr) WalkSubtree ¶
func (node *CollateExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type ColumnDef ¶
type ColumnDef struct {
Name string
Type string
// Elems is the element list for enum and set type.
Elems []string
Options []*ColumnOption
}
type ColumnOption ¶
type ColumnOption struct {
Type ColumnOptionType
Value string
}
ColumnOption is used for parsing column constraint info from SQL.
func (*ColumnOption) String ¶
func (o *ColumnOption) String() string
type ColumnOptionType ¶
type ColumnOptionType int
ColumnOptionType is the type for ColumnOption.
const ( ColumnOptionNoOption ColumnOptionType = iota ColumnOptionPrimaryKey ColumnOptionNotNull ColumnOptionAutoIncrement ColumnOptionDefaultValue ColumnOptionUniqKey ColumnOptionNull ColumnOptionOnUpdate // For Timestamp and Datetime only. ColumnOptionFulltext ColumnOptionComment ColumnOptionGenerated ColumnOptionReference )
func (ColumnOptionType) String ¶
func (o ColumnOptionType) String() string
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
func (Columns) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Comments ¶
type Comments [][]byte
Comments represents a list of comments.
func (Comments) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ComparisonExpr ¶
ComparisonExpr represents a two-value comparison expression.
func (*ComparisonExpr) Format ¶
func (node *ComparisonExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ComparisonExpr) WalkSubtree ¶
func (node *ComparisonExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type Constraint ¶
type Constraint struct {
Type ConstraintType
Name string
// Used for PRIMARY KEY, UNIQUE, ......
Keys []ColIdent
}
Constraint is constraint for table definition.
func (Constraint) String ¶
func (node Constraint) String() string
type ConstraintType ¶
type ConstraintType int
const ( ConstraintNoConstraint ConstraintType = iota ConstraintPrimaryKey ConstraintKey ConstraintIndex ConstraintUniq ConstraintUniqKey ConstraintUniqIndex ConstraintForeignKey ConstraintFulltext )
func (ConstraintType) String ¶
func (t ConstraintType) String() string
type ConvertExpr ¶
type ConvertExpr struct {
Expr Expr
Type *ConvertType
}
ConvertExpr represents a call to CONVERT(expr, type) or it's equivalent CAST(expr AS type). Both are rewritten to the former.
func (*ConvertExpr) Format ¶
func (node *ConvertExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ConvertExpr) WalkSubtree ¶
func (node *ConvertExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type ConvertType ¶
ConvertType represents the type in call to CONVERT(expr, type)
func (*ConvertType) Format ¶
func (node *ConvertType) Format(buf *TrackedBuffer)
Format formats the node.
func (*ConvertType) WalkSubtree ¶
func (node *ConvertType) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type ConvertUsingExpr ¶
ConvertUsingExpr represents a call to CONVERT(expr USING charset).
func (*ConvertUsingExpr) Format ¶
func (node *ConvertUsingExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ConvertUsingExpr) WalkSubtree ¶
func (node *ConvertUsingExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type CreateTable ¶
type CreateTable struct {
*DDL
Columns []*ColumnDef
Constraints []*Constraint
Options []*TableOption
}
func (*CreateTable) Format ¶
func (t *CreateTable) Format(buf *TrackedBuffer)
type DDL ¶
DDL represents a CREATE, ALTER, DROP or RENAME statement. Table is set for AlterStr, DropStr, RenameStr. NewName is set for AlterStr, CreateStr, RenameStr.
func (*DDL) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Default ¶
type Default struct{}
Default represents a DEFAULT expression.
func (*Default) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Delete ¶
type Delete struct {
Comments Comments
Targets TableNames
TableExprs TableExprs
Where *Where
OrderBy OrderBy
Limit *Limit
}
Delete represents a DELETE statement.
func (*Delete) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ExistsExpr ¶
type ExistsExpr struct {
Subquery *Subquery
}
ExistsExpr represents an EXISTS expression.
func (*ExistsExpr) Format ¶
func (node *ExistsExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ExistsExpr) WalkSubtree ¶
func (node *ExistsExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type Expr ¶
type Expr interface {
SQLNode
// contains filtered or unexported methods
}
Expr represents an expression.
type Exprs ¶
type Exprs []Expr
Exprs represents a list of value expressions. It's not a valid expression because it's not parenthesized.
func (Exprs) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type FuncExpr ¶
type FuncExpr struct {
Qualifier TableIdent
Name ColIdent
Distinct bool
Exprs SelectExprs
}
FuncExpr represents a function call.
func (*FuncExpr) IsAggregate ¶
IsAggregate returns true if the function is an aggregate.
func (*FuncExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type GroupBy ¶
type GroupBy []Expr
GroupBy represents a GROUP BY clause.
func (GroupBy) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type GroupConcatExpr ¶
type GroupConcatExpr struct {
Distinct string
Exprs SelectExprs
OrderBy OrderBy
Separator string
}
GroupConcatExpr represents a call to GROUP_CONCAT
func (*GroupConcatExpr) Format ¶
func (node *GroupConcatExpr) Format(buf *TrackedBuffer)
Format formats the node
func (*GroupConcatExpr) WalkSubtree ¶
func (node *GroupConcatExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type IndexHints ¶
IndexHints represents a list of index hints.
func (*IndexHints) Format ¶
func (node *IndexHints) Format(buf *TrackedBuffer)
Format formats the node.
func (*IndexHints) WalkSubtree ¶
func (node *IndexHints) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type Insert ¶
type Insert struct {
Action string
Comments Comments
Ignore string
Table TableName
Columns Columns
Rows InsertRows
OnDup OnDup
}
Insert represents an INSERT or REPLACE statement. Per the MySQL docs, http://dev.mysql.com/doc/refman/5.7/en/replace.html Replace is the counterpart to `INSERT IGNORE`, and works exactly like a normal INSERT except if the row exists. In that case it first deletes the row and re-inserts with new values. For that reason we keep it as an Insert struct. Replaces are currently disallowed in sharded schemas because of the implications the deletion part may have on vindexes.
func (*Insert) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type InsertRows ¶
type InsertRows interface {
SQLNode
// contains filtered or unexported methods
}
InsertRows represents the rows for an INSERT statement.
type InsertValues ¶
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.
func (*IntervalExpr) WalkSubtree ¶
func (node *IntervalExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type IsExpr ¶
IsExpr represents an IS ... or an IS NOT ... expression.
func (*IsExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type JoinTableExpr ¶
JoinTableExpr represents a TableExpr that's a JOIN operation.
func (*JoinTableExpr) Format ¶
func (node *JoinTableExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*JoinTableExpr) WalkSubtree ¶
func (node *JoinTableExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type Limit ¶
type Limit struct {
Offset, Rowcount Expr
}
Limit represents a LIMIT clause.
func (*Limit) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ListArg ¶
type ListArg []byte
ListArg represents a named list argument.
func (ListArg) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type MatchExpr ¶
type MatchExpr struct {
Columns SelectExprs
Expr Expr
Option string
}
MatchExpr represents a call to the MATCH function
func (*MatchExpr) Format ¶
func (node *MatchExpr) Format(buf *TrackedBuffer)
Format formats the node
func (*MatchExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Nextval ¶
type Nextval struct {
Expr Expr
}
Nextval defines the NEXT VALUE expression.
func (Nextval) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type NotExpr ¶
type NotExpr struct {
Expr Expr
}
NotExpr represents a NOT expression.
func (*NotExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type NullVal ¶
type NullVal struct{}
NullVal represents a NULL value.
func (*NullVal) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type OnDup ¶
type OnDup UpdateExprs
OnDup represents an ON DUPLICATE KEY clause.
func (OnDup) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type OrExpr ¶
type OrExpr struct {
Left, Right Expr
}
OrExpr represents an OR expression.
func (*OrExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Order ¶
Order represents an ordering expression.
func (*Order) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type OrderBy ¶
type OrderBy []*Order
OrderBy represents an ORDER By clause.
func (OrderBy) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type OtherAdmin ¶
type OtherAdmin struct{}
OtherAdmin represents a misc statement that relies on ADMIN privileges, such as REPAIR, OPTIMIZE, or TRUNCATE statement. It should be used only as an indicator. It does not contain the full AST for the statement.
func (*OtherAdmin) Format ¶
func (node *OtherAdmin) Format(buf *TrackedBuffer)
Format formats the node.
func (*OtherAdmin) WalkSubtree ¶
func (node *OtherAdmin) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type OtherRead ¶
type OtherRead struct{}
OtherRead represents a DESCRIBE, or EXPLAIN statement. It should be used only as an indicator. It does not contain the full AST for the statement.
func (*OtherRead) Format ¶
func (node *OtherRead) Format(buf *TrackedBuffer)
Format formats the node.
func (*OtherRead) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ParenExpr ¶
type ParenExpr struct {
Expr Expr
}
ParenExpr represents a parenthesized boolean expression.
func (*ParenExpr) Format ¶
func (node *ParenExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ParenExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ParenSelect ¶
type ParenSelect struct {
Select SelectStatement
}
ParenSelect is a parenthesized SELECT statement.
func (*ParenSelect) AddOrder ¶
func (node *ParenSelect) AddOrder(order *Order)
AddOrder adds an order by element
func (*ParenSelect) Format ¶
func (node *ParenSelect) Format(buf *TrackedBuffer)
Format formats the node.
func (*ParenSelect) SetLimit ¶
func (node *ParenSelect) SetLimit(limit *Limit)
SetLimit sets the limit clause
func (*ParenSelect) WalkSubtree ¶
func (node *ParenSelect) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type ParenTableExpr ¶
type ParenTableExpr struct {
Exprs TableExprs
}
ParenTableExpr represents a parenthesized list of TableExpr.
func (*ParenTableExpr) Format ¶
func (node *ParenTableExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ParenTableExpr) WalkSubtree ¶
func (node *ParenTableExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type ParsedQuery ¶
type ParsedQuery struct {
Query string
// contains filtered or unexported fields
}
ParsedQuery represents a parsed query where bind locations are precompued for fast substitutions.
func BuildParsedQuery ¶
func BuildParsedQuery(in string, vars ...interface{}) *ParsedQuery
BuildParsedQuery builds a ParsedQuery from the input.
func GenerateParsedQuery ¶
func GenerateParsedQuery(node SQLNode) *ParsedQuery
GenerateParsedQuery returns a ParsedQuery of the ast.
type RangeCond ¶
RangeCond represents a BETWEEN or a NOT BETWEEN expression.
func (*RangeCond) Format ¶
func (node *RangeCond) Format(buf *TrackedBuffer)
Format formats the node.
func (*RangeCond) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type RowFormatType ¶
type RowFormatType uint64
RowFormatType is the type for RowFormat
const ( RowFormatDefault RowFormatType = iota + 1 RowFormatDynamic RowFormatFixed RowFormatCompressed RowFormatRedundant RowFormatCompact )
RowFormat types
func (RowFormatType) String ¶
func (r RowFormatType) String() string
type SQLNode ¶
type SQLNode interface {
Format(buf *TrackedBuffer)
// WalkSubtree calls visit on all underlying nodes
// of the subtree, but not the current one. Walking
// must be interrupted if visit returns an error.
WalkSubtree(visit Visit) error
}
SQLNode defines the interface for all nodes generated by the parser.
type SQLVal ¶
SQLVal represents a single value.
func (*SQLVal) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Select ¶
type Select struct {
Cache string
Comments Comments
Distinct string
Hints string
SelectExprs SelectExprs
From TableExprs
Where *Where
GroupBy GroupBy
Having *Where
OrderBy OrderBy
Limit *Limit
Lock string
}
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.
func (*Select) AddWhere ¶
AddWhere adds the boolean expression to the WHERE clause as an AND condition. If the expression is an OR clause, it parenthesizes it. Currently, the OR operator is the only one that's lower precedence than AND.
func (*Select) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
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.
func (SelectExprs) WalkSubtree ¶
func (node SelectExprs) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type SelectStatement ¶
type SelectStatement interface {
AddOrder(*Order)
SetLimit(*Limit)
SQLNode
// contains filtered or unexported methods
}
SelectStatement any SELECT statement.
type Set ¶
type Set struct {
Comments Comments
Exprs UpdateExprs
}
Set represents a SET statement.
func (*Set) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Show ¶
Show represents a show statement.
func (*Show) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type SimpleTableExpr ¶
type SimpleTableExpr interface {
SQLNode
// contains filtered or unexported methods
}
SimpleTableExpr represents a simple table expression.
type StarExpr ¶
type StarExpr struct {
TableName TableName
}
StarExpr defines a '*' or 'table.*' expression.
func (*StarExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Statement ¶
type Statement interface {
SQLNode
// contains filtered or unexported methods
}
Statement represents a statement.
type Subquery ¶
type Subquery struct {
Select SelectStatement
}
Subquery represents a subquery.
func (*Subquery) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type TableExpr ¶
type TableExpr interface {
SQLNode
// contains filtered or unexported methods
}
TableExpr represents a table expression.
type TableExprs ¶
type TableExprs []TableExpr
TableExprs represents a list of table expressions.
func (TableExprs) Format ¶
func (node TableExprs) Format(buf *TrackedBuffer)
Format formats the node.
func (TableExprs) WalkSubtree ¶
func (node TableExprs) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type TableIdent ¶
type TableIdent struct {
// contains filtered or unexported fields
}
TableIdent is a case sensitive SQL identifier. It will be escaped with backquotes if necessary.
func NewTableIdent ¶
func NewTableIdent(str string) TableIdent
NewTableIdent creates a new TableIdent.
func (TableIdent) CompliantName ¶
func (node TableIdent) CompliantName() string
CompliantName returns a compliant id name that can be used for a bind var.
func (TableIdent) Format ¶
func (node TableIdent) Format(buf *TrackedBuffer)
Format formats the node.
func (TableIdent) IsEmpty ¶
func (node TableIdent) IsEmpty() bool
IsEmpty returns true if TabIdent is empty.
func (TableIdent) MarshalJSON ¶
func (node TableIdent) MarshalJSON() ([]byte, error)
MarshalJSON marshals into JSON.
func (TableIdent) String ¶
func (node TableIdent) String() string
String returns the unescaped table name. It must not be used for SQL generation. Use sqlparser.String instead. The Stringer conformance is for usage in templates.
func (*TableIdent) UnmarshalJSON ¶
func (node *TableIdent) UnmarshalJSON(b []byte) error
UnmarshalJSON unmarshals from JSON.
func (TableIdent) WalkSubtree ¶
func (node TableIdent) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type TableName ¶
type TableName struct {
Name, Qualifier TableIdent
}
TableName represents a table name. Qualifier, if specified, represents a database or keyspace. TableName is a value struct whose fields are case sensitive. This means two TableName vars can be compared for equality and a TableName can also be used as key in a map.
func (TableName) 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.
func (TableName) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type TableNames ¶
type TableNames []TableName
TableNames is a list of TableName.
func (TableNames) Format ¶
func (node TableNames) Format(buf *TrackedBuffer)
Format formats the node.
func (TableNames) WalkSubtree ¶
func (node TableNames) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type TableOption ¶
type TableOption struct {
Type TableOptionType
StrValue string
UintValue uint64
}
func (*TableOption) String ¶
func (o *TableOption) String() string
type TableOptionType ¶
type TableOptionType int
const ( TableOptionNone TableOptionType = iota TableOptionEngine TableOptionCharset TableOptionCollate TableOptionAutoIncrement TableOptionComment TableOptionAvgRowLength TableOptionCheckSum TableOptionCompression TableOptionConnection TableOptionPassword TableOptionKeyBlockSize TableOptionMaxRows TableOptionMinRows TableOptionDelayKeyWrite TableOptionRowFormat TableOptionStatsPersistent TableOptionShardRowID TableOptionPackKeys )
TableOption types.
func (TableOptionType) String ¶
func (t TableOptionType) String() string
type Tokenizer ¶
type Tokenizer struct {
InStream *strings.Reader
AllowComments bool
ForceEOF bool
Position int
LastError string
ParseTree Statement
// contains filtered or unexported fields
}
Tokenizer is the struct used to generate SQL tokens for the parser.
func NewStringTokenizer ¶
NewStringTokenizer creates a new Tokenizer for the sql string.
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 func(buf *TrackedBuffer, node SQLNode)) *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 TruncateTable ¶
type TruncateTable struct {
Table TableName
}
func (*TruncateTable) Format ¶
func (node *TruncateTable) Format(buf *TrackedBuffer)
Format formats the node.
func (*TruncateTable) WalkSubtree ¶
func (node *TruncateTable) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
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.
func (*UnaryExpr) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Union ¶
type Union struct {
Type string
Left, Right SelectStatement
OrderBy OrderBy
Limit *Limit
Lock string
}
Union represents a UNION statement.
func (*Union) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Update ¶
type Update struct {
Comments Comments
TableExprs TableExprs
Exprs UpdateExprs
Where *Where
OrderBy OrderBy
Limit *Limit
}
Update represents an UPDATE statement.
func (*Update) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type UpdateExpr ¶
UpdateExpr represents an update expression.
func (*UpdateExpr) Format ¶
func (node *UpdateExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*UpdateExpr) WalkSubtree ¶
func (node *UpdateExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type UpdateExprs ¶
type UpdateExprs []*UpdateExpr
UpdateExprs represents a list of update expressions.
func (UpdateExprs) Format ¶
func (node UpdateExprs) Format(buf *TrackedBuffer)
Format formats the node.
func (UpdateExprs) WalkSubtree ¶
func (node UpdateExprs) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type Use ¶
type Use struct {
DBName TableIdent
}
Use represents a use statement.
func (*Use) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ValTuple ¶
type ValTuple Exprs
ValTuple represents a tuple of actual values.
func (ValTuple) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type Values ¶
type Values []ValTuple
Values represents a VALUES clause.
func (Values) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.
type ValuesFuncExpr ¶
ValuesFuncExpr represents a function call.
func (*ValuesFuncExpr) Format ¶
func (node *ValuesFuncExpr) Format(buf *TrackedBuffer)
Format formats the node.
func (*ValuesFuncExpr) WalkSubtree ¶
func (node *ValuesFuncExpr) WalkSubtree(visit Visit) error
WalkSubtree walks the nodes of the subtree.
type Visit ¶
Visit defines the signature of a function that can be used to visit all nodes of a parse tree.
type When ¶
When represents a WHEN sub-expression.
func (*When) WalkSubtree ¶
WalkSubtree walks the nodes of the subtree.