sqlparser

package
v0.9.2 Latest Latest
Warning

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

 Go to latest Published: May 25, 2021 License: Apache-2.0 Imports: 24 Imported by: 287

Documentation

Index

Constants

View Source 
const (
	StrVal = ValType(iota)
	IntVal
	FloatVal
	HexNum
	HexVal
	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.

View Source 
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"

	//RowCountName is a reserved bind var name for row_count()
	RowCountName = "__vtrcount"

	//UserDefinedVariableName is what we prepend bind var names for user defined variables
	UserDefinedVariableName = "__vtudv"
)
View Source 
const (
	// DirectiveMultiShardAutocommit is the query comment directive to allow
	// single round trip autocommit with a multi-shard statement.
	DirectiveMultiShardAutocommit = "MULTI_SHARD_AUTOCOMMIT"
	// DirectiveSkipQueryPlanCache skips query plan cache when set.
	DirectiveSkipQueryPlanCache = "SKIP_QUERY_PLAN_CACHE"
	// DirectiveQueryTimeout sets a query timeout in vtgate. Only supported for SELECTS.
	DirectiveQueryTimeout = "QUERY_TIMEOUT_MS"
	// DirectiveScatterErrorsAsWarnings enables partial success scatter select queries
	DirectiveScatterErrorsAsWarnings = "SCATTER_ERRORS_AS_WARNINGS"
	// DirectiveIgnoreMaxPayloadSize skips payload size validation when set.
	DirectiveIgnoreMaxPayloadSize = "IGNORE_MAX_PAYLOAD_SIZE"
	// DirectiveIgnoreMaxMemoryRows skips memory row validation when set.
	DirectiveIgnoreMaxMemoryRows = "IGNORE_MAX_MEMORY_ROWS"
)
View Source 
const (
	// Select.Distinct
	DistinctStr         = "distinct "
	StraightJoinHint    = "straight_join "
	SQLCalcFoundRowsStr = "sql_calc_found_rows "

	// Select.Lock
	NoLockStr    = ""
	ForUpdateStr = " for update"
	ShareModeStr = " lock in share mode"

	// 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"
	LocalStr          = "local"
	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"

	// Online DDL hint
	OnlineStr = "online"

	// Vindex DDL param to specify the owner of a vindex
	VindexOwnerStr = "owner"

	// Partition strings
	ReorganizeStr        = "reorganize partition"
	AddStr               = "add partition"
	DiscardStr           = "discard partition"
	DropPartitionStr     = "drop partition"
	ImportStr            = "import partition"
	TruncatePartitionStr = "truncate partition"
	CoalesceStr          = "coalesce partition"
	ExchangeStr          = "exchange partition"
	AnalyzePartitionStr  = "analyze partition"
	CheckStr             = "check partition"
	OptimizeStr          = "optimize partition"
	RebuildStr           = "rebuild partition"
	RepairStr            = "repair partition"
	RemoveStr            = "remove partitioning"
	UpgradeStr           = "upgrade partitioning"

	// 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"

	// 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           = ">>"
	JSONExtractOpStr        = "->"
	JSONUnquoteExtractOpStr = "->>"

	// UnaryExpr.Operator
	UPlusStr   = "+"
	UMinusStr  = "-"
	TildaStr   = "~"
	BangStr    = "!"
	BinaryStr  = "binary "
	UBinaryStr = "_binary "
	Utf8mb4Str = "_utf8mb4 "
	Utf8Str    = "_utf8 "
	Latin1Str  = "_latin1 "

	// ConvertType.Operator
	CharacterSetStr = " character set"
	NoOperatorStr   = ""

	// CollateAndCharset.Type
	CollateStr = " collate"

	// MatchExpr.Option
	NoOptionStr                              = ""
	BooleanModeStr                           = " in boolean mode"
	NaturalLanguageModeStr                   = " in natural language mode"
	NaturalLanguageModeWithQueryExpansionStr = " in natural language mode with query expansion"
	QueryExpansionStr                        = " with query expansion"

	// INTO OUTFILE
	IntoOutfileStr   = " into outfile "
	IntoOutfileS3Str = " into outfile s3 "
	IntoDumpfileStr  = " into dumpfile "

	// 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"

	// Transaction isolation levels
	ReadUncommittedStr = "read uncommitted"
	ReadCommittedStr   = "read committed"
	RepeatableReadStr  = "repeatable read"
	SerializableStr    = "serializable"

	TxReadOnly  = "read only"
	TxReadWrite = "read write"

	// Explain formats
	EmptyStr       = ""
	TreeStr        = "tree"
	JSONStr        = "json"
	VitessStr      = "vitess"
	TraditionalStr = "traditional"
	AnalyzeStr     = "analyze"

	// Lock Types
	ReadStr             = "read"
	ReadLocalStr        = "read local"
	WriteStr            = "write"
	LowPriorityWriteStr = "low_priority write"

	// ShowCommand Types
	CharsetStr         = " charset"
	CollationStr       = " collation"
	DatabaseStr        = " databases"
	FunctionStr        = " function status"
	PrivilegeStr       = " privileges"
	ProcedureStr       = " procedure status"
	StatusGlobalStr    = " global status"
	StatusSessionStr   = " status"
	VariableGlobalStr  = " global variables"
	VariableSessionStr = " variables"

	// DropKeyType strings
	PrimaryKeyTypeStr = "primary key"
	ForeignKeyTypeStr = "foreign key"
	NormalKeyTypeStr  = "key"

	// LockOptionType strings
	NoneTypeStr      = "none"
	SharedTypeStr    = "shared"
	DefaultTypeStr   = "default"
	ExclusiveTypeStr = "exclusive"
)
View Source 
const ACTION = 57501
View Source 
const ACTIVE = 57691
View Source 
const ADD = 57482
View Source 
const ADMIN = 57692
View Source 
const AFTER = 57547
View Source 
const AGAINST = 57657
View Source 
const ALGORITHM = 57418
View Source 
const ALL = 57363
View Source 
const ALTER = 57478
View Source 
const ANALYZE = 57481
View Source 
const AND = 57447
View Source 
const APPROXNUM = 57600
View Source 
const ARRAY = 57666
View Source 
const AS = 57365
View Source 
const ASC = 57367
View Source 
const AT_AT_ID = 57424
View Source 
const AT_ID = 57423
View Source 
const AUTO_INCREMENT = 57599
View Source 
const AVG_ROW_LENGTH = 57753
View Source 
const BEGIN = 57549
View Source 
const BETWEEN = 57449
View Source 
const BIGINT = 57563
View Source 
const BINARY = 57469
View Source 
const BIT = 57557
View Source 
const BIT_LITERAL = 57434
View Source 
const BLOB = 57584
View Source 
const BOOL = 57576
View Source 
const BOOLEAN = 57658
View Source 
const BUCKETS = 57693
View Source 
const BY = 57359
View Source 
const CASCADE = 57502
View Source 
const CASCADED = 57536
View Source 
const CASE = 57450
View Source 
const CAST = 57649
View Source 
const CHANGE = 57484
View Source 
const CHAR = 57574
View Source 
const CHARACTER = 57577
View Source 
const CHARSET = 57625
View Source 
const CHECK = 57499
View Source 
const CHECKSUM = 57755
View Source 
const CLONE = 57694
View Source 
const COALESCE = 57516
View Source 
const CODE = 57621
View Source 
const COLLATE = 57468
View Source 
const COLLATION = 57604
View Source 
const COLUMN = 57495
View Source 
const COLUMNS = 57612
View Source 
const COMMENT = 57432
View Source 
const COMMENT_KEYWORD = 57433
View Source 
const COMMIT = 57552
View Source 
const COMMITTED = 57634
View Source 
const COMPACT = 57768
View Source 
const COMPONENT = 57695
View Source 
const COMPRESSED = 57766
View Source 
const COMPRESSION = 57435
View Source 
const CONNECTION = 57754
View Source 
const CONSTRAINT = 57503
View Source 
const CONVERT = 57648
View Source 
const COPY = 57417
View Source 
const CREATE = 57477
View Source 
const CROSS = 57410
View Source 
const CSV = 57389
View Source 
const CUME_DIST = 57667
View Source 
const CURRENT_DATE = 57639
View Source 
const CURRENT_TIME = 57640
View Source 
const CURRENT_TIMESTAMP = 57637
View Source 
const CURRENT_USER = 57643
View Source 
const DATA = 57382
View Source 
const DATABASE = 57638
View Source 
const DATABASES = 57605
View Source 
const DATE = 57511
View Source 
const DATETIME = 57572
View Source 
const DECIMAL = 57568
View Source 
const DEFAULT = 57372
View Source 
const DEFINER = 57537
View Source 
const DEFINITION = 57696
View Source 
const DELAY_KEY_WRITE = 57756
View Source 
const DELETE = 57353
View Source 
const DENSE_RANK = 57669
View Source 
const DESC = 57368
View Source 
const DESCRIBE = 57509
View Source 
const DESCRIPTION = 57668
View Source 
const DIRECTORY = 57530
View Source 
const DISABLE = 57443
View Source 
const DISCARD = 57440
View Source 
const DISK = 57775
View Source 
const DISTINCT = 57364
View Source 
const DISTINCTROW = 57378
View Source 
const DIV = 57465
View Source 
const DO = 57377
View Source 
const DOUBLE = 57566
View Source 
const DROP = 57479
View Source 
const DUMPFILE = 57388
View Source 
const DUPLICATE = 57370
View Source 
const DYNAMIC = 57765
View Source 
const ELSE = 57453
View Source 
const EMPTY = 57670
View Source 
const ENABLE = 57442
View Source 
const ENCLOSED = 57387
View Source 
const ENCRYPTION = 57757
View Source 
const END = 57454
View Source 
const ENFORCED = 57697
View Source 
const ENGINE = 57758
View Source 
const ENGINES = 57614
View Source 
const ENUM = 57589
View Source 
const ESCAPE = 57512
View Source 
const ESCAPED = 57386
View Source 
const EXCEPT = 57671
View Source 
const EXCHANGE = 57517
View Source 
const EXCLUDE = 57698
View Source 
const EXCLUSIVE = 57421
View Source 
const EXISTS = 57366
View Source 
const EXPANSION = 57662
View Source 
const EXPLAIN = 57510
View Source 
const EXTENDED = 57616
View Source 
const FALSE = 57438
View Source 
const FIELDS = 57613
View Source 
const FIRST = 57546
View Source 
const FIRST_VALUE = 57672
View Source 
const FIXED = 57764
View Source 
const FLOAT = 57428
View Source 
const FLOAT_TYPE = 57567
View Source 
const FLUSH = 57483
View Source 
const FOLLOWING = 57699
View Source 
const FOR = 57362
View Source 
const FORCE = 57413
View Source 
const FOREIGN = 57504
View Source 
const FORMAT = 57747
View Source 
const FROM = 57354
View Source 
const FULL = 57610
View Source 
const FULLTEXT = 57497
View Source 
const FUNCTION = 57623
View Source 
const GE = 57456
View Source 
const GEOMCOLLECTION = 57700
View Source 
const GEOMETRY = 57590
View Source 
const GEOMETRYCOLLECTION = 57594
View Source 
const GET_MASTER_PUBLIC_KEY = 57701
View Source 
const GLOBAL = 57626
View Source 
const GROUP = 57356
View Source 
const GROUPING = 57673
View Source 
const GROUPS = 57674
View Source 
const GROUP_CONCAT = 57652
View Source 
const HAVING = 57357
View Source 
const HEADER = 57390
View Source 
const HEX = 57425
View Source 
const HEXNUM = 57429
View Source 
const HISTOGRAM = 57702
View Source 
const HISTORY = 57703
View Source 
const ID = 57422
View Source 
const IF = 57492
View Source 
const IGNORE = 57491
View Source 
const IMPORT = 57441
View Source 
const IN = 57462
View Source 
const INACTIVE = 57704
View Source 
const INDEX = 57488
View Source 
const INDEXES = 57500
View Source 
const INNER = 57408
View Source 
const INPLACE = 57416
View Source 
const INSERT = 57351
View Source 
const INSERT_METHOD = 57759
View Source 
const INT = 57561
View Source 
const INTEGER = 57562
View Source 
const INTEGRAL = 57427
View Source 
const INTERVAL = 57474
View Source 
const INTNUM = 57564
View Source 
const INTO = 57369
View Source 
const INVISIBLE = 57705
View Source 
const INVOKER = 57544
View Source 
const IS = 57459
View Source 
const ISOLATION = 57628
View Source 
const JOIN = 57404
View Source 
const JSON = 57588
View Source 
const JSON_EXTRACT_OP = 57475
View Source 
const JSON_TABLE = 57675
View Source 
const JSON_UNQUOTE_EXTRACT_OP = 57476
View Source 
const KEY = 57371
View Source 
const KEYS = 57376
View Source 
const KEYSPACES = 57617
View Source 
const KEY_BLOCK_SIZE = 57498
View Source 
const LAG = 57676
View Source 
const LANGUAGE = 57659
View Source 
const LAST = 57548
View Source 
const LAST_INSERT_ID = 57396
View Source 
const LAST_VALUE = 57677
View Source 
const LATERAL = 57678
View Source 
const LE = 57455
View Source 
const LEAD = 57679
View Source 
const LEFT = 57406
View Source 
const LESS = 57524
View Source 
const LEVEL = 57629
View Source 
const LEX_ERROR = 57346
View Source 
const LIKE = 57460
View Source 
const LIMIT = 57360
View Source 
const LINES = 57384
View Source 
const LINESTRING = 57592
View Source 
const LIST_ARG = 57431
View Source 
const LOAD = 57383
View Source 
const LOCAL = 57751
View Source 
const LOCALTIME = 57641
View Source 
const LOCALTIMESTAMP = 57642
View Source 
const LOCK = 57374
View Source 
const LOCKED = 57706
View Source 
const LONGBLOB = 57587
View Source 
const LONGTEXT = 57583
View Source 
const LOW_PRIORITY = 57752
View Source 
const MANIFEST = 57391
View Source 
const MASTER_COMPRESSION_ALGORITHMS = 57707
View Source 
const MASTER_PUBLIC_KEY_PATH = 57708
View Source 
const MASTER_TLS_CIPHERSUITES = 57709
View Source 
const MASTER_ZSTD_COMPRESSION_LEVEL = 57710
View Source 
const MATCH = 57656
View Source 
const MAXVALUE = 57521
View Source 
const MAX_ROWS = 57760
View Source 
const MEDIUMBLOB = 57586
View Source 
const MEDIUMINT = 57560
View Source 
const MEDIUMTEXT = 57582
View Source 
const MEMBER = 57680
View Source 
const MEMORY = 57774
View Source 
const MERGE = 57542
View Source 
const MIN_ROWS = 57761
View Source 
const MOD = 57466
View Source 
const MODE = 57400
View Source 
const MODIFY = 57485
View Source 
const MULTILINESTRING = 57596
View Source 
const MULTIPOINT = 57595
View Source 
const MULTIPOLYGON = 57597
View Source 
const NAME = 57531
View Source 
const NAMES = 57624
View Source 
const NATURAL = 57411
View Source 
const NCHAR = 57579
View Source 
const NE = 57457
View Source 
const NESTED = 57711
View Source 
const NETWORK_NAMESPACE = 57712
View Source 
const NEXT = 57397
View Source 
const NO = 57505
View Source 
const NONE = 57419
View Source 
const NOT = 57448
View Source 
const NOWAIT = 57713
View Source 
const NTH_VALUE = 57681
View Source 
const NTILE = 57682
View Source 
const NULL = 57436
View Source 
const NULLS = 57714
View Source 
const NULLX = 57598
View Source 
const NULL_SAFE_EQUAL = 57458
View Source 
const NUMERIC = 57569
View Source 
const OF = 57683
View Source 
const OFF = 57439
View Source 
const OFFSET = 57361
View Source 
const OJ = 57715
View Source 
const OLD = 57716
View Source 
const ON = 57414
View Source 
const ONLY = 57632
View Source 
const OPTIMIZE = 57514
View Source 
const OPTION = 57538
View Source 
const OPTIONAL = 57717
View Source 
const OPTIONALLY = 57394
View Source 
const OR = 57445
View Source 
const ORDER = 57358
View Source 
const ORDINALITY = 57718
View Source 
const ORGANIZATION = 57719
View Source 
const OTHERS = 57720
View Source 
const OUTER = 57409
View Source 
const OUTFILE = 57380
View Source 
const OVER = 57684
View Source 
const OVERWRITE = 57392
View Source 
const PACK_KEYS = 57762
View Source 
const PARSER = 57379
View Source 
const PARTITION = 57522
View Source 
const PARTITIONING = 57519
View Source 
const PASSWORD = 57763
View Source 
const PATH = 57721
View Source 
const PERCENT_RANK = 57685
View Source 
const PERSIST = 57722
View Source 
const PERSIST_ONLY = 57723
View Source 
const PLUGINS = 57615
View Source 
const POINT = 57591
View Source 
const POLYGON = 57593
View Source 
const PRECEDING = 57724
View Source 
const PRIMARY = 57494
View Source 
const PRIVILEGES = 57622
View Source 
const PRIVILEGE_CHECKS_USER = 57725
View Source 
const PROCEDURE = 57526
View Source 
const PROCESS = 57726
View Source 
const PROCESSLIST = 57611
View Source 
const QUERY = 57661
View Source 
const RANDOM = 57727
View Source 
const RANK = 57686
View Source 
const READ = 57630
View Source 
const REAL = 57565
View Source 
const REBUILD = 57518
View Source 
const RECURSIVE = 57687
View Source 
const REDUNDANT = 57767
View Source 
const REFERENCE = 57728
View Source 
const REFERENCES = 57506
View Source 
const REGEXP = 57461
View Source 
const RELEASE = 57555
View Source 
const REMOVE = 57520
View Source 
const RENAME = 57480
View Source 
const REORGANIZE = 57523
View Source 
const REPAIR = 57513
View Source 
const REPEATABLE = 57633
View Source 
const REPLACE = 57647
View Source 
const REQUIRE_ROW_FORMAT = 57729
View Source 
const RESOURCE = 57730
View Source 
const RESPECT = 57731
View Source 
const RESTART = 57732
View Source 
const RESTRICT = 57507
View Source 
const RETAIN = 57733
View Source 
const REUSE = 57734
View Source 
const RIGHT = 57407
View Source 
const ROLE = 57735
View Source 
const ROLLBACK = 57553
View Source 
const ROW_FORMAT = 57769
View Source 
const ROW_NUMBER = 57688
View Source 
const S3 = 57381
View Source 
const SAVEPOINT = 57554
View Source 
const SCHEMA = 57486
View Source 
const SCHEMAS = 57606
View Source 
const SECONDARY = 57736
View Source 
const SECONDARY_ENGINE = 57737
View Source 
const SECONDARY_LOAD = 57738
View Source 
const SECONDARY_UNLOAD = 57739
View Source 
const SECURITY = 57545
View Source 
const SELECT = 57348
View Source 
const SEPARATOR = 57653
View Source 
const SEQUENCE = 57541
View Source 
const SERIALIZABLE = 57636
View Source 
const SESSION = 57627
View Source 
const SET = 57373
View Source 
const SHARE = 57399
View Source 
const SHARED = 57420
View Source 
const SHIFT_LEFT = 57463
View Source 
const SHIFT_RIGHT = 57464
View Source 
const SHOW = 57508
View Source 
const SIGNED = 57601
View Source 
const SKIP = 57740
View Source 
const SMALLINT = 57559
View Source 
const SPATIAL = 57496
View Source 
const SQL = 57539
View Source 
const SQL_CACHE = 57402
View Source 
const SQL_CALC_FOUND_ROWS = 57403
View Source 
const SQL_NO_CACHE = 57401
View Source 
const SRID = 57741
View Source 
const START = 57550
View Source 
const STARTING = 57393
View Source 
const STATS_AUTO_RECALC = 57770
View Source 
const STATS_PERSISTENT = 57771
View Source 
const STATS_SAMPLE_PAGES = 57772
View Source 
const STATUS = 57533
View Source 
const STORAGE = 57773
View Source 
const STRAIGHT_JOIN = 57405
View Source 
const STREAM = 57349
View Source 
const STRING = 57426
View Source 
const SUBSTR = 57650
View Source 
const SUBSTRING = 57651
View Source 
const SYSTEM = 57689
View Source 
const TABLE = 57487
View Source 
const TABLES = 57607
View Source 
const TABLESPACE = 57444
View Source 
const TEMPTABLE = 57543
View Source 
const TERMINATED = 57385
View Source 
const TEXT = 57580
View Source 
const THAN = 57525
View Source 
const THEN = 57452
View Source 
const THREAD_PRIORITY = 57742
View Source 
const TIES = 57743
View Source 
const TIME = 57570
View Source 
const TIMESTAMP = 57571
View Source 
const TIMESTAMPADD = 57654
View Source 
const TIMESTAMPDIFF = 57655
View Source 
const TINYBLOB = 57585
View Source 
const TINYINT = 57558
View Source 
const TINYTEXT = 57581
View Source 
const TO = 57490
View Source 
const TRADITIONAL = 57750
View Source 
const TRANSACTION = 57551
View Source 
const TREE = 57748
View Source 
const TRIGGER = 57527
View Source 
const TRUE = 57437
View Source 
const TRUNCATE = 57515
View Source 
const UNARY = 57467
View Source 
const UNBOUNDED = 57744
View Source 
const UNCOMMITTED = 57635
View Source 
const UNDEFINED = 57540
View Source 
const UNDERSCORE_BINARY = 57470
View Source 
const UNDERSCORE_LATIN1 = 57473
View Source 
const UNDERSCORE_UTF8 = 57472
View Source 
const UNDERSCORE_UTF8MB4 = 57471
View Source 
const UNION = 57347
View Source 
const UNIQUE = 57493
View Source 
const UNLOCK = 57375
View Source 
const UNSIGNED = 57602
View Source 
const UNUSED = 57665
View Source 
const UPDATE = 57352
View Source 
const UPGRADE = 57532
View Source 
const USE = 57412
View Source 
const USING = 57415
View Source 
const UTC_DATE = 57644
View Source 
const UTC_TIME = 57645
View Source 
const UTC_TIMESTAMP = 57646
View Source 
const VALIDATION = 57664
View Source 
const VALUE = 57398
View Source 
const VALUES = 57395
View Source 
const VALUE_ARG = 57430
View Source 
const VARBINARY = 57578
View Source 
const VARCHAR = 57575
View Source 
const VARIABLES = 57534
View Source 
const VCPU = 57745
View Source 
const VIEW = 57489
View Source 
const VINDEX = 57528
View Source 
const VINDEXES = 57529
View Source 
const VISIBLE = 57746
View Source 
const VITESS = 57749
View Source 
const VITESS_KEYSPACES = 57618
View Source 
const VITESS_METADATA = 57608
View Source 
const VITESS_SHARDS = 57619
View Source 
const VITESS_TABLETS = 57620
View Source 
const VSCHEMA = 57609
View Source 
const VSTREAM = 57350
View Source 
const WARNINGS = 57535
View Source 
const WHEN = 57451
View Source 
const WHERE = 57355
View Source 
const WINDOW = 57690
View Source 
const WITH = 57660
View Source 
const WITHOUT = 57663
View Source 
const WORK = 57556
View Source 
const WRITE = 57631
View Source 
const XOR = 57446
View Source 
const YEAR = 57573
View Source 
const ZEROFILL = 57603

