tidb driver 源码

2022-09-19 浏览 (674)

tidb driver 代码

文件路径:/server/driver.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,
/ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/ See the License for the specific language governing permissions and
/ limitations under the License.

package server

import (
	"context"
	"crypto/tls"

	"github.com/pingcap/tidb/expression"
	"github.com/pingcap/tidb/util/chunk"
)

/ IDriver opens IContext.
type IDriver interface {
	/ OpenCtx opens an IContext with connection id, client capability, collation, dbname and optionally the tls state.
	OpenCtx(connID uint64, capability uint32, collation uint8, dbname string, tlsState *tls.ConnectionState) (*TiDBContext, error)
}

/ PreparedStatement is the interface to use a prepared statement.
type PreparedStatement interface {
	/ ID returns statement ID
	ID() int

	/ Execute executes the statement.
	Execute(context.Context, []expression.Expression) (ResultSet, error)

	/ AppendParam appends parameter to the statement.
	AppendParam(paramID int, data []byte) error

	/ NumParams returns number of parameters.
	NumParams() int

	/ BoundParams returns bound parameters.
	BoundParams() [][]byte

	/ SetParamsType sets type for parameters.
	SetParamsType([]byte)

	/ GetParamsType returns the type for parameters.
	GetParamsType() []byte

	/ StoreResultSet stores ResultSet for subsequent stmt fetching
	StoreResultSet(rs ResultSet)

	/ GetResultSet gets ResultSet associated this statement
	GetResultSet() ResultSet

	/ Reset removes all bound parameters.
	Reset()

	/ Close closes the statement.
	Close() error
}

/ ResultSet is the result set of an query.
type ResultSet interface {
	Columns() []*ColumnInfo
	NewChunk(chunk.Allocator) *chunk.Chunk
	Next(context.Context, *chunk.Chunk) error
	StoreFetchedRows(rows []chunk.Row)
	GetFetchedRows() []chunk.Row
	Close() error
	/ IsClosed checks whether the result set is closed.
	IsClosed() bool
}

/ fetchNotifier represents notifier will be called in COM_FETCH.
type fetchNotifier interface {
	/ OnFetchReturned be called when COM_FETCH returns.
	/ it will be used in server-side cursor.
	OnFetchReturned()
}

相关信息

tidb 源码目录

相关文章

tidb buffered_read_conn 源码

tidb column 源码

tidb conn 源码

tidb conn_stmt 源码

tidb driver_tidb 源码

tidb http_handler 源码

tidb http_status 源码

tidb mock_conn 源码

tidb optimize_trace 源码

tidb packetio 源码

^