distsql

Documentation

Index

• func ColumnsToProto(columns []*model.ColumnInfo, pkIsHandle bool) []*tipb.ColumnInfo
• func FieldTypeFromPBColumn(col *tipb.ColumnInfo) *types.FieldType
• func IndexToProto(t *model.TableInfo, idx *model.IndexInfo) *tipb.IndexInfo
• type PartialResult
• type SelectResult
  • func Analyze(ctx goctx.Context, client kv.Client, kvReq *kv.Request) (SelectResult, error)
  • func SelectDAG(goCtx goctx.Context, ctx context.Context, kvReq *kv.Request, ...) (SelectResult, error)

Functions

func ColumnsToProto

func ColumnsToProto(columns []*model.ColumnInfo, pkIsHandle bool) []*tipb.ColumnInfo

ColumnsToProto converts a slice of model.ColumnInfo to a slice of tipb.ColumnInfo.

func FieldTypeFromPBColumn

func FieldTypeFromPBColumn(col *tipb.ColumnInfo) *types.FieldType

FieldTypeFromPBColumn creates a types.FieldType from tipb.ColumnInfo.

func IndexToProto

func IndexToProto(t *model.TableInfo, idx *model.IndexInfo) *tipb.IndexInfo

IndexToProto converts a model.IndexInfo to a tipb.IndexInfo.

Types

type PartialResult

type PartialResult interface {
	// Next returns the next rowData of the sub result.
	// If no more row to return, rowData would be nil.
	Next(goctx.Context) (rowData []types.Datum, err error)
	// Close closes the partial result.
	Close() error
}

PartialResult is the result from a single region server.

type SelectResult

type SelectResult interface {
	// Next gets the next partial result.
	Next(goctx.Context) (PartialResult, error)
	// NextRaw gets the next raw result.
	NextRaw() ([]byte, error)
	// NextChunk reads the data into chunk.
	NextChunk(goctx.Context, *chunk.Chunk) error
	// Close closes the iterator.
	Close() error
	// Fetch fetches partial results from client.
	// The caller should call SetFields() before call Fetch().
	Fetch(goctx.Context)
	// ScanCount gets the total scan row count.
	ScanCount() int64
}

SelectResult is an iterator of coprocessor partial results.

func Analyze

func Analyze(ctx goctx.Context, client kv.Client, kvReq *kv.Request) (SelectResult, error)

Analyze do a analyze request.

func SelectDAG

func SelectDAG(goCtx goctx.Context, ctx context.Context, kvReq *kv.Request, fieldTypes []*types.FieldType) (SelectResult, error)

SelectDAG sends a DAG request, returns SelectResult. In kvReq, KeyRanges is required, Concurrency/KeepOrder/Desc/IsolationLevel/Priority are optional.