Variables

View Source 
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)")
)
View Source 
var Aggregates = map[string]bool{
	"avg":          true,
	"bit_and":      true,
	"bit_or":       true,
	"bit_xor":      true,
	"count":        true,
	"group_concat": true,
	"max":          true,
	"min":          true,
	"std":          true,
	"stddev_pop":   true,
	"stddev_samp":  true,
	"stddev":       true,
	"sum":          true,
	"var_pop":      true,
	"var_samp":     true,
	"variance":     true,
}

Aggregates is a map of all aggregate functions.

View Source 
var ErrEmpty = errors.New("empty statement")

ErrEmpty is a sentinel error returned when parsing empty statements.

View Source 
var ErrExprNotSupported = fmt.Errorf("Expr Not Supported")

ErrExprNotSupported signals that the expression cannot be handled by expression evaluation engine.

Functions

func Append 

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

Append appends the SQLNode to the buffer.

func CachePlan added in v0.9.0 

func CachePlan(stmt Statement) bool

CachePlan takes Statement and returns true if the query plan should be cached

func CanNormalize 

func CanNormalize(stmt Statement) bool

CanNormalize takes Statement and returns if the statement can be normalized.

func Convert 

func Convert(e Expr) (evalengine.Expr, error)

Convert converts between AST expressions and executable expressions

