Files
tidb/executor/executor.go

877 lines
22 KiB
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 executor
import (
"sync"
"sync/atomic"
"github.com/juju/errors"
"github.com/pingcap/tidb/ast"
"github.com/pingcap/tidb/context"
"github.com/pingcap/tidb/expression"
"github.com/pingcap/tidb/infoschema"
"github.com/pingcap/tidb/inspectkv"
"github.com/pingcap/tidb/kv"
"github.com/pingcap/tidb/model"
"github.com/pingcap/tidb/mysql"
"github.com/pingcap/tidb/plan"
"github.com/pingcap/tidb/table"
"github.com/pingcap/tidb/tablecodec"
"github.com/pingcap/tidb/terror"
"github.com/pingcap/tidb/util/ranger"
"github.com/pingcap/tidb/util/types"
)
var (
_ Executor = &CheckTableExec{}
_ Executor = &DummyScanExec{}
_ Executor = &ExistsExec{}
_ Executor = &HashAggExec{}
_ Executor = &LimitExec{}
_ Executor = &MaxOneRowExec{}
_ Executor = &ProjectionExec{}
_ Executor = &SelectionExec{}
_ Executor = &SelectLockExec{}
_ Executor = &ShowDDLExec{}
_ Executor = &SortExec{}
_ Executor = &StreamAggExec{}
_ Executor = &TableDualExec{}
_ Executor = &TableScanExec{}
_ Executor = &TopnExec{}
_ Executor = &UnionExec{}
)
// Error instances.
var (
ErrUnknownPlan = terror.ClassExecutor.New(codeUnknownPlan, "Unknown plan")
ErrPrepareMulti = terror.ClassExecutor.New(codePrepareMulti, "Can not prepare multiple statements")
ErrStmtNotFound = terror.ClassExecutor.New(codeStmtNotFound, "Prepared statement not found")
ErrSchemaChanged = terror.ClassExecutor.New(codeSchemaChanged, "Schema has changed")
ErrWrongParamCount = terror.ClassExecutor.New(codeWrongParamCount, "Wrong parameter count")
ErrRowKeyCount = terror.ClassExecutor.New(codeRowKeyCount, "Wrong row key entry count")
ErrPrepareDDL = terror.ClassExecutor.New(codePrepareDDL, "Can not prepare DDL statements")
ErrPasswordNoMatch = terror.ClassExecutor.New(CodePasswordNoMatch, "Can't find any matching row in the user table")
ErrResultIsEmpty = terror.ClassExecutor.New(codeResultIsEmpty, "result is empty")
ErrBuildExecutor = terror.ClassExecutor.New(codeErrBuildExec, "Failed to build executor")
ErrBatchInsertFail = terror.ClassExecutor.New(codeBatchInsertFail, "Batch insert failed, please clean the table and try again.")
ErrWrongValueCountOnRow = terror.ClassExecutor.New(codeWrongValueCountOnRow, "Column count doesn't match value count at row %d")
)
// Error codes.
const (
codeUnknownPlan terror.ErrCode = 1
codePrepareMulti terror.ErrCode = 2
codeStmtNotFound terror.ErrCode = 3
codeSchemaChanged terror.ErrCode = 4
codeWrongParamCount terror.ErrCode = 5
codeRowKeyCount terror.ErrCode = 6
codePrepareDDL terror.ErrCode = 7
codeResultIsEmpty terror.ErrCode = 8
codeErrBuildExec terror.ErrCode = 9
codeBatchInsertFail terror.ErrCode = 10
CodePasswordNoMatch terror.ErrCode = 1133 // MySQL error code
CodeCannotUser terror.ErrCode = 1396 // MySQL error code
codeWrongValueCountOnRow terror.ErrCode = 1136 // MySQL error code
)
// Row represents a result set row, it may be returned from a table, a join, or a projection.
type Row struct {
// Data is the output record data for current Plan.
Data []types.Datum
// RowKeys contains all table row keys in the row.
RowKeys []*RowKeyEntry
}
// RowKeyEntry represents a row key read from a table.
type RowKeyEntry struct {
// Tbl is the table which this row come from.
Tbl table.Table
// Handle is Row key.
Handle int64
// TableName is table alias name.
TableName string
}
type baseExecutor struct {
children []Executor
ctx context.Context
schema *expression.Schema
}
// Open implements the Executor Open interface.
func (e *baseExecutor) Open() error {
for _, child := range e.children {
err := child.Open()
if err != nil {
return errors.Trace(err)
}
}
return nil
}
// Close implements the Executor Close interface.
func (e *baseExecutor) Close() error {
for _, child := range e.children {
err := child.Close()
if err != nil {
return errors.Trace(err)
}
}
return nil
}
// Schema implements the Executor Schema interface.
func (e *baseExecutor) Schema() *expression.Schema {
if e.schema == nil {
return expression.NewSchema()
}
return e.schema
}
func newBaseExecutor(schema *expression.Schema, ctx context.Context, children ...Executor) baseExecutor {
return baseExecutor{
children: children,
ctx: ctx,
schema: schema,
}
}
// Executor executes a query.
type Executor interface {
Next() (*Row, error)
Close() error
Open() error
Schema() *expression.Schema
}
// ShowDDLExec represents a show DDL executor.
type ShowDDLExec struct {
baseExecutor
schema *expression.Schema
ddlInfo *inspectkv.DDLInfo
bgInfo *inspectkv.DDLInfo
done bool
}
// Next implements the Executor Next interface.
func (e *ShowDDLExec) Next() (*Row, error) {
if e.done {
return nil, nil
}
var ddlOwner, ddlJob string
if e.ddlInfo.Owner != nil {
ddlOwner = e.ddlInfo.Owner.String()
}
if e.ddlInfo.Job != nil {
ddlJob = e.ddlInfo.Job.String()
}
var bgOwner, bgJob string
if e.bgInfo.Owner != nil {
bgOwner = e.bgInfo.Owner.String()
}
if e.bgInfo.Job != nil {
bgJob = e.bgInfo.Job.String()
}
row := &Row{}
row.Data = types.MakeDatums(
e.ddlInfo.SchemaVer,
ddlOwner,
ddlJob,
e.bgInfo.SchemaVer,
bgOwner,
bgJob,
)
e.done = true
return row, nil
}
// CheckTableExec represents a check table executor.
// It is built from the "admin check table" statement, and it checks if the
// index matches the records in the table.
type CheckTableExec struct {
baseExecutor
tables []*ast.TableName
ctx context.Context
done bool
is infoschema.InfoSchema
}
// Next implements the Executor Next interface.
func (e *CheckTableExec) Next() (*Row, error) {
if e.done {
return nil, nil
}
dbName := model.NewCIStr(e.ctx.GetSessionVars().CurrentDB)
for _, t := range e.tables {
tb, err := e.is.TableByName(dbName, t.Name)
if err != nil {
return nil, errors.Trace(err)
}
for _, idx := range tb.Indices() {
txn := e.ctx.Txn()
err = inspectkv.CompareIndexData(txn, tb, idx)
if err != nil {
return nil, errors.Errorf("%v err:%v", t.Name, err)
}
}
}
e.done = true
return nil, nil
}
// Close implements plan.Plan Close interface.
func (e *CheckTableExec) Close() error {
return nil
}
// SelectLockExec represents a select lock executor.
// It is built from the "SELECT .. FOR UPDATE" or the "SELECT .. LOCK IN SHARE MODE" statement.
// For "SELECT .. FOR UPDATE" statement, it locks every row key from source Executor.
// After the execution, the keys are buffered in transaction, and will be sent to KV
// when doing commit. If there is any key already locked by another transaction,
// the transaction will rollback and retry.
type SelectLockExec struct {
baseExecutor
Lock ast.SelectLockType
}
// Next implements the Executor Next interface.
func (e *SelectLockExec) Next() (*Row, error) {
row, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if row == nil {
return nil, nil
}
if len(row.RowKeys) != 0 && e.Lock == ast.SelectLockForUpdate {
e.ctx.GetSessionVars().TxnCtx.ForUpdate = true
txn := e.ctx.Txn()
for _, k := range row.RowKeys {
lockKey := tablecodec.EncodeRowKeyWithHandle(k.Tbl.Meta().ID, k.Handle)
err = txn.LockKeys(lockKey)
if err != nil {
return nil, errors.Trace(err)
}
}
}
return row, nil
}
// LimitExec represents limit executor
// It ignores 'Offset' rows from src, then returns 'Count' rows at maximum.
type LimitExec struct {
baseExecutor
Offset uint64
Count uint64
Idx uint64
}
// Next implements the Executor Next interface.
func (e *LimitExec) Next() (*Row, error) {
for e.Idx < e.Offset {
srcRow, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if srcRow == nil {
return nil, nil
}
e.Idx++
}
if e.Idx >= e.Count+e.Offset {
return nil, nil
}
srcRow, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if srcRow == nil {
return nil, nil
}
e.Idx++
return srcRow, nil
}
// Open implements the Executor Open interface.
func (e *LimitExec) Open() error {
e.Idx = 0
return errors.Trace(e.children[0].Open())
}
func init() {
// While doing optimization in the plan package, we need to execute uncorrelated subquery,
// but the plan package cannot import the executor package because of the dependency cycle.
// So we assign a function implemented in the executor package to the plan package to avoid the dependency cycle.
plan.EvalSubquery = func(p plan.PhysicalPlan, is infoschema.InfoSchema, ctx context.Context) (rows [][]types.Datum, err error) {
err = ctx.ActivePendingTxn()
if err != nil {
return rows, errors.Trace(err)
}
e := &executorBuilder{is: is, ctx: ctx}
exec := e.build(p)
if e.err != nil {
return rows, errors.Trace(err)
}
err = exec.Open()
if err != nil {
return rows, errors.Trace(err)
}
for {
row, err := exec.Next()
if err != nil {
return rows, errors.Trace(err)
}
if row == nil {
return rows, errors.Trace(exec.Close())
}
rows = append(rows, row.Data)
}
}
tableMySQLErrCodes := map[terror.ErrCode]uint16{
CodeCannotUser: mysql.ErrCannotUser,
CodePasswordNoMatch: mysql.ErrPasswordNoMatch,
codeWrongValueCountOnRow: mysql.ErrWrongValueCountOnRow,
}
terror.ErrClassToMySQLCodes[terror.ClassExecutor] = tableMySQLErrCodes
}
// ProjectionExec represents a select fields executor.
type ProjectionExec struct {
baseExecutor
exprs []expression.Expression
}
// Next implements the Executor Next interface.
func (e *ProjectionExec) Next() (retRow *Row, err error) {
srcRow, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if srcRow == nil {
return nil, nil
}
row := &Row{
RowKeys: srcRow.RowKeys,
Data: make([]types.Datum, 0, len(e.exprs)),
}
for _, expr := range e.exprs {
val, err := expr.Eval(srcRow.Data)
if err != nil {
return nil, errors.Trace(err)
}
row.Data = append(row.Data, val)
}
return row, nil
}
// TableDualExec represents a dual table executor.
type TableDualExec struct {
baseExecutor
rowCount int
returnCnt int
}
// Open implements the Executor Open interface.
func (e *TableDualExec) Open() error {
e.returnCnt = 0
return nil
}
// Next implements the Executor Next interface.
func (e *TableDualExec) Next() (*Row, error) {
if e.returnCnt >= e.rowCount {
return nil, nil
}
e.returnCnt++
return &Row{}, nil
}
// SelectionExec represents a filter executor.
type SelectionExec struct {
baseExecutor
// scanController will tell whether this selection need to
// control the condition of below scan executor.
scanController bool
controllerInit bool
Conditions []expression.Expression
}
// initController will init the conditions of the below scan executor.
// It will first substitute the correlated column to constant, then build range and filter by new conditions.
func (e *SelectionExec) initController() error {
sc := e.ctx.GetSessionVars().StmtCtx
client := e.ctx.GetClient()
newConds := make([]expression.Expression, 0, len(e.Conditions))
for _, cond := range e.Conditions {
newCond, err := expression.SubstituteCorCol2Constant(cond.Clone())
if err != nil {
return errors.Trace(err)
}
newConds = append(newConds, newCond)
}
switch x := e.children[0].(type) {
case *XSelectTableExec:
accessCondition, restCondtion := ranger.DetachColumnConditions(newConds, x.tableInfo.GetPkName())
x.where, _, _ = expression.ExpressionsToPB(sc, restCondtion, client)
ranges, err := ranger.BuildTableRange(accessCondition, sc)
if err != nil {
return errors.Trace(err)
}
x.ranges = ranges
case *XSelectIndexExec:
accessCondition, newConds, _, accessInAndEqCount := ranger.DetachIndexScanConditions(newConds, x.index)
idxConds, tblConds := ranger.DetachIndexFilterConditions(newConds, x.index.Columns, x.tableInfo)
x.indexConditionPBExpr, _, _ = expression.ExpressionsToPB(sc, idxConds, client)
tableConditionPBExpr, _, _ := expression.ExpressionsToPB(sc, tblConds, client)
var err error
x.ranges, err = ranger.BuildIndexRange(sc, x.tableInfo, x.index, accessInAndEqCount, accessCondition)
if err != nil {
return errors.Trace(err)
}
x.where = tableConditionPBExpr
default:
return errors.Errorf("Error type of Executor: %T", x)
}
return nil
}
// Next implements the Executor Next interface.
func (e *SelectionExec) Next() (*Row, error) {
if e.scanController && !e.controllerInit {
err := e.initController()
if err != nil {
return nil, errors.Trace(err)
}
e.controllerInit = true
}
for {
srcRow, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if srcRow == nil {
return nil, nil
}
match, err := expression.EvalBool(e.Conditions, srcRow.Data, e.ctx)
if err != nil {
return nil, errors.Trace(err)
}
if match {
return srcRow, nil
}
}
}
// Open implements the Executor Open interface.
func (e *SelectionExec) Open() error {
if e.scanController {
e.controllerInit = false
}
return e.children[0].Open()
}
// TableScanExec is a table scan executor without result fields.
type TableScanExec struct {
baseExecutor
t table.Table
asName *model.CIStr
ctx context.Context
ranges []types.IntColumnRange
seekHandle int64
iter kv.Iterator
cursor int
schema *expression.Schema
columns []*model.ColumnInfo
isInfoSchema bool
infoSchemaRows [][]types.Datum
infoSchemaCursor int
}
// Schema implements the Executor Schema interface.
func (e *TableScanExec) Schema() *expression.Schema {
return e.schema
}
// Next implements the Executor interface.
func (e *TableScanExec) Next() (*Row, error) {
if e.isInfoSchema {
return e.nextForInfoSchema()
}
for {
if e.cursor >= len(e.ranges) {
return nil, nil
}
ran := e.ranges[e.cursor]
if e.seekHandle < ran.LowVal {
e.seekHandle = ran.LowVal
}
if e.seekHandle > ran.HighVal {
e.cursor++
continue
}
handle, found, err := e.t.Seek(e.ctx, e.seekHandle)
if err != nil {
return nil, errors.Trace(err)
}
if !found {
return nil, nil
}
if handle > ran.HighVal {
// The handle is out of the current range, but may be in following ranges.
// We seek to the range that may contains the handle, so we
// don't need to seek key again.
inRange := e.seekRange(handle)
if !inRange {
// The handle may be less than the current range low value, can not
// return directly.
continue
}
}
row, err := e.getRow(handle)
if err != nil {
return nil, errors.Trace(err)
}
e.seekHandle = handle + 1
return row, nil
}
}
func (e *TableScanExec) nextForInfoSchema() (*Row, error) {
if e.infoSchemaRows == nil {
columns := make([]*table.Column, e.schema.Len())
for i, v := range e.columns {
columns[i] = table.ToColumn(v)
}
err := e.t.IterRecords(e.ctx, nil, columns, func(h int64, rec []types.Datum, cols []*table.Column) (bool, error) {
e.infoSchemaRows = append(e.infoSchemaRows, rec)
return true, nil
})
if err != nil {
return nil, errors.Trace(err)
}
}
if e.infoSchemaCursor >= len(e.infoSchemaRows) {
return nil, nil
}
row := &Row{Data: e.infoSchemaRows[e.infoSchemaCursor]}
e.infoSchemaCursor++
return row, nil
}
// seekRange increments the range cursor to the range
// with high value greater or equal to handle.
func (e *TableScanExec) seekRange(handle int64) (inRange bool) {
for {
e.cursor++
if e.cursor >= len(e.ranges) {
return false
}
ran := e.ranges[e.cursor]
if handle < ran.LowVal {
return false
}
if handle > ran.HighVal {
continue
}
return true
}
}
func (e *TableScanExec) getRow(handle int64) (*Row, error) {
row := &Row{}
var err error
columns := make([]*table.Column, e.schema.Len())
for i, v := range e.columns {
columns[i] = table.ToColumn(v)
}
row.Data, err = e.t.RowWithCols(e.ctx, handle, columns)
if err != nil {
return nil, errors.Trace(err)
}
// Put rowKey to the tail of record row.
rke := &RowKeyEntry{
Tbl: e.t,
Handle: handle,
}
if e.asName != nil && e.asName.L != "" {
rke.TableName = e.asName.L
} else {
rke.TableName = e.t.Meta().Name.L
}
row.RowKeys = append(row.RowKeys, rke)
return row, nil
}
// Open implements the Executor Open interface.
func (e *TableScanExec) Open() error {
e.iter = nil
e.cursor = 0
return nil
}
// ExistsExec represents exists executor.
type ExistsExec struct {
baseExecutor
evaluated bool
}
// Open implements the Executor Open interface.
func (e *ExistsExec) Open() error {
e.evaluated = false
return errors.Trace(e.children[0].Open())
}
// Next implements the Executor Next interface.
// We always return one row with one column which has true or false value.
func (e *ExistsExec) Next() (*Row, error) {
if !e.evaluated {
e.evaluated = true
srcRow, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
return &Row{Data: []types.Datum{types.NewDatum(srcRow != nil)}}, nil
}
return nil, nil
}
// MaxOneRowExec checks if the number of rows that a query returns is at maximum one.
// It's built from subquery expression.
type MaxOneRowExec struct {
baseExecutor
evaluated bool
}
// Open implements the Executor Open interface.
func (e *MaxOneRowExec) Open() error {
e.evaluated = false
return errors.Trace(e.children[0].Open())
}
// Next implements the Executor Next interface.
func (e *MaxOneRowExec) Next() (*Row, error) {
if !e.evaluated {
e.evaluated = true
srcRow, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if srcRow == nil {
return &Row{Data: make([]types.Datum, e.schema.Len())}, nil
}
srcRow1, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if srcRow1 != nil {
return nil, errors.New("subquery returns more than 1 row")
}
return srcRow, nil
}
return nil, nil
}
// UnionExec represents union executor.
// UnionExec has multiple source Executors, it executes them sequentially, and do conversion to the same type
// as source Executors may has different field type, we need to do conversion.
type UnionExec struct {
baseExecutor
finished atomic.Value
resultCh chan *execResult
rows []*Row
cursor int
wg sync.WaitGroup
closedCh chan struct{}
}
type execResult struct {
rows []*Row
err error
}
// Schema implements the Executor Schema interface.
func (e *UnionExec) Schema() *expression.Schema {
return e.schema
}
func (e *UnionExec) waitAllFinished() {
e.wg.Wait()
close(e.resultCh)
close(e.closedCh)
}
func (e *UnionExec) fetchData(idx int) {
defer e.wg.Done()
for {
result := &execResult{
rows: make([]*Row, 0, batchSize),
err: nil,
}
for i := 0; i < batchSize; i++ {
if e.finished.Load().(bool) {
return
}
row, err := e.children[idx].Next()
if err != nil {
e.finished.Store(true)
result.err = err
e.resultCh <- result
return
}
if row == nil {
if len(result.rows) > 0 {
e.resultCh <- result
}
return
}
// TODO: Add cast function in plan building phase.
for j := range row.Data {
col := e.schema.Columns[j]
val, err := row.Data[j].ConvertTo(e.ctx.GetSessionVars().StmtCtx, col.RetType)
if err != nil {
e.finished.Store(true)
result.err = err
e.resultCh <- result
return
}
row.Data[j] = val
}
result.rows = append(result.rows, row)
}
e.resultCh <- result
}
}
// Open implements the Executor Open interface.
func (e *UnionExec) Open() error {
e.finished.Store(false)
e.resultCh = make(chan *execResult, len(e.children))
e.closedCh = make(chan struct{})
e.cursor = 0
var err error
for i, child := range e.children {
err = child.Open()
if err != nil {
break
}
e.wg.Add(1)
go e.fetchData(i)
}
go e.waitAllFinished()
return errors.Trace(err)
}
// Next implements the Executor Next interface.
func (e *UnionExec) Next() (*Row, error) {
if e.cursor >= len(e.rows) {
result, ok := <-e.resultCh
if !ok {
return nil, nil
}
if result.err != nil {
return nil, errors.Trace(result.err)
}
if len(result.rows) == 0 {
return nil, nil
}
e.rows = result.rows
e.cursor = 0
}
row := e.rows[e.cursor]
e.cursor++
return row, nil
}
// Close implements the Executor Close interface.
func (e *UnionExec) Close() error {
e.finished.Store(true)
<-e.closedCh
e.rows = nil
return errors.Trace(e.baseExecutor.Close())
}
// DummyScanExec returns zero results, when some where condition never match, there won't be any
// rows to return, so DummyScan is used to avoid real scan on KV.
type DummyScanExec struct {
baseExecutor
}
// Next implements the Executor Next interface.
func (e *DummyScanExec) Next() (*Row, error) {
return nil, nil
}
// CacheExec represents Cache executor.
// it stores the return values of the executor of its child node.
type CacheExec struct {
baseExecutor
storedRows []*Row
cursor int
srcFinished bool
}
// Open implements the Executor Open interface.
func (e *CacheExec) Open() error {
e.cursor = 0
return errors.Trace(e.children[0].Open())
}
// Next implements the Executor Next interface.
func (e *CacheExec) Next() (*Row, error) {
if e.srcFinished && e.cursor >= len(e.storedRows) {
return nil, nil
}
if !e.srcFinished {
row, err := e.children[0].Next()
if err != nil {
return nil, errors.Trace(err)
}
if row == nil {
e.srcFinished = true
err := e.children[0].Close()
if err != nil {
return nil, errors.Trace(err)
}
}
e.storedRows = append(e.storedRows, row)
}
row := e.storedRows[e.cursor]
e.cursor++
return row, nil
}