tidb/ast/misc.go

// Copyright 2015 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.

package ast

var (
	_ StmtNode = &ExplainStmt{}
	_ StmtNode = &PrepareStmt{}
	_ StmtNode = &DeallocateStmt{}
	_ StmtNode = &ExecuteStmt{}
	_ StmtNode = &ShowStmt{}
	_ StmtNode = &BeginStmt{}
	_ StmtNode = &CommitStmt{}
	_ StmtNode = &RollbackStmt{}
	_ StmtNode = &UseStmt{}
	_ StmtNode = &SetStmt{}
	_ StmtNode = &SetCharsetStmt{}
	_ StmtNode = &SetPwdStmt{}
	_ StmtNode = &DoStmt{}

	_ Node = &VariableAssignment{}
)

// FloatOpt is used for parsing floating-point type option from SQL.
// TODO: add reference doc.
type FloatOpt struct {
	Flen    int
	Decimal int
}

// AuthOption is used for parsing create use statement.
type AuthOption struct {
	// AuthString/HashString can be empty, so we need to decide which one to use.
	ByAuthString bool
	AuthString   string
	HashString   string
	// TODO: support auth_plugin
}

// ExplainStmt is a statement to provide information about how is SQL statement executed
// or get columns information in a table.
// See: https://dev.mysql.com/doc/refman/5.7/en/explain.html
type ExplainStmt struct {
	stmtNode

	Stmt StmtNode
}

// Accept implements Node Accept interface.
func (es *ExplainStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(es); skipChildren {
		return es, ok
	}
	node, ok := es.Stmt.Accept(v)
	if !ok {
		return es, false
	}
	es.Stmt = node.(DMLNode)
	return v.Leave(es)
}

// PrepareStmt is a statement to prepares a SQL statement which contains placeholders,
// and it is executed with ExecuteStmt and released with DeallocateStmt.
// See: https://dev.mysql.com/doc/refman/5.7/en/prepare.html
type PrepareStmt struct {
	stmtNode

	InPrepare bool // true for prepare mode, false for use mode
	Name      string
	ID        uint32 // For binary protocol, there is no Name but only ID
	SQLText   string
	SQLVar    *VariableExpr
}

// Accept implements Node Accept interface.
func (ps *PrepareStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(ps); skipChildren {
		return ps, ok
	}
	node, ok := ps.SQLVar.Accept(v)
	if !ok {
		return ps, false
	}
	ps.SQLVar = node.(*VariableExpr)
	return v.Leave(ps)
}

// DeallocateStmt is a statement to release PreparedStmt.
// See: https://dev.mysql.com/doc/refman/5.7/en/deallocate-prepare.html
type DeallocateStmt struct {
	stmtNode

	Name string
	ID   uint32 // For binary protocol, there is no Name but only ID.
}

// Accept implements Node Accept interface.
func (ds *DeallocateStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(ds); skipChildren {
		return ds, ok
	}
	return v.Leave(ds)
}

// ExecuteStmt is a statement to execute PreparedStmt.
// See: https://dev.mysql.com/doc/refman/5.7/en/execute.html
type ExecuteStmt struct {
	stmtNode

	Name      string
	ID        uint32 // For binary protocol, there is no Name but only ID
	UsingVars []ExprNode
}

// Accept implements Node Accept interface.
func (es *ExecuteStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(es); skipChildren {
		return es, ok
	}
	for i, val := range es.UsingVars {
		node, ok := val.Accept(v)
		if !ok {
			return es, false
		}
		es.UsingVars[i] = node.(ExprNode)
	}
	return v.Leave(es)
}

// ShowStmtType is the type for SHOW statement.
type ShowStmtType int

// Show statement types.
const (
	ShowNone = iota
	ShowEngines
	ShowDatabases
	ShowTables
	ShowColumns
	ShowWarnings
	ShowCharset
	ShowVariables
	ShowCollation
	ShowCreateTable
)

// ShowStmt is a statement to provide information about databases, tables, columns and so on.
// See: https://dev.mysql.com/doc/refman/5.7/en/show.html
type ShowStmt struct {
	stmtNode

	Tp     ShowStmtType // Databases/Tables/Columns/....
	DBName string
	Table  *TableName  // Used for showing columns.
	Column *ColumnName // Used for `desc table column`.
	Flag   int         // Some flag parsed from sql, such as FULL.
	Full   bool

	// Used by show variables
	GlobalScope bool
	Pattern     *PatternLikeExpr
	Where       ExprNode
}