func EncodeValue 

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

EncodeValue encodes one bind variable value into the query.

func ExtractMysqlComment 

func ExtractMysqlComment(sql string) (string, string)

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

func FetchBindVar 

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

FetchBindVar resolves the bind variable by fetching it from bindVariables.

func FormatImpossibleQuery 

func FormatImpossibleQuery(buf *TrackedBuffer, node SQLNode)

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

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

func Fuzz 

func Fuzz(data []byte) int

func GetBindvars 

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

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

func IgnoreMaxMaxMemoryRowsDirective 

func IgnoreMaxMaxMemoryRowsDirective(stmt Statement) bool

IgnoreMaxMaxMemoryRowsDirective returns true if the max memory rows override directive is set to true.

func IgnoreMaxPayloadSizeDirective 

func IgnoreMaxPayloadSizeDirective(stmt Statement) bool

IgnoreMaxPayloadSizeDirective returns true if the max payload size override directive is set to true.

func IsColName 

func IsColName(node Expr) bool

IsColName returns true if the Expr is a *ColName.

func IsDML 

func IsDML(sql string) bool

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

func IsDMLStatement 

func IsDMLStatement(stmt Statement) bool

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

func IsLockingFunc 

func IsLockingFunc(node Expr) bool

IsLockingFunc returns true for all functions that are used to work with mysql advisory locks

func IsNull 

func IsNull(node Expr) bool

IsNull returns true if the Expr is SQL NULL

func IsSetStatement 

func IsSetStatement(stmt Statement) bool

IsSetStatement takes Statement and returns if the statement is set statement.

func IsSimpleTuple 

func IsSimpleTuple(node Expr) bool

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

func IsValue 

func IsValue(node Expr) bool

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

func KeywordString 

func KeywordString(id int) string

KeywordString returns the string corresponding to the given keyword

func LikeToRegexp 

func LikeToRegexp(likeExpr string) *regexp.Regexp

LikeToRegexp converts a like sql expression to regular expression

func NewPlanValue 

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

NewPlanValue builds a sqltypes.PlanValue from an Expr.

func Normalize 

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

Normalize changes the statement to use bind values, and updates the bind vars to those values. The supplied prefix is used to generate the bind var names. The function ensures that there are no collisions with existing bind vars. Within Select constructs, bind vars are deduped. This allows us to identify vindex equality. Otherwise, every value is treated as distinct.

func NormalizeAlphabetically added in v0.8.0 

func NormalizeAlphabetically(query string) (normalized string, err error)

NormalizeAlphabetically rewrites given query such that: - WHERE 'AND' expressions are reordered alphabetically

func ParseAndBind added in v0.9.0 

func ParseAndBind(in string, binds ...*querypb.BindVariable) (query string, err error)

ParseAndBind is a one step sweep that binds variables to an input query, in order of placeholders. It is useful when one doesn't have any parser-variables, just bind variables. Example: 

query, err := ParseAndBind("select * from tbl where name=%a", sqltypes.StringBindVariable("it's me"))

func ParseTable added in v0.9.0 

func ParseTable(input string) (keyspace, table string, err error)

ParseTable parses the input as a qualified table name. It handles all valid literal escaping.

func ParseTokenizer 

func ParseTokenizer(tokenizer *Tokenizer) int

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 QueryMatchesTemplates added in v0.8.0 

func QueryMatchesTemplates(query string, queryTemplates []string) (match bool, err error)

QueryMatchesTemplates sees if the given query has the same fingerprint as one of the given templates (one is enough)

func RedactSQLQuery 

func RedactSQLQuery(sql string) (string, error)

RedactSQLQuery returns a sql string with the params stripped out for display

func SkipQueryPlanCacheDirective 

func SkipQueryPlanCacheDirective(stmt Statement) bool

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

func SplitStatement 

func SplitStatement(blob string) (string, string, error)

SplitStatement returns the first sql statement up to either a ; or EOF and the remainder from the given buffer

func SplitStatementToPieces 

func SplitStatementToPieces(blob string) (pieces []string, err error)

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 String 

func String(node SQLNode) string

String returns a string representation of an SQLNode.

func StripLeadingComments 

func StripLeadingComments(sql string) string

StripLeadingComments trims the SQL string and removes any leading comments

func SystemSchema added in v0.9.0 

func SystemSchema(schema string) bool

SystemSchema returns true if the schema passed is system schema

func TruncateForLog 

func TruncateForLog(query string) string

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 

func TruncateForUI(query string) string

TruncateForUI is used when displaying queries on various Vitess status pages to keep the pages small enough to load and render properly

func Walk 

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

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

Types

type AccessMode 

type AccessMode int8

AccessMode is enum for the mode - ReadOnly or ReadWrite 

const (
	ReadOnly AccessMode = iota
	ReadWrite
)

Constants for Enum type - AccessMode

func (AccessMode) Format 

func (node AccessMode) Format(buf *TrackedBuffer)

Format formats the node.

type AddColumns added in v0.9.0 

type AddColumns struct {
	Columns []*ColumnDefinition
	First   *ColName
	After   *ColName
}

AddColumns represents a ADD COLUMN alter option

func (*AddColumns) Format added in v0.9.0 

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

Format formats the node.

type AddConstraintDefinition added in v0.9.0 

type AddConstraintDefinition struct {
	ConstraintDefinition *ConstraintDefinition
}

AddConstraintDefinition represents a ADD CONSTRAINT alter option

func (*AddConstraintDefinition) Format added in v0.9.0 

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

Format formats the node.

type AddIndexDefinition added in v0.9.0 

type AddIndexDefinition struct {
	IndexDefinition *IndexDefinition
}

AddIndexDefinition represents a ADD INDEX alter option

func (*AddIndexDefinition) Format added in v0.9.0 

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

Format formats the node.

type AlgorithmValue added in v0.9.0 

type AlgorithmValue string

AlgorithmValue is the algorithm specified in the alter table command

func (AlgorithmValue) Format added in v0.9.0 

func (node AlgorithmValue) Format(buf *TrackedBuffer)

Format formats the node.

type AliasedExpr 

type AliasedExpr struct {
	Expr Expr
	As   ColIdent
}

AliasedExpr defines an aliased SELECT expression.

func (*AliasedExpr) Format 

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

Format formats the node.

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.

func (*AliasedTableExpr) TableName added in v0.9.0 

func (node *AliasedTableExpr) TableName() (TableName, error)

TableName returns a TableName pointing to this table expr

type AlterCharset added in v0.9.0 

type AlterCharset struct {
	CharacterSet string
	Collate      string
}

AlterCharset is used to set the default or change the character set and collation in alter table command

func (*AlterCharset) Format added in v0.9.0 

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

Format formats the node

type AlterColumn added in v0.9.0 

type AlterColumn struct {
	Column      *ColName
	DropDefault bool
	DefaultVal  Expr
}

AlterColumn is used to add or drop defaults to columns in alter table command

func (*AlterColumn) Format added in v0.9.0 

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

Format formats the node

type AlterDatabase added in v0.9.0 

type AlterDatabase struct {
	DBName              string
	UpdateDataDirectory bool
	AlterOptions        []CollateAndCharset
	FullyParsed         bool
}

AlterDatabase represents a ALTER database statement.

func (*AlterDatabase) Format added in v0.9.0 

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

Format formats the node.

func (*AlterDatabase) GetDatabaseName added in v0.9.0 

func (node *AlterDatabase) GetDatabaseName() string

GetDatabaseName implements the DBDDLStatement interface

func (*AlterDatabase) IsFullyParsed added in v0.9.0 

func (node *AlterDatabase) IsFullyParsed() bool

IsFullyParsed implements the DBDDLStatement interface

type AlterOption added in v0.9.0 

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

AlterOption is an interface that represents the various options in ALTER TABLE statements

type AlterTable added in v0.9.0 

type AlterTable struct {
	Table         TableName
	AlterOptions  []AlterOption
	PartitionSpec *PartitionSpec
	FullyParsed   bool
}

AlterTable represents a ALTER TABLE statement.

func (*AlterTable) AffectedTables added in v0.9.0 

func (node *AlterTable) AffectedTables() TableNames

AffectedTables returns the list table names affected by the DDLStatement.

func (*AlterTable) Format added in v0.9.0 

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

Format formats the AlterTable node.

func (*AlterTable) GetAction added in v0.9.0 

func (node *AlterTable) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*AlterTable) GetFromTables added in v0.9.0 

func (node *AlterTable) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*AlterTable) GetIfExists added in v0.9.0 

func (node *AlterTable) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*AlterTable) GetOptLike added in v0.9.0 

func (node *AlterTable) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*AlterTable) GetTable added in v0.9.0 

func (node *AlterTable) GetTable() TableName

GetTable implements the DDLStatement interface

func (*AlterTable) GetTableSpec added in v0.9.0 

func (node *AlterTable) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*AlterTable) GetToTables added in v0.9.0 

func (node *AlterTable) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*AlterTable) IsFullyParsed added in v0.9.0 

func (node *AlterTable) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*AlterTable) SetFromTables added in v0.9.0 

func (node *AlterTable) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*AlterTable) SetTable added in v0.9.0 

func (node *AlterTable) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type AlterView added in v0.9.0 

type AlterView struct {
	ViewName    TableName
	Algorithm   string
	Definer     string
	Security    string
	Columns     Columns
	Select      SelectStatement
	CheckOption string
}

