plan

Documentation

Index

• type Plan
  • func NewPlan(rawQuery string) Plan

Types

type Plan

type Plan interface {

	// Getters
	GetType() sqlparser.StatementType
	GetStatement() (sqlparser.Statement, bool)
	GetOriginal() string
	GetInstructions() primitivegraph.PrimitiveGraphHolder
	GetBindVarNeeds() sqlparser.BindVarNeeds

	// Signals whether the plan is worthy to place in `cache.LRUCache`.
	IsCacheable() bool

	// Get the redo log entry.
	GetRedoLog() (binlog.LogEntry, bool)
	// Get the undo log entry.
	GetUndoLog() (binlog.LogEntry, bool)

	// Setters
	SetType(t sqlparser.StatementType)
	SetStatement(statement sqlparser.Statement)
	SetOriginal(original string)
	SetInstructions(instructions primitivegraph.PrimitiveGraphHolder)
	SetBindVarNeeds(bindVarNeeds sqlparser.BindVarNeeds)
	SetCacheable(isCacheable bool)
	SetTxnID(txnID int)

	//
	IsReadOnly() bool
	SetReadOnly(bool)

	// Size is defined so that Plan can be given to a cache.LRUCache,
	// which requires its objects to define a Size function.
	Size() int

	GetPrimitiveGraphHolder() (primitivegraph.PrimitiveGraphHolder, bool)
}

func NewPlan

func NewPlan(
	rawQuery string,
) Plan