tikvrpc

Documentation

Index

• func SetContext(req *Request, ctx *kvrpcpb.Context) error
• type CmdType
• type Request
  • func (req *Request) GetContext() (*kvrpcpb.Context, error)
• type Response
  • func GenRegionErrorResp(req *Request, e *errorpb.Error) (*Response, error)
  • func (resp *Response) GetRegionError() (*errorpb.Error, error)

Functions

func SetContext

func SetContext(req *Request, ctx *kvrpcpb.Context) error

SetContext set the Context field for the given req to the specified ctx.

Types

type CmdType

type CmdType uint16

CmdType represents the concrete request type in Request or response type in Response.

const (
	CmdGet CmdType = 1 + iota
	CmdScan
	CmdPrewrite
	CmdCommit
	CmdCleanup
	CmdBatchGet
	CmdBatchRollback
	CmdScanLock
	CmdResolveLock
	CmdGC

	CmdRawGet CmdType = 256 + iota
	CmdRawPut
	CmdRawDelete
	CmdRawScan

	CmdCop CmdType = 512 + iota
)

CmdType values.

type Request

type Request struct {
	Type          CmdType
	Priority      kvrpcpb.CommandPri
	Get           *kvrpcpb.GetRequest
	Scan          *kvrpcpb.ScanRequest
	Prewrite      *kvrpcpb.PrewriteRequest
	Commit        *kvrpcpb.CommitRequest
	Cleanup       *kvrpcpb.CleanupRequest
	BatchGet      *kvrpcpb.BatchGetRequest
	BatchRollback *kvrpcpb.BatchRollbackRequest
	ScanLock      *kvrpcpb.ScanLockRequest
	ResolveLock   *kvrpcpb.ResolveLockRequest
	GC            *kvrpcpb.GCRequest
	RawGet        *kvrpcpb.RawGetRequest
	RawPut        *kvrpcpb.RawPutRequest
	RawDelete     *kvrpcpb.RawDeleteRequest
	RawScan       *kvrpcpb.RawScanRequest
	Cop           *coprocessor.Request
}

Request wraps all kv/coprocessor requests.

func (*Request) GetContext

func (req *Request) GetContext() (*kvrpcpb.Context, error)

GetContext returns the rpc context for the underlying concrete request.

type Response

type Response struct {
	Type          CmdType
	Get           *kvrpcpb.GetResponse
	Scan          *kvrpcpb.ScanResponse
	Prewrite      *kvrpcpb.PrewriteResponse
	Commit        *kvrpcpb.CommitResponse
	Cleanup       *kvrpcpb.CleanupResponse
	BatchGet      *kvrpcpb.BatchGetResponse
	BatchRollback *kvrpcpb.BatchRollbackResponse
	ScanLock      *kvrpcpb.ScanLockResponse
	ResolveLock   *kvrpcpb.ResolveLockResponse
	GC            *kvrpcpb.GCResponse
	RawGet        *kvrpcpb.RawGetResponse
	RawPut        *kvrpcpb.RawPutResponse
	RawDelete     *kvrpcpb.RawDeleteResponse
	RawScan       *kvrpcpb.RawScanResponse
	Cop           *coprocessor.Response
}

Response wraps all kv/coprocessor responses.

func GenRegionErrorResp

func GenRegionErrorResp(req *Request, e *errorpb.Error) (*Response, error)

GenRegionErrorResp returns corresponding Response with specified RegionError according to the given req.

func (*Response) GetRegionError

func (resp *Response) GetRegionError() (*errorpb.Error, error)

GetRegionError returns the RegionError of the underlying concrete response.