AlterView represents a ALTER VIEW query

func (*AlterView) AffectedTables added in v0.9.0 

func (node *AlterView) AffectedTables() TableNames

AffectedTables implements DDLStatement.

func (*AlterView) Format added in v0.9.0 

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

Format formats the node.

func (*AlterView) GetAction added in v0.9.0 

func (node *AlterView) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*AlterView) GetFromTables added in v0.9.0 

func (node *AlterView) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*AlterView) GetIfExists added in v0.9.0 

func (node *AlterView) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*AlterView) GetOptLike added in v0.9.0 

func (node *AlterView) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*AlterView) GetTable added in v0.9.0 

func (node *AlterView) GetTable() TableName

GetTable implements the DDLStatement interface

func (*AlterView) GetTableSpec added in v0.9.0 

func (node *AlterView) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*AlterView) GetToTables added in v0.9.0 

func (node *AlterView) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*AlterView) IsFullyParsed added in v0.9.0 

func (node *AlterView) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*AlterView) SetFromTables added in v0.9.0 

func (node *AlterView) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*AlterView) SetTable added in v0.9.0 

func (node *AlterView) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type AlterVschema added in v0.9.0 

type AlterVschema struct {
	Action DDLAction
	Table  TableName

	// VindexSpec is set for CreateVindexDDLAction, DropVindexDDLAction, AddColVindexDDLAction, DropColVindexDDLAction.
	VindexSpec *VindexSpec

	// VindexCols is set for AddColVindexDDLAction.
	VindexCols []ColIdent

	// AutoIncSpec is set for AddAutoIncDDLAction.
	AutoIncSpec *AutoIncSpec
}

AlterVschema represents a ALTER VSCHEMA statement.

func (*AlterVschema) Format added in v0.9.0 

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

Format formats the node.

type AndExpr 

type AndExpr struct {
	Left, Right Expr
}

AndExpr represents an AND expression.

func (*AndExpr) Format 

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

Format formats the node.

type ApplyFunc 

type ApplyFunc func(*Cursor) bool

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 Argument added in v0.8.0 

type Argument []byte

Argument represents bindvariable expression

func NewArgument added in v0.8.0 

func NewArgument(in []byte) Argument

NewArgument builds a new ValArg.

func (Argument) Format added in v0.8.0 

func (node Argument) Format(buf *TrackedBuffer)

Format formats the node.

type AtCount 

type AtCount int

AtCount represents the '@' count in ColIdent 

const (
	// NoAt represents no @
	NoAt AtCount = iota
	// SingleAt represents @
	SingleAt
	// DoubleAt represnts @@
	DoubleAt
)

type AutoIncSpec 

type AutoIncSpec struct {
	Column   ColIdent
	Sequence TableName
}

AutoIncSpec defines and autoincrement value for a ADD AUTO_INCREMENT statement

func (*AutoIncSpec) Format 

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

Format formats the node.

type Begin 

type Begin struct{}

Begin represents a Begin statement.

func (*Begin) Format 

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

Format formats the node.

type BinaryExpr 

type BinaryExpr struct {
	Operator    BinaryExprOperator
	Left, Right Expr
}

BinaryExpr represents a binary value expression.

func (*BinaryExpr) Format 

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

Format formats the node.

type BinaryExprOperator added in v0.8.0 

type BinaryExprOperator int8

BinaryExprOperator is an enum for BinaryExpr.Operator 

const (
	BitAndOp BinaryExprOperator = iota
	BitOrOp
	BitXorOp
	PlusOp
	MinusOp
	MultOp
	DivOp
	IntDivOp
	ModOp
	ShiftLeftOp
	ShiftRightOp
	JSONExtractOp
	JSONUnquoteExtractOp
)

Constant for Enum Type - BinaryExprOperator

func (BinaryExprOperator) ToString added in v0.8.0 

func (op BinaryExprOperator) ToString() string

ToString returns the operator as a string

type BindVarNeeds 

type BindVarNeeds struct {
	NeedFunctionResult,
	NeedSystemVariable,

	NeedUserDefinedVariables []string
	// contains filtered or unexported fields
}

BindVarNeeds represents the bind vars that need to be provided as the result of expression rewriting.

func (*BindVarNeeds) AddFuncResult added in v0.8.0 

func (bvn *BindVarNeeds) AddFuncResult(name string)

AddFuncResult adds a function bindvar need

func (*BindVarNeeds) AddSysVar added in v0.8.0 

func (bvn *BindVarNeeds) AddSysVar(name string)

AddSysVar adds a system variable bindvar need

func (*BindVarNeeds) AddUserDefVar added in v0.8.0 

func (bvn *BindVarNeeds) AddUserDefVar(name string)

AddUserDefVar adds a user defined variable bindvar need

func (*BindVarNeeds) HasRewrites added in v0.8.0 

func (bvn *BindVarNeeds) HasRewrites() bool

func (*BindVarNeeds) MergeWith added in v0.8.0 

func (bvn *BindVarNeeds) MergeWith(other *BindVarNeeds)

MergeWith adds bind vars needs coming from sub scopes

func (*BindVarNeeds) NeedsFuncResult added in v0.8.0 

func (bvn *BindVarNeeds) NeedsFuncResult(name string) bool

NeedsFuncResult says if a function result needs to be provided

func (*BindVarNeeds) NeedsSysVar added in v0.8.0 

func (bvn *BindVarNeeds) NeedsSysVar(name string) bool

NeedsSysVar says if a function result needs to be provided

func (*BindVarNeeds) NoteRewrite added in v0.9.0 

func (bvn *BindVarNeeds) NoteRewrite()

type BoolVal 

type BoolVal bool

BoolVal is true or false.

func (BoolVal) Format 

func (node BoolVal) Format(buf *TrackedBuffer)

Format formats the node.

type CaseExpr 

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

CaseExpr represents a CASE expression.

func (*CaseExpr) Format 

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

Format formats the node.

type ChangeColumn added in v0.9.0 

type ChangeColumn struct {
	OldColumn        *ColName
	NewColDefinition *ColumnDefinition
	First            *ColName
	After            *ColName
}

ChangeColumn is used to change the column definition, can also rename the column in alter table command

func (*ChangeColumn) Format added in v0.9.0 

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

Format formats the node

type Characteristic 

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

Characteristic is a transaction related change

type CheckConstraintDefinition added in v0.9.0 

type CheckConstraintDefinition struct {
	Expr     Expr
	Enforced bool
}

CheckConstraintDefinition describes a check constraint in a CREATE TABLE statement

func (*CheckConstraintDefinition) Format added in v0.9.0 

func (c *CheckConstraintDefinition) 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 NewColIdent 

func NewColIdent(str string) ColIdent

NewColIdent makes a new ColIdent.

func NewColIdentWithAt 

func NewColIdentWithAt(str string, at AtCount) ColIdent

NewColIdentWithAt makes a new ColIdent.

func (ColIdent) AtCount 

func (node ColIdent) AtCount() AtCount

AtCount return the '@' count present in ColIdent Name

func (ColIdent) CompliantName 

func (node ColIdent) CompliantName() string

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

func (ColIdent) Equal 

func (node ColIdent) Equal(in ColIdent) bool

Equal performs a case-insensitive compare.

func (ColIdent) EqualString 

func (node ColIdent) EqualString(str string) bool

EqualString performs a case-insensitive compare with str.

func (ColIdent) Format 

func (node ColIdent) Format(buf *TrackedBuffer)

Format formats the node.

func (ColIdent) IsEmpty 

func (node ColIdent) IsEmpty() bool

IsEmpty returns true if the name is empty.

func (ColIdent) Lowered 

func (node ColIdent) Lowered() string

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

func (ColIdent) MarshalJSON 

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

MarshalJSON marshals into JSON.

func (ColIdent) String 

func (node ColIdent) String() string

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

func (*ColIdent) UnmarshalJSON 

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

UnmarshalJSON unmarshals from JSON.

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 NewColName added in v0.8.0 

func NewColName(str string) *ColName

NewColName makes a new ColName

func NewColNameWithQualifier added in v0.9.0 

func NewColNameWithQualifier(identifier string, table TableName) *ColName

NewColNameWithQualifier makes a new ColName pointing to a specific table

func (*ColName) Equal 

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

Equal returns true if the column names match.

func (*ColName) Format 

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

Format formats the node.

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 CollateAndCharset added in v0.9.0 

type CollateAndCharset struct {
	Type      CollateAndCharsetType
	IsDefault bool
	Value     string
}

CollateAndCharset is a struct that stores Collation or Character Set value

type CollateAndCharsetType added in v0.9.0 

type CollateAndCharsetType int8

CollateAndCharsetType is an enum for CollateAndCharset.Type 

const (
	CollateType CollateAndCharsetType = iota
	CharacterSetType
)

Constant for Enum Type - CollateAndCharsetType

func (CollateAndCharsetType) ToString added in v0.9.0 

func (node CollateAndCharsetType) ToString() string

ToString returns the type as a string

type CollateExpr 

type CollateExpr struct {
	Expr    Expr
	Charset string
}

CollateExpr represents dynamic collate operator.

func (*CollateExpr) Format 

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

Format formats the node.

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       bool
	Autoincrement bool
	Default       Expr
	OnUpdate      Expr
	Comment       *Literal

	// Numeric field options
	Length   *Literal
	Unsigned bool
	Zerofill bool
	Scale    *Literal

	// 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 

func (node Columns) FindColumn(col ColIdent) int

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

func (Columns) Format 

func (node Columns) Format(buf *TrackedBuffer)

Format formats the node.

type CommentDirectives 

type CommentDirectives map[string]interface{}

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

func ExtractCommentDirectives 

func ExtractCommentDirectives(comments Comments) CommentDirectives

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

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

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

func (CommentDirectives) IsSet 

func (d CommentDirectives) IsSet(key string) bool

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

type Comments 

type Comments [][]byte

Comments represents a list of comments.

func (Comments) Format 

func (node Comments) Format(buf *TrackedBuffer)

Format formats the node.

type Commit 

type Commit struct{}

Commit represents a Commit statement.

func (*Commit) Format 

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

Format formats the node.

type ComparisonExpr 

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

ComparisonExpr represents a two-value comparison expression.

func (*ComparisonExpr) Format 

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

Format formats the node.

func (*ComparisonExpr) IsImpossible 

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 ComparisonExprOperator added in v0.8.0 

type ComparisonExprOperator int8

ComparisonExprOperator is an enum for ComparisonExpr.Operator 

const (
	EqualOp ComparisonExprOperator = iota
	LessThanOp
	GreaterThanOp
	LessEqualOp
	GreaterEqualOp
	NotEqualOp
	NullSafeEqualOp
	InOp
	NotInOp
	LikeOp
	NotLikeOp
	RegexpOp
	NotRegexpOp
)

Constants for Enum Type - ComparisonExprOperator

func (ComparisonExprOperator) ToString added in v0.8.0 

func (op ComparisonExprOperator) ToString() string

ToString returns the operator as a string

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 

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

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

func (*ConvertType) Format 

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

Format formats the node.

type ConvertTypeOperator added in v0.8.0 

type ConvertTypeOperator int8

ConvertTypeOperator is an enum for ConvertType.Operator 

const (
	NoOperator ConvertTypeOperator = iota
	CharacterSetOp
)

Constant for Enum Type - ConvertTypeOperator

func (ConvertTypeOperator) ToString added in v0.8.0 