// Accept implements Node Accept interface.
func (ss *ShowStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(ss); skipChildren {
		return ss, ok
	}
	if ss.Table != nil {
		node, ok := ss.Table.Accept(v)
		if !ok {
			return ss, false
		}
		ss.Table = node.(*TableName)
	}
	if ss.Column != nil {
		node, ok := ss.Column.Accept(v)
		if !ok {
			return ss, false
		}
		ss.Column = node.(*ColumnName)
	}
	if ss.Pattern != nil {
		node, ok := ss.Pattern.Accept(v)
		if !ok {
			return ss, false
		}
		ss.Pattern = node.(*PatternLikeExpr)
	}
	if ss.Where != nil {
		node, ok := ss.Where.Accept(v)
		if !ok {
			return ss, false
		}
		ss.Where = node.(ExprNode)
	}
	return v.Leave(ss)
}

// BeginStmt is a statement to start a new transaction.
// See: https://dev.mysql.com/doc/refman/5.7/en/commit.html
type BeginStmt struct {
	stmtNode
}

// Accept implements Node Accept interface.
func (bs *BeginStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(bs); skipChildren {
		return bs, ok
	}
	return v.Leave(bs)
}

// CommitStmt is a statement to commit the current transaction.
// See: https://dev.mysql.com/doc/refman/5.7/en/commit.html
type CommitStmt struct {
	stmtNode
}

// Accept implements Node Accept interface.
func (cs *CommitStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(cs); skipChildren {
		return cs, ok
	}
	return v.Leave(cs)
}

// RollbackStmt is a statement to roll back the current transaction.
// See: https://dev.mysql.com/doc/refman/5.7/en/commit.html
type RollbackStmt struct {
	stmtNode
}

// Accept implements Node Accept interface.
func (rs *RollbackStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(rs); skipChildren {
		return rs, ok
	}
	return v.Leave(rs)
}

// UseStmt is a statement to use the DBName database as the current database.
// See: https://dev.mysql.com/doc/refman/5.7/en/use.html
type UseStmt struct {
	stmtNode

	DBName string
}

// Accept implements Node Accept interface.
func (us *UseStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(us); skipChildren {
		return us, ok
	}
	return v.Leave(us)
}

// VariableAssignment is a variable assignment struct.
type VariableAssignment struct {
	node
	Name     string
	Value    ExprNode
	IsGlobal bool
	IsSystem bool
}

// Accept implements Node interface.
func (va *VariableAssignment) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(va); skipChildren {
		return va, ok
	}
	node, ok := va.Value.Accept(v)
	if !ok {
		return va, false
	}
	va.Value = node.(ExprNode)
	return v.Leave(va)
}

// SetStmt is the statement to set variables.
type SetStmt struct {
	stmtNode
	// Variables is the list of variable assignment.
	Variables []*VariableAssignment
}

// Accept implements Node Accept interface.
func (set *SetStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(set); skipChildren {
		return set, ok
	}
	for i, val := range set.Variables {
		node, ok := val.Accept(v)
		if !ok {
			return set, false
		}
		set.Variables[i] = node.(*VariableAssignment)
	}
	return v.Leave(set)
}

// SetCharsetStmt is a statement to assign values to character and collation variables.
// See: https://dev.mysql.com/doc/refman/5.7/en/set-statement.html
type SetCharsetStmt struct {
	stmtNode

	Charset string
	Collate string
}

// Accept implements Node Accept interface.
func (set *SetCharsetStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(set); skipChildren {
		return set, ok
	}
	return v.Leave(set)
}

// SetPwdStmt is a statement to assign a password to user account.
// See: https://dev.mysql.com/doc/refman/5.7/en/set-password.html
type SetPwdStmt struct {
	stmtNode

	User     string
	Password string
}

// Accept implements Node Accept interface.
func (set *SetPwdStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(set); skipChildren {
		return set, ok
	}
	return v.Leave(set)
}

// UserSpec is used for parsing create user statement.
type UserSpec struct {
	User    string
	AuthOpt *AuthOption
}

// CreateUserStmt creates user account.
// See: https://dev.mysql.com/doc/refman/5.7/en/create-user.html
type CreateUserStmt struct {
	IfNotExists bool
	Specs       []*UserSpec

	Text string
}

// DoStmt is the struct for DO statement.
type DoStmt struct {
	stmtNode

	Exprs []ExprNode
}

// Accept implements Node Accept interface.
func (do *DoStmt) Accept(v Visitor) (Node, bool) {
	if skipChildren, ok := v.Enter(do); skipChildren {
		return do, ok
	}
	for i, val := range do.Exprs {
		node, ok := val.Accept(v)
		if !ok {
			return do, false
		}
		do.Exprs[i] = node.(ExprNode)
	}
	return v.Leave(do)
}