context

Documentation

Index

• Constants
• type Context
• type CtxForCancel
  • func (ctx CtxForCancel) Deadline() (deadline time.Time, ok bool)
  • func (ctx CtxForCancel) Err() error
  • func (ctx CtxForCancel) Value(interface{}) interface{}

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 upgrad job.
	Initing basicCtxType = 2
)

Context keys.

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() error

	// Txn returns the current transaction which is created before executing a statement.
	Txn() kv.Transaction

	// 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

	GetSessionManager() util.SessionManager

	// ActivePendingTxn receives the pending transaction from the transaction channel.
	// It should be called right before we builds an executor.
	ActivePendingTxn() error

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

	// Done returns a channel for cancellation, the same as standard context.Context.
	// See https://godoc.org/context for more examples of how to use it.
	Done() <-chan struct{}
}

Context is an interface for transaction and executive args environment.

type CtxForCancel

type CtxForCancel struct {
	Context
}

CtxForCancel implements the standard Go context.Context interface.

func (CtxForCancel) Deadline

func (ctx CtxForCancel) Deadline() (deadline time.Time, ok bool)

Deadline implements the standard Go context.Context interface.

func (CtxForCancel) Err

func (ctx CtxForCancel) Err() error

Err implements the standard Go context.Context interface.

func (CtxForCancel) Value

func (ctx CtxForCancel) Value(interface{}) interface{}

Value implements the standard Go context.Context interface.