func (op ConvertTypeOperator) ToString() string

ToString returns the operator as a string

type ConvertUsingExpr 

type ConvertUsingExpr struct {
	Expr Expr
	Type string
}

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

func (*ConvertUsingExpr) Format 

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

Format formats the node.

type CreateDatabase added in v0.9.0 

type CreateDatabase struct {
	DBName        string
	IfNotExists   bool
	CreateOptions []CollateAndCharset
	FullyParsed   bool
}

CreateDatabase represents a CREATE database statement.

func (*CreateDatabase) Format added in v0.9.0 

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

Format formats the node.

func (*CreateDatabase) GetDatabaseName added in v0.9.0 

func (node *CreateDatabase) GetDatabaseName() string

GetDatabaseName implements the DBDDLStatement interface

func (*CreateDatabase) IsFullyParsed added in v0.9.0 

func (node *CreateDatabase) IsFullyParsed() bool

IsFullyParsed implements the DBDDLStatement interface

type CreateIndex added in v0.9.0 

type CreateIndex struct {
	Constraint  string
	Name        ColIdent
	Table       TableName
	Columns     []*IndexColumn
	Options     []*IndexOption
	FullyParsed bool
}

CreateIndex represents a CREATE INDEX query

func (*CreateIndex) AffectedTables added in v0.9.0 

func (node *CreateIndex) AffectedTables() TableNames

AffectedTables implements DDLStatement.

func (*CreateIndex) Format added in v0.9.0 

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

Format formats the node.

func (*CreateIndex) GetAction added in v0.9.0 

func (node *CreateIndex) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*CreateIndex) GetFromTables added in v0.9.0 

func (node *CreateIndex) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*CreateIndex) GetIfExists added in v0.9.0 

func (node *CreateIndex) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*CreateIndex) GetOptLike added in v0.9.0 

func (node *CreateIndex) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*CreateIndex) GetTable added in v0.9.0 

func (node *CreateIndex) GetTable() TableName

GetTable implements the DDLStatement interface

func (*CreateIndex) GetTableSpec added in v0.9.0 

func (node *CreateIndex) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*CreateIndex) GetToTables added in v0.9.0 

func (node *CreateIndex) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*CreateIndex) IsFullyParsed added in v0.9.0 

func (node *CreateIndex) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*CreateIndex) SetFromTables added in v0.9.0 

func (node *CreateIndex) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*CreateIndex) SetTable added in v0.9.0 

func (node *CreateIndex) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type CreateTable added in v0.9.0 

type CreateTable struct {
	Table       TableName
	IfNotExists bool
	TableSpec   *TableSpec
	OptLike     *OptLike
	FullyParsed bool
}

CreateTable represents a CREATE TABLE statement.

func (*CreateTable) AffectedTables added in v0.9.0 

func (node *CreateTable) AffectedTables() TableNames

AffectedTables implements DDLStatement.

func (*CreateTable) Format added in v0.9.0 

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

Format formats the node.

func (*CreateTable) GetAction added in v0.9.0 

func (node *CreateTable) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*CreateTable) GetFromTables added in v0.9.0 

func (node *CreateTable) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*CreateTable) GetIfExists added in v0.9.0 

func (node *CreateTable) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*CreateTable) GetOptLike added in v0.9.0 

func (node *CreateTable) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*CreateTable) GetTable added in v0.9.0 

func (node *CreateTable) GetTable() TableName

GetTable implements the DDLStatement interface

func (*CreateTable) GetTableSpec added in v0.9.0 

func (node *CreateTable) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*CreateTable) GetToTables added in v0.9.0 

func (node *CreateTable) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*CreateTable) IsFullyParsed added in v0.9.0 

func (node *CreateTable) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*CreateTable) SetFromTables added in v0.9.0 

func (node *CreateTable) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*CreateTable) SetTable added in v0.9.0 

func (node *CreateTable) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type CreateView added in v0.9.0 

type CreateView struct {
	ViewName    TableName
	Algorithm   string
	Definer     string
	Security    string
	Columns     Columns
	Select      SelectStatement
	CheckOption string
	IsReplace   bool
}

CreateView represents a CREATE VIEW query

func (*CreateView) AffectedTables added in v0.9.0 

func (node *CreateView) AffectedTables() TableNames

AffectedTables implements DDLStatement.

func (*CreateView) Format added in v0.9.0 

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

Format formats the node.

func (*CreateView) GetAction added in v0.9.0 

func (node *CreateView) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*CreateView) GetFromTables added in v0.9.0 

func (node *CreateView) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*CreateView) GetIfExists added in v0.9.0 

func (node *CreateView) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*CreateView) GetOptLike added in v0.9.0 

func (node *CreateView) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*CreateView) GetTable added in v0.9.0 

func (node *CreateView) GetTable() TableName

GetTable implements the DDLStatement interface

func (*CreateView) GetTableSpec added in v0.9.0 

func (node *CreateView) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*CreateView) GetToTables added in v0.9.0 

func (node *CreateView) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*CreateView) IsFullyParsed added in v0.9.0 

func (node *CreateView) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*CreateView) SetFromTables added in v0.9.0 

func (node *CreateView) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*CreateView) SetTable added in v0.9.0 

func (node *CreateView) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type CurTimeFuncExpr 

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 

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

Format formats the node.

type Cursor 

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.

func (*Cursor) Node 

func (c *Cursor) Node() SQLNode

Node returns the current Node.

func (*Cursor) Parent 

func (c *Cursor) Parent() SQLNode

Parent returns the parent of the current Node.

func (*Cursor) Replace 

func (c *Cursor) Replace(newNode SQLNode)

Replace replaces the current node in the parent field with this new object. The use needs to make sure to not replace the object with something of the wrong type, or the visitor will panic.

type DBDDLStatement added in v0.9.0 

type DBDDLStatement interface {
	IsFullyParsed() bool
	GetDatabaseName() string
	Statement
	// contains filtered or unexported methods
}

DBDDLStatement represents any DBDDL Statement

type DDL 

type DDL struct {
	Action DDLAction

	// FromTables is set if Action is RenameDDLAction or DropDDLAction.
	FromTables TableNames

	// ToTables is set if Action is RenameDDLAction.
	ToTables TableNames

	// Table is set if Action is other than RenameDDLAction or DropDDLAction.
	Table TableName

	// The following fields are set if a DDL was fully analyzed.
	IfExists      bool
	TableSpec     *TableSpec
	OptLike       *OptLike
	PartitionSpec *PartitionSpec
}

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 DDLStatement.

func (*DDL) Format 

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

Format formats the node.

func (*DDL) GetAction added in v0.9.0 

func (node *DDL) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*DDL) GetFromTables added in v0.9.0 

func (node *DDL) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*DDL) GetIfExists added in v0.9.0 

func (node *DDL) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*DDL) GetOptLike added in v0.9.0 

func (node *DDL) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*DDL) GetTable added in v0.9.0 

func (node *DDL) GetTable() TableName

GetTable implements the DDLStatement interface

func (*DDL) GetTableSpec added in v0.9.0 

func (node *DDL) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*DDL) GetToTables added in v0.9.0 

func (node *DDL) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*DDL) IsFullyParsed added in v0.9.0 

func (*DDL) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*DDL) SetFromTables added in v0.9.0 

func (node *DDL) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*DDL) SetTable added in v0.9.0 

func (node *DDL) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type DDLAction added in v0.8.0 

type DDLAction int8

DDLAction is an enum for DDL.Action 

const (
	CreateDDLAction DDLAction = iota
	AlterDDLAction
	DropDDLAction
	RenameDDLAction
	TruncateDDLAction
	FlushDDLAction
	CreateVindexDDLAction
	DropVindexDDLAction
	AddVschemaTableDDLAction
	DropVschemaTableDDLAction
	AddColVindexDDLAction
	DropColVindexDDLAction
	AddSequenceDDLAction
	AddAutoIncDDLAction
)

Constants for Enum Type - DDL.Action

func (DDLAction) ToString added in v0.8.0 

func (action DDLAction) ToString() string

ToString returns the string associated with the DDLAction Enum

type DDLStatement added in v0.9.0 

type DDLStatement interface {
	IsFullyParsed() bool
	GetTable() TableName
	GetAction() DDLAction
	GetOptLike() *OptLike
	GetIfExists() bool
	GetTableSpec() *TableSpec
	GetFromTables() TableNames
	GetToTables() TableNames
	AffectedTables() TableNames
	SetTable(qualifier string, name string)
	SetFromTables(tables TableNames)
	Statement
	// contains filtered or unexported methods
}

DDLStatement represents any DDL Statement

type Default 

type Default struct {
	ColName string
}

Default represents a DEFAULT expression.

func (*Default) Format 

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

Format formats the node.

type Delete 

type Delete struct {
	Ignore     Ignore
	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.

func (*Delete) Format 

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

Format formats the node.

type DerivedTable added in v0.9.0 

type DerivedTable struct {
	Select SelectStatement
}

DerivedTable represents a subquery used as a table expression.

func (*DerivedTable) Format added in v0.9.0 

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

Format formats the node.

type DropColumn added in v0.9.0 

type DropColumn struct {
	Name *ColName
}

DropColumn is used to drop a column in an alter table statement

func (*DropColumn) Format added in v0.9.0 

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

Format formats the node

type DropDatabase added in v0.9.0 

type DropDatabase struct {
	DBName   string
	IfExists bool
}

DropDatabase represents a DROP database statement.

func (*DropDatabase) Format added in v0.9.0 

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

Format formats the node.

func (*DropDatabase) GetDatabaseName added in v0.9.0 

func (node *DropDatabase) GetDatabaseName() string

GetDatabaseName implements the DBDDLStatement interface

func (*DropDatabase) IsFullyParsed added in v0.9.0 

func (node *DropDatabase) IsFullyParsed() bool

IsFullyParsed implements the DBDDLStatement interface

type DropKey added in v0.9.0 

type DropKey struct {
	Type DropKeyType
	Name string
}

DropKey is used to drop a key in an alter table statement

func (*DropKey) Format added in v0.9.0 

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

Format formats the node

type DropKeyType added in v0.9.0 

type DropKeyType int8

DropKeyType is an enum that represents the type of key being dropped in an alter table statement 

const (
	PrimaryKeyType DropKeyType = iota
	ForeignKeyType
	NormalKeyType
)

DropKeyType constants

func (DropKeyType) ToString added in v0.9.0 

func (key DropKeyType) ToString() string

ToString returns the DropKeyType as a string

type DropTable added in v0.9.0 

type DropTable struct {
	FromTables TableNames
	// The following fields are set if a DDL was fully analyzed.
	IfExists bool
}

DropTable represents a DROP TABLE statement.

func (*DropTable) AffectedTables added in v0.9.0 

func (node *DropTable) AffectedTables() TableNames

AffectedTables returns the list table names affected by the DDLStatement.

func (*DropTable) Format added in v0.9.0 

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

Format formats the node.

func (*DropTable) GetAction added in v0.9.0 

func (node *DropTable) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*DropTable) GetFromTables added in v0.9.0 

func (node *DropTable) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*DropTable) GetIfExists added in v0.9.0 

func (node *DropTable) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*DropTable) GetOptLike added in v0.9.0 

func (node *DropTable) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*DropTable) GetTable added in v0.9.0 

func (node *DropTable) GetTable() TableName

GetTable implements the DDLStatement interface

func (*DropTable) GetTableSpec added in v0.9.0 

