sessionctx

Documentation

Index

• Constants
• Variables
• func SetCommitCtx(ctx context.Context, sessCtx Context) context.Context
• func SetStreamReadKey(ctx context.Context) context.Context
• func SetTxnCtx(ctx context.Context, txn kv.Transaction) context.Context
• func StreamReadFromContext(ctx context.Context) bool
• type Context

Constants

const (
	// QueryString is the key for original query string.
	QueryString basicCtxType = 1
	// Initing is the key for indicating if the server is running bootstrap or upgrade job.
	Initing basicCtxType = 2
	// LastExecuteDDL is the key for whether the session execute a ddl command last time.
	LastExecuteDDL basicCtxType = 3
)

Context keys.

Variables

var ConnID = connIDCtxKeyType{}

ConnID is the key in context.

var StreamReadKey = streamReadKeyType{}

var TxnIDKey = txnIDCtxKeyType{}

TxnIDKey is the key in context

Functions

func SetCommitCtx

func SetCommitCtx(ctx context.Context, sessCtx Context) context.Context

SetCommitCtx sets the variables for context before commit a transaction.

func SetStreamReadKey

func SetStreamReadKey(ctx context.Context) context.Context

func SetTxnCtx

func SetTxnCtx(ctx context.Context, txn kv.Transaction) context.Context

SetTxnCtx sets the variables for context

func StreamReadFromContext

func StreamReadFromContext(ctx context.Context) bool

Types

type Context

type Context interface {
	// NewTxn creates a new transaction for further execution.
	// If old transaction is valid, it is committed first.
	// It's used in BEGIN statement and DDL statements to commit old transaction.
	NewTxn(context.Context) error

	// Txn returns the current transaction which is created before executing a statement.
	// The returned kv.Transaction is not nil, but it maybe pending or invalid.
	// If the active parameter is true, call this function will wait for the pending txn
	// to become valid.
	Txn(active bool) (kv.Transaction, error)

	// GetClient gets a kv.Client.
	GetClient() kv.Client

	// SetValue saves a value associated with this context for key.
	SetValue(key fmt.Stringer, value interface{})

	// Value returns the value associated with this context for key.
	Value(key fmt.Stringer) interface{}

	// ClearValue clears the value associated with this context for key.
	ClearValue(key fmt.Stringer)

	GetSessionVars() *variable.SessionVars

	// InitTxnWithStartTS initializes a transaction with startTS.
	// It should be called right before we builds an executor.
	InitTxnWithStartTS(startTS uint64) error

	// GetStore returns the store of session.
	GetStore() kv.Storage
}

Context is an interface for transaction and executive args environment.