func (node *DropTable) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*DropTable) GetToTables added in v0.9.0 

func (node *DropTable) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*DropTable) IsFullyParsed added in v0.9.0 

func (node *DropTable) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*DropTable) SetFromTables added in v0.9.0 

func (node *DropTable) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*DropTable) SetTable added in v0.9.0 

func (node *DropTable) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type DropView added in v0.9.0 

type DropView struct {
	FromTables TableNames
	IfExists   bool
}

DropView represents a DROP VIEW statement.

func (*DropView) AffectedTables added in v0.9.0 

func (node *DropView) AffectedTables() TableNames

AffectedTables returns the list table names affected by the DDLStatement.

func (*DropView) Format added in v0.9.0 

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

Format formats the node.

func (*DropView) GetAction added in v0.9.0 

func (node *DropView) GetAction() DDLAction

GetAction implements the DDLStatement interface

func (*DropView) GetFromTables added in v0.9.0 

func (node *DropView) GetFromTables() TableNames

GetFromTables implements the DDLStatement interface

func (*DropView) GetIfExists added in v0.9.0 

func (node *DropView) GetIfExists() bool

GetIfExists implements the DDLStatement interface

func (*DropView) GetOptLike added in v0.9.0 

func (node *DropView) GetOptLike() *OptLike

GetOptLike implements the DDLStatement interface

func (*DropView) GetTable added in v0.9.0 

func (node *DropView) GetTable() TableName

GetTable implements the DDLStatement interface

func (*DropView) GetTableSpec added in v0.9.0 

func (node *DropView) GetTableSpec() *TableSpec

GetTableSpec implements the DDLStatement interface

func (*DropView) GetToTables added in v0.9.0 

func (node *DropView) GetToTables() TableNames

GetToTables implements the DDLStatement interface

func (*DropView) IsFullyParsed added in v0.9.0 

func (node *DropView) IsFullyParsed() bool

IsFullyParsed implements the DDLStatement interface

func (*DropView) SetFromTables added in v0.9.0 

func (node *DropView) SetFromTables(tables TableNames)

SetFromTables implements DDLStatement.

func (*DropView) SetTable added in v0.9.0 

func (node *DropView) SetTable(qualifier string, name string)

SetTable implements DDLStatement.

type Encodable 

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

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

type ExistsExpr 

type ExistsExpr struct {
	Subquery *Subquery
}

ExistsExpr represents an EXISTS expression.

func (*ExistsExpr) Format 

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

Format formats the node.

type Explain 

type Explain struct {
	Type      ExplainType
	Statement Statement
}

Explain represents an EXPLAIN statement

func (*Explain) Format 

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

Format formats the node.

type ExplainType added in v0.8.0 

type ExplainType int8

ExplainType is an enum for Explain.Type 

const (
	EmptyType ExplainType = iota
	TreeType
	JSONType
	VitessType
	TraditionalType
	AnalyzeType
)

Constant for Enum Type - ExplainType

func (ExplainType) ToString added in v0.8.0 

func (ty ExplainType) ToString() string

ToString returns the type as a string

type Expr 

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

Expr represents an expression.

func ReplaceExpr 

func ReplaceExpr(root, from, to Expr) Expr

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

func SplitAndExpression 

func SplitAndExpression(filters []Expr, node Expr) []Expr

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.

func (Exprs) Format 

func (node Exprs) Format(buf *TrackedBuffer)

Format formats the node.

type Force added in v0.9.0 

type Force struct{}

Force is used to specify force alter option in an alter table statement

func (*Force) Format added in v0.9.0 

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

Format formats the node

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) Format 

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

Format formats the node.

func (*FuncExpr) IsAggregate 

func (node *FuncExpr) IsAggregate() bool

IsAggregate returns true if the function is an aggregate.

type GroupBy 

type GroupBy []Expr

GroupBy represents a GROUP BY clause.

func (GroupBy) Format 

func (node GroupBy) Format(buf *TrackedBuffer)

Format formats the node.

type GroupConcatExpr 

type GroupConcatExpr struct {
	Distinct  bool
	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 Ignore added in v0.8.0 

type Ignore bool

Ignore represents whether ignore was specified or not

func (Ignore) ToString added in v0.8.0 

func (ignore Ignore) ToString() string

ToString returns the IgnoreStr if ignore is true.

type IndexColumn 

type IndexColumn struct {
	Column    ColIdent
	Length    *Literal
	Direction OrderDirection
}

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 

type IndexHints struct {
	Type    IndexHintsType
	Indexes []ColIdent
}

IndexHints represents a list of index hints.

func (*IndexHints) Format 

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

Format formats the node.

type IndexHintsType added in v0.8.0 

type IndexHintsType int8

IndexHintsType is an enum for IndexHints.Type 

const (
	UseOp IndexHintsType = iota
	IgnoreOp
	ForceOp
)

Constant for Enum Type - IndexHintsType

func (IndexHintsType) ToString added in v0.8.0 

func (ty IndexHintsType) ToString() string

ToString returns the type as a string

type IndexInfo 

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

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

func (*IndexInfo) Format 

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

Format formats the node.

type IndexOption 

type IndexOption struct {
	Name   string
	Value  *Literal
	String string
}

IndexOption is used for trailing options for indexes: COMMENT, KEY_BLOCK_SIZE, USING, WITH PARSER

type Insert 

type Insert struct {
	Action     InsertAction
	Comments   Comments
	Ignore     Ignore
	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.

func (*Insert) Format 

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

Format formats the node.

type InsertAction added in v0.8.0 

type InsertAction int8

InsertAction is the action for insert. 

const (
	InsertAct InsertAction = iota
	ReplaceAct
)

Constants for Enum Type - Insert.Action

type InsertRows 

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

InsertRows represents the rows for an INSERT statement.

type InsertValues 

type InsertValues [][]sqltypes.Value

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

func (InsertValues) EncodeSQL 

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

EncodeSQL performs the SQL encoding for InsertValues.

type IntervalExpr 

type IntervalExpr struct {
	Expr Expr
	Unit string
}

IntervalExpr represents a date-time INTERVAL expression.

func (*IntervalExpr) Format 

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

Format formats the node.

type IsExpr 

type IsExpr struct {
	Operator IsExprOperator
	Expr     Expr
}

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

func (*IsExpr) Format 

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

Format formats the node.

type IsExprOperator added in v0.8.0 

type IsExprOperator int8

IsExprOperator is an enum for IsExpr.Operator 

const (
	IsNullOp IsExprOperator = iota
	IsNotNullOp
	IsTrueOp
	IsNotTrueOp
	IsFalseOp
	IsNotFalseOp
)

Constant for Enum Type - IsExprOperator

func (IsExprOperator) ToString added in v0.8.0 

func (op IsExprOperator) ToString() string

ToString returns the operator as a string

type IsolationLevel 

type IsolationLevel int8

IsolationLevel is an enum for isolation levels 

const (
	ReadUncommitted IsolationLevel = iota
	ReadCommitted
	RepeatableRead
	Serializable
)

Constants for Enum type - IsolationLevel

func (IsolationLevel) Format 

func (node IsolationLevel) Format(buf *TrackedBuffer)

Format formats the node.

type JoinCondition 

type JoinCondition struct {
	On    Expr
	Using Columns
}

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      JoinType
	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 JoinType added in v0.8.0 

type JoinType int8

JoinType represents the type of Join for JoinTableExpr 

const (
	NormalJoinType JoinType = iota
	StraightJoinType
	LeftJoinType
	RightJoinType
	NaturalJoinType
	NaturalLeftJoinType
	NaturalRightJoinType
)

Constants for Enum Type - JoinType

func (JoinType) ToString added in v0.8.0 

func (joinType JoinType) ToString() string

ToString returns the string associated with JoinType

type KeyState added in v0.9.0 

type KeyState struct {
	Enable bool
}

KeyState is used to disable or enable the keys in an alter table statement

func (*KeyState) Format added in v0.9.0 

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

Format formats the node

type LengthScaleOption 

type LengthScaleOption struct {
	Length *Literal
	Scale  *Literal
}

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

type Limit 

type Limit struct {
	Offset, Rowcount Expr
}

Limit represents a LIMIT clause.

func (*Limit) Format 

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

Format formats the node.

type ListArg 

type ListArg []byte

ListArg represents a named list argument.

func (ListArg) Format 

func (node ListArg) Format(buf *TrackedBuffer)

Format formats the node.

type Literal added in v0.8.0 

type Literal struct {
	Type ValType
	Val  []byte
}

Literal represents a fixed value.

func NewBitLiteral added in v0.8.0 

func NewBitLiteral(in []byte) *Literal

NewBitLiteral builds a new BitVal containing a bit literal.

func NewFloatLiteral added in v0.8.0 

func NewFloatLiteral(in []byte) *Literal

NewFloatLiteral builds a new FloatVal.

func NewHexLiteral added in v0.8.0 

func NewHexLiteral(in []byte) *Literal

NewHexLiteral builds a new HexVal.

func NewHexNumLiteral added in v0.8.0 

func NewHexNumLiteral(in []byte) *Literal

NewHexNumLiteral builds a new HexNum.

func NewIntLiteral added in v0.8.0 

func NewIntLiteral(in []byte) *Literal

NewIntLiteral builds a new IntVal.

func NewStrLiteral added in v0.8.0 

func NewStrLiteral(in []byte) *Literal

NewStrLiteral builds a new StrVal.

func (*Literal) Format added in v0.8.0 

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

Format formats the node.

func (*Literal) HexDecode added in v0.8.0 

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

HexDecode decodes the hexval into bytes.

type Load added in v0.9.0 

type Load struct {
}

Load represents a LOAD statement

func (*Load) Format added in v0.9.0 

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

Format formats the node.

type Lock added in v0.8.0 

type Lock int8

Lock is an enum for the type of lock in the statement 

const (
	NoLock Lock = iota
	ForUpdateLock
	ShareModeLock
)

Constants for Enum Type - Lock

func (Lock) ToString added in v0.8.0 

func (lock Lock) ToString() string

ToString returns the string associated with the type of lock

type LockOption added in v0.9.0 

type LockOption struct {
	Type LockOptionType
}

LockOption is used to specify the type of lock to use in an alter table statement

func (*LockOption) Format added in v0.9.0 

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

Format formats the node

type LockOptionType added in v0.9.0 

type LockOptionType int8

LockOptionType is an enum for LockOption.Type 

const (
	DefaultType LockOptionType = iota
	NoneType
	SharedType
	ExclusiveType
)

LockOptionType constants

func (LockOptionType) ToString added in v0.9.0 

func (lock LockOptionType) ToString() string

ToString returns the LockOptionType as a string

type LockTables added in v0.9.0 

type LockTables struct {
	Tables TableAndLockTypes
}

LockTables represents the lock statement

func (*LockTables) Format added in v0.9.0 

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

Format formats the LockTables node.

type LockType added in v0.9.0 

type LockType int8

LockType is an enum for Lock Types 

const (
	UnknownLockType LockType = iota
	Read
	ReadLocal
	Write
	LowPriorityWrite
)

LockType constants

func (LockType) ToString added in v0.9.0 

func (ty LockType) ToString() string

ToString returns the type as a string

type MarginComments 

type MarginComments struct {
	Leading  string
	Trailing string
}

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

func SplitMarginComments 

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

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

type MatchExpr 

type MatchExpr struct {
	Columns SelectExprs
	Expr    Expr
	Option  MatchExprOption
}

MatchExpr represents a call to the MATCH function

func (*MatchExpr) Format 

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

Format formats the node

type MatchExprOption added in v0.8.0 

type MatchExprOption int8

MatchExprOption is an enum for MatchExpr.Option 

const (
	NoOption MatchExprOption = iota
	BooleanModeOpt
	NaturalLanguageModeOpt
	NaturalLanguageModeWithQueryExpansionOpt
	QueryExpansionOpt
)

Constant for Enum Type - MatchExprOption

func (MatchExprOption) ToString added in v0.8.0 

func (option MatchExprOption) ToString() string

ToString returns the option as a string

type ModifyColumn added in v0.9.0 

type ModifyColumn struct {
	NewColDefinition *ColumnDefinition
	First            *ColName
	After            *ColName
}

ModifyColumn is used to change the column definition in alter table command

func (*ModifyColumn) Format added in v0.9.0 

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

Format formats the node

type Nextval 

type Nextval struct {
	Expr Expr
}

Nextval defines the NEXT VALUE expression.

func (Nextval) Format 

func (node Nextval) Format(buf *TrackedBuffer)

Format formats the node.

type NodeFormatter 

type NodeFormatter func(buf *TrackedBuffer, node SQLNode)

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

type NotExpr 

type NotExpr struct {
	Expr Expr
}

NotExpr represents a NOT expression.

func (*NotExpr) Format 

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

Format formats the node.

type NullVal 

type NullVal struct{}

NullVal represents a NULL value.

func (*NullVal) Format 

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

Format formats the node.

type OnDup 

type OnDup UpdateExprs

OnDup represents an ON DUPLICATE KEY clause.

func (OnDup) Format 

func (node OnDup) Format(buf *TrackedBuffer)

Format formats the node.

type OptLike 

type OptLike struct {
	LikeTable TableName
}

OptLike works for create table xxx like xxx

func (*OptLike) Format 

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

Format formats the node.

type OrExpr 

type OrExpr struct {
	Left, Right Expr
}

OrExpr represents an OR expression.

func (*OrExpr) Format 

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

Format formats the node.

type Order 

type Order struct {
	Expr      Expr
	Direction OrderDirection
}

Order represents an ordering expression.

func (*Order) Format 

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

Format formats the node.

type OrderBy 

type OrderBy []*Order

OrderBy represents an ORDER By clause.

func (OrderBy) Format 

func (node OrderBy) Format(buf *TrackedBuffer)

Format formats the node.

type OrderByOption added in v0.9.0 

type OrderByOption struct {
	Cols Columns
}

OrderByOption clause is used to specify the order by in an alter table statement

func (*OrderByOption) Format added in v0.9.0 

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

Format formats the node

type OrderDirection added in v0.8.0 

type OrderDirection int8

OrderDirection is an enum for the direction in which to order - asc or desc. 

const (
	AscOrder OrderDirection = iota
	DescOrder
)

Constant for Enum Type - OrderDirection

func (OrderDirection) ToString added in v0.8.0 

func (dir OrderDirection) ToString() string

ToString returns the direction as a string

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 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) MakeDistinct added in v0.9.0 

func (node *ParenSelect) MakeDistinct()

MakeDistinct implements the SelectStatement interface

func (*ParenSelect) SetLimit 

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

SetLimit sets the limit clause

func (*ParenSelect) SetLock 

func (node *ParenSelect) SetLock(lock Lock)

SetLock sets the lock 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 

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 

type PartitionDefinition struct {
	Name     ColIdent
	Limit    Expr
	Maxvalue bool
}

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            PartitionSpecAction
	Names             Partitions
	Number            *Literal
	IsAll             bool
	TableName         TableName
	WithoutValidation bool
	Definitions       []*PartitionDefinition
}

PartitionSpec describe partition actions (for alter statements)

func (*PartitionSpec) Format 

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

Format formats the node.

type PartitionSpecAction added in v0.8.0 

type PartitionSpecAction int8

PartitionSpecAction is an enum for PartitionSpec.Action 

const (
	ReorganizeAction PartitionSpecAction = iota
	AddAction
	DiscardAction
	DropAction
	ImportAction
	TruncateAction
	CoalesceAction
	ExchangeAction
	AnalyzeAction
	CheckAction
	OptimizeAction
	RebuildAction
	RepairAction
	RemoveAction
	UpgradeAction
)

Constant for Enum Type - PartitionSpecAction

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 

type PositionedErr struct {
	Err  string
	Pos  int
	Near []byte
}

PositionedErr holds context related to parser errors

func (PositionedErr) Error 

func (p PositionedErr) Error() string

type Precendence 

type Precendence int

Precendence is used to know the precedence between operators, so we can introduce parens when needed in the String representation of the AST 

const (
	Syntactic Precendence = iota
	P1
	P2
	P3
	P4
	P5
	P6
	P7
	P8
	P9
	P10
	P11
	P12
	P13
	P14
	P15
	P16
	P17
)

type RangeCond 

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

RangeCond represents a BETWEEN or a NOT BETWEEN expression.

func (*RangeCond) Format 

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

Format formats the node.

type RangeCondOperator added in v0.8.0 

type RangeCondOperator int8

RangeCondOperator is an enum for RangeCond.Operator 

const (
	BetweenOp RangeCondOperator = iota
	NotBetweenOp
)

Constant for Enum Type - RangeCondOperator

func (RangeCondOperator) ToString added in v0.8.0 

func (op RangeCondOperator) ToString() string

ToString returns the operator as a string

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 Release 

type Release struct {
	Name ColIdent
}

Release represents a release savepoint statement.

func (*Release) Format 

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

Format formats the node.

type RenameIndex added in v0.9.0 

type RenameIndex struct {
	OldName string
	NewName string
}

RenameIndex clause is used to rename indexes in an alter table statement

func (*RenameIndex) Format added in v0.9.0 

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

Format formats the node

type RenameTable added in v0.9.0 

type RenameTable struct {
	Table TableName
}

RenameTable clause is used to rename the table in an alter table statement

func (*RenameTable) Format added in v0.9.0 

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

Format formats the node

type RewriteASTResult 

type RewriteASTResult struct {
	*BindVarNeeds
	AST Statement // The rewritten AST
}

RewriteASTResult contains the rewritten ast and meta information about it

func PrepareAST 

func PrepareAST(in Statement, bindVars map[string]*querypb.BindVariable, prefix string, parameterize bool, keyspace string) (*RewriteASTResult, error)

PrepareAST will normalize the query

func RewriteAST 

func RewriteAST(in Statement, keyspace string) (*RewriteASTResult, error)

RewriteAST rewrites the whole AST, replacing function calls and adding column aliases to queries

type Rollback 

type Rollback struct{}

Rollback represents a Rollback statement.

func (*Rollback) Format 

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

Format formats the node.

type SQLNode 

type SQLNode interface {
	Format(buf *TrackedBuffer)
}

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

func Rewrite 

func Rewrite(node SQLNode, pre, post ApplyFunc) (result SQLNode)

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 SRollback 

type SRollback struct {
	Name ColIdent
}

SRollback represents a rollback to savepoint statement.

func (*SRollback) Format 

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

Format formats the node.

type Savepoint 

type Savepoint struct {
	Name ColIdent
}

Savepoint represents a savepoint statement.

func (*Savepoint) Format 

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

Format formats the node.

type Scope added in v0.8.0 

type Scope int8

Scope is an enum for scope of query 

const (
	ImplicitScope Scope = iota
	SessionScope
	GlobalScope
	VitessMetadataScope
	VariableScope
	LocalScope
)

Constants for Enum Type - Scope

func (Scope) ToString added in v0.8.0 

func (scope Scope) ToString() string

ToString returns the string associated with the Scope enum

type Select 

type Select struct {
	Cache            *bool // a reference here so it can be nil
	Distinct         bool
	StraightJoinHint bool
	SQLCalcFoundRows bool
	Comments         Comments
	SelectExprs      SelectExprs
	From             TableExprs
	Where            *Where
	GroupBy          GroupBy
	Having           *Where
	OrderBy          OrderBy
	Limit            *Limit
	Lock             Lock
	Into             *SelectInto
}

Select represents a SELECT statement.

func NewSelect 

func NewSelect(comments Comments, exprs SelectExprs, selectOptions []string, from TableExprs, where *Where, groupBy GroupBy, having *Where) *Select

NewSelect is used to create a select statement

func (*Select) AddHaving 

func (node *Select) AddHaving(expr Expr)

AddHaving adds the boolean expression to the HAVING clause as an AND condition.

func (*Select) AddOrder 

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

AddOrder adds an order by element

func (*Select) AddWhere 

func (node *Select) AddWhere(expr Expr)

AddWhere adds the boolean expression to the WHERE clause as an AND condition.

func (*Select) Format 

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

Format formats the node.

func (*Select) MakeDistinct added in v0.9.0 

func (node *Select) MakeDistinct()

MakeDistinct makes the statement distinct

func (*Select) SetLimit 

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

SetLimit sets the limit clause

func (*Select) SetLock 

func (node *Select) SetLock(lock Lock)

SetLock sets the lock clause

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 SelectInto added in v0.9.0 

type SelectInto struct {
	Type         SelectIntoType
	FileName     string
	Charset      string
	FormatOption string
	ExportOption string
	Manifest     string
	Overwrite    string
}

SelectInto is a struct that represent the INTO part of a select query

func (*SelectInto) Format added in v0.9.0 

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

Format formats the node.

type SelectIntoType added in v0.9.0 

type SelectIntoType int8

SelectIntoType is an enum for SelectInto.Type 

const (
	IntoOutfile SelectIntoType = iota
	IntoOutfileS3
	IntoDumpfile
)

Constant for Enum Type - SelectIntoType

func (SelectIntoType) ToString added in v0.9.0 

func (sel SelectIntoType) ToString() string

ToString returns the type as a string

type SelectStatement 

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

SelectStatement any SELECT statement.

type Set 

type Set struct {
	Comments Comments
	Exprs    SetExprs
}

Set represents a SET statement.

func (*Set) Format 

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

Format formats the node.

type SetExpr 

type SetExpr struct {
	Scope Scope
	Name  ColIdent
	Expr  Expr
}

SetExpr represents a set expression.

func (*SetExpr) Format 

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

Format formats the node.

type SetExprs 

type SetExprs []*SetExpr

SetExprs represents a list of set expressions.

func (SetExprs) Format 

func (node SetExprs) Format(buf *TrackedBuffer)

Format formats the node.

type SetTransaction 

type SetTransaction struct {
	SQLNode
	Comments        Comments
	Scope           Scope
	Characteristics []Characteristic
}

SetTransaction represents a SET TRANSACTION statement.

func (*SetTransaction) Format 

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

Format formats the node.

type Show 

type Show struct {
	Internal ShowInternal
}

Show represents a show statement.

func (*Show) Format 

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

Format formats the node.

type ShowBasic added in v0.9.0 

type ShowBasic struct {
	Command ShowCommandType
	Filter  *ShowFilter
}

ShowBasic is of ShowInternal type, holds Simple SHOW queries with a filter.

func (*ShowBasic) Format added in v0.9.0 

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

Format formats the node.

type ShowColumns added in v0.9.0 

type ShowColumns struct {
	Full   string
	Table  TableName
	DbName string
	Filter *ShowFilter
}

ShowColumns is of ShowInternal type, holds the show columns statement.

func (*ShowColumns) Format added in v0.9.0 

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

Format formats the node.

type ShowCommandType added in v0.9.0 

type ShowCommandType int8

ShowCommandType represents the show statement type. 

const (
	UnknownCommandType ShowCommandType = iota
	Charset
	Collation
	Database
	Function
	Privilege
	Procedure
	StatusGlobal
	StatusSession
	VariableGlobal
	VariableSession
)

ShowCommandType constants

func (ShowCommandType) ToString added in v0.9.0 

func (ty ShowCommandType) ToString() string

ToString returns ShowCommandType as a string

type ShowFilter 

type ShowFilter struct {
	Like   string
	Filter Expr
}

ShowFilter is show tables filter

func (*ShowFilter) Format 

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

Format formats the node.

type ShowInternal added in v0.9.0 

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

ShowInternal will represent all the show statement types.

type ShowLegacy added in v0.9.0 

type ShowLegacy struct {
	Extended               string
	Type                   string
	OnTable                TableName
	Table                  TableName
	ShowTablesOpt          *ShowTablesOpt
	Scope                  Scope
	ShowCollationFilterOpt Expr
}

ShowLegacy is of ShowInternal type, holds the legacy show ast struct.

func (*ShowLegacy) Format added in v0.9.0 

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

Format formats the node.

func (*ShowLegacy) HasOnTable added in v0.9.0 

func (node *ShowLegacy) HasOnTable() bool

HasOnTable returns true if the show statement has an "on" clause

func (*ShowLegacy) HasTable added in v0.9.0 

func (node *ShowLegacy) HasTable() bool

HasTable returns true if the show statement has a parsed table name. Not all show statements parse table names.

type ShowTableStatus added in v0.8.0 

type ShowTableStatus struct {
	DatabaseName string
	Filter       *ShowFilter
}

ShowTableStatus is of ShowInternal type, holds SHOW TABLE STATUS queries.

func (*ShowTableStatus) Format added in v0.8.0 

func (node *ShowTableStatus) 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.

func (*StarExpr) Format 

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

Format formats the node.

type Statement 

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

Statement represents a statement.

func Parse 

func Parse(sql string) (Statement, error)

Parse parses the SQL 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 

func ParseNext(tokenizer *Tokenizer) (Statement, error)

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 

func ParseNextStrictDDL(tokenizer *Tokenizer) (Statement, error)

ParseNextStrictDDL is the same as ParseNext except it errors on partially parsed DDL statements.

func ParseStrictDDL 

func ParseStrictDDL(sql string) (Statement, error)

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

type StatementType 

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
	StmtExplain
	StmtSavepoint
	StmtSRollback
	StmtRelease
	StmtVStream
	StmtLockTables
	StmtUnlockTables
)

These constants are used to identify the SQL statement type. Changing this list will require reviewing all calls to Preview.

func ASTToStatementType 

func ASTToStatementType(stmt Statement) StatementType

ASTToStatementType returns a StatementType from an AST stmt

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 

func (s StatementType) String() string

type Stream 

type Stream struct {
	Comments   Comments
	SelectExpr SelectExpr
	Table      TableName
}

Stream represents a SELECT statement.

func (*Stream) Format 

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

Format formats the node.

type Subquery 

type Subquery struct {
	Select SelectStatement
}

Subquery represents a subquery used as an value expression.

func (*Subquery) Format 

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

Format formats the node.

type SubstrExpr 

type SubstrExpr struct {
	Name   *ColName
	StrVal *Literal
	From   Expr
	To     Expr
}

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 TableAndLockType added in v0.9.0 

type TableAndLockType struct {
	Table TableExpr
	Lock  LockType
}

TableAndLockType contains table and lock association

type TableAndLockTypes added in v0.9.0 

type TableAndLockTypes []*TableAndLockType

TableAndLockTypes is a slice of TableAndLockType

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 

func TableFromStatement(sql string) (TableName, error)

TableFromStatement returns the qualified table name for the query. This works only for select statements.

func (TableName) Format 

func (node TableName) Format(buf *TrackedBuffer)

Format formats the node.

func (TableName) IsEmpty 

func (node TableName) IsEmpty() bool

IsEmpty returns true if TableName is nil or empty.

func (TableName) ToViewName 

func (node TableName) ToViewName() TableName

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 TableOption added in v0.9.0 

type TableOption struct {
	Name   string
	Value  *Literal
	String string
	Tables TableNames
}

TableOption is used for create table options like AUTO_INCREMENT, INSERT_METHOD, etc

type TableOptions added in v0.9.0 

type TableOptions []*TableOption

TableOptions specifies a list of table options

func (TableOptions) Format added in v0.9.0 

func (node TableOptions) Format(buf *TrackedBuffer)

Format formats the node

type TableSpec 

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

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

func (*TableSpec) AddColumn 

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

AddColumn appends the given column to the list in the spec

func (*TableSpec) 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

func (*TableSpec) Format 

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

Format formats the node.

type TablespaceOperation added in v0.9.0 

type TablespaceOperation struct {
	Import bool
}

TablespaceOperation is used to discard or import the tablespace in an alter table statement

func (*TablespaceOperation) Format added in v0.9.0 

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

Format formats the node

type TimestampFuncExpr 

type TimestampFuncExpr struct {
	Name  string
	Expr1 Expr
	Expr2 Expr
	Unit  string
}

TimestampFuncExpr represents the function and arguments for TIMESTAMP{ADD,DIFF} functions.

func (*TimestampFuncExpr) Format 

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 

func NewStringTokenizer(sql string) *Tokenizer

NewStringTokenizer creates a new Tokenizer for the sql string.

func NewTokenizer 

func NewTokenizer(r io.Reader) *Tokenizer

NewTokenizer creates a new Tokenizer reading a sql string from the io.Reader.

func (*Tokenizer) Error 

func (tkn *Tokenizer) Error(err string)

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

func (*Tokenizer) Lex 

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

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

func (*Tokenizer) Scan 

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

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

type TrackedBuffer 

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

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

func NewTrackedBuffer 

func NewTrackedBuffer(nodeFormatter NodeFormatter) *TrackedBuffer

NewTrackedBuffer creates a new TrackedBuffer.

func (*TrackedBuffer) HasBindVars 

func (buf *TrackedBuffer) HasBindVars() bool

HasBindVars returns true if the parsed query uses bind vars.

func (*TrackedBuffer) Myprintf 

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

Myprintf mimics fmt.Fprintf(buf, ...), but limited to Node(%v), Node.Value(%s) and string(%s). It also allows a %a for a value argument, in which case it adds tracking info for future substitutions. It adds parens as needed to follow precedence rules when printing expressions. To handle parens correctly for left associative binary operators, use %l and %r to tell the TrackedBuffer which value is on the LHS and RHS

The name must be something other than the usual Printf() to avoid "go vet" warnings due to our custom format specifiers. *** THIS METHOD SHOULD NOT BE USED FROM ast.go. USE astPrintf INSTEAD ***

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 

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

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

func (*TupleEqualityList) EncodeSQL 

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

EncodeSQL generates the where clause constraints for the tuple equality.

type UnaryExpr 

type UnaryExpr struct {
	Operator UnaryExprOperator
	Expr     Expr
}

UnaryExpr represents a unary value expression.

func (*UnaryExpr) Format 

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

Format formats the node.

type UnaryExprOperator added in v0.8.0 

type UnaryExprOperator int8

UnaryExprOperator is an enum for UnaryExpr.Operator 

const (
	UPlusOp UnaryExprOperator = iota
	UMinusOp
	TildaOp
	BangOp
	BinaryOp
	UBinaryOp
	Utf8mb4Op
	Utf8Op
	Latin1Op
)

Constant for Enum Type - UnaryExprOperator

func (UnaryExprOperator) ToString added in v0.8.0 

func (op UnaryExprOperator) ToString() string

ToString returns the operator as a string

type Union 

type Union struct {
	FirstStatement SelectStatement
	UnionSelects   []*UnionSelect
	OrderBy        OrderBy
	Limit          *Limit
	Lock           Lock
}

Union represents a UNION statement.

func Unionize 

func Unionize(lhs, rhs SelectStatement, distinct bool, by OrderBy, limit *Limit, lock Lock) *Union

Unionize returns a UNION, either creating one or adding SELECT to an existing one

func (*Union) AddOrder 

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

AddOrder adds an order by element

func (*Union) Format 

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

Format formats the node.

func (*Union) MakeDistinct added in v0.9.0 

func (node *Union) MakeDistinct()

MakeDistinct implements the SelectStatement interface

func (*Union) SetLimit 

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

SetLimit sets the limit clause

func (*Union) SetLock 

func (node *Union) SetLock(lock Lock)

SetLock sets the lock clause

type UnionSelect 

type UnionSelect struct {
	Distinct  bool
	Statement SelectStatement
}

UnionSelect represents union type and select statement after first select statement.

func (*UnionSelect) Format 

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

Format formats the node.

type UnlockTables added in v0.9.0 

type UnlockTables struct{}

UnlockTables represents the unlock statement

func (*UnlockTables) Format added in v0.9.0 

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

Format formats the UnlockTables node.

type Update 

type Update struct {
	Comments   Comments
	Ignore     Ignore
	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.

func (*Update) Format 

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

Format formats the node.

type UpdateExpr 

type UpdateExpr struct {
	Name *ColName
	Expr Expr
}

UpdateExpr represents an update expression.

func (*UpdateExpr) Format 

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

Format formats the node.

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 Use 

type Use struct {
	DBName TableIdent
}

Use represents a use statement.

func (*Use) Format 

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

Format formats the node.

type VStream added in v0.8.0 

type VStream struct {
	Comments   Comments
	SelectExpr SelectExpr
	Table      TableName
	Where      *Where
	Limit      *Limit
}

VStream represents a VSTREAM statement.

func (*VStream) Format added in v0.8.0 

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

Format formats the node.

type ValTuple 

type ValTuple Exprs

ValTuple represents a tuple of actual values.

func (ValTuple) Format 

func (node ValTuple) Format(buf *TrackedBuffer)

Format formats the node.

type ValType 

type ValType int

ValType specifies the type for Literal.

type Validation added in v0.9.0 

type Validation struct {
	With bool
}

Validation clause is used to specify whether to use validation or not

func (*Validation) Format added in v0.9.0 

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

Format formats the node

type Values 

type Values []ValTuple

Values represents a VALUES clause.

func (Values) Format 

func (node Values) 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 

type VindexParam struct {
	Key ColIdent
	Val string
}

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 

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

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

type When 

type When struct {
	Cond Expr
	Val  Expr
}

When represents a WHEN sub-expression.

func (*When) Format 

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

Format formats the node.

type Where 

type Where struct {
	Type WhereType
	Expr Expr
}

Where represents a WHERE or HAVING clause.

func NewWhere 

func NewWhere(typ WhereType, expr Expr) *Where

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

func (*Where) Format 

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

Format formats the node.

type WhereType added in v0.8.0 

type WhereType int8

WhereType is an enum for Where.Type 

const (
	WhereClause WhereType = iota
	HavingClause
)

Constants for Enum Type - WhereType

func (WhereType) ToString added in v0.8.0 

func (whereType WhereType) ToString() string

ToString returns the string associated with WhereType

type XorExpr 

type XorExpr struct {
	Left, Right Expr
}

XorExpr represents an XOR expression.

func (*XorExpr) Format 

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

Format formats the node.

Source Files

View all 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.
main

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.