vm

Documentation

Index

• Variables
• func CancelCheck(proc *process.Process) (error, bool)
• func Prepare(ins Instructions, proc *process.Process) error
• func Run(ins Instructions, proc *process.Process) (end bool, err error)
• func String(ins Instructions, buf *bytes.Buffer)
• type CallResult
  • func ChildrenCall(o Operator, proc *process.Process, anal process.Analyze) (CallResult, error)
  • func NewCallResult() CallResult
• type CtrState
• type ExecStatus
• type Instruction
  • func (ins *Instruction) CannotRemote() bool
  • func (ins *Instruction) IsBrokenNode() bool
  • func (ins *Instruction) MarshalBinary() ([]byte, error)
  • func (ins *Instruction) UnmarshalBinary(_ []byte) error
• type Instructions
• type ModificationArgument
• type OpType
• type Operator
• type OperatorBase
  • func (o *OperatorBase) AppendChild(child Operator)
  • func (o *OperatorBase) GetChildren(idx int) Operator
  • func (o *OperatorBase) GetCnAddr() string
  • func (o *OperatorBase) GetIdx() int
  • func (o *OperatorBase) GetIsFirst() bool
  • func (o *OperatorBase) GetIsLast() bool
  • func (o *OperatorBase) GetMaxParallel() int32
  • func (o *OperatorBase) GetOperatorID() int32
  • func (o *OperatorBase) GetParalleID() int32
  • func (o *OperatorBase) GetParallelIdx() int
  • func (o *OperatorBase) GetParallelMajor() bool
  • func (o *OperatorBase) NumChildren() int
  • func (o *OperatorBase) SetChildren(children []Operator)
  • func (o *OperatorBase) SetInfo(info *OperatorInfo)
• type OperatorInfo
  • func (info OperatorInfo) GetAddress() process.MessageAddress

Variables

var CancelResult = CallResult{
	Status: ExecStop,
}

Functions

func CancelCheck

func CancelCheck(proc *process.Process) (error, bool)

func Prepare

func Prepare(ins Instructions, proc *process.Process) error

Prepare range instructions and do init work for each operator's argument by calling its prepare function

func Run

func Run(ins Instructions, proc *process.Process) (end bool, err error)

func String

func String(ins Instructions, buf *bytes.Buffer)

String range instructions and call each operator's string function to show a query plan

Types

type CallResult

type CallResult struct {
	Status ExecStatus
	Batch  *batch.Batch
}

func ChildrenCall

func ChildrenCall(o Operator, proc *process.Process, anal process.Analyze) (CallResult, error)

func NewCallResult

func NewCallResult() CallResult

type CtrState

type CtrState int

const (
	Build CtrState = iota
	Eval
	End
)

type ExecStatus

type ExecStatus int

const (
	ExecStop ExecStatus = iota
	ExecNext
	ExecHasMore
)

type Instruction

type Instruction struct {
	// Op specified the operator code of an instruction.
	Op OpType
	// Idx specified the analysis information index.
	Idx int
	// Arg contains the operand of this instruction.
	Arg Operator

	// flag for analyzeInfo record the row information
	IsFirst bool
	IsLast  bool

	CnAddr      string
	OperatorID  int32
	ParallelID  int32
	MaxParallel int32
}

Instruction contains relational algebra

func (*Instruction) CannotRemote

func (ins *Instruction) CannotRemote() bool

func (*Instruction) IsBrokenNode

func (ins *Instruction) IsBrokenNode() bool

func (*Instruction) MarshalBinary

func (ins *Instruction) MarshalBinary() ([]byte, error)

func (*Instruction) UnmarshalBinary

func (ins *Instruction) UnmarshalBinary(_ []byte) error

type Instructions

type Instructions []Instruction

type ModificationArgument

type ModificationArgument interface {
	AffectedRows() uint64
}

type OpType

type OpType int

const (
	Top OpType = iota
	Limit
	Order
	Group
	Window
	TimeWin
	Fill
	Output
	Offset
	Product
	Restrict
	Dispatch
	Connector
	Projection

	Join
	LoopJoin
	Left
	LoopLeft
	Single
	LoopSingle
	Semi
	RightSemi
	LoopSemi
	Anti
	RightAnti
	LoopAnti
	Mark
	LoopMark
	IndexJoin
	IndexBuild

	Merge
	MergeTop
	MergeLimit
	MergeOrder
	MergeGroup
	MergeOffset
	MergeRecursive
	MergeCTE
	Partition

	Deletion
	Insert
	External
	Source

	Minus
	Intersect
	IntersectAll

	HashBuild

	TableFunction
	TableScan
	ValueScan
	// MergeBlock is used to recieve S3 block metLoc Info, and write
	// them to S3
	MergeBlock
	// MergeDelete is used to recieve S3 Blcok Delete Info from remote Cn
	MergeDelete
	Right
	OnDuplicateKey
	FuzzyFilter
	PreInsert
	PreInsertUnique
	PreInsertSecondaryIndex
	// LastInstructionOp is not a true operator and must set at last.
	// It was used by unit testing to ensure that
	// all functions related to instructions can reach 100% coverage.
	LastInstructionOp

	// LockOp is used to add locks to lockservice for pessimistic transactions.
	// Operator that encounters a write conflict will block until the previous
	// transaction has released the lock
	LockOp

	Shuffle

	Sample
)

type Operator

type Operator interface {
	// Free release all the memory allocated from mPool in an operator.
	// pipelineFailed marks the process status of the pipeline when the method is called.
	Free(proc *process.Process, pipelineFailed bool, err error)

	// String returns the string representation of an operator.
	String(buf *bytes.Buffer)

	//Prepare prepares an operator for execution.
	Prepare(proc *process.Process) error

	//Call calls an operator.
	Call(proc *process.Process) (CallResult, error)

	//Release an operator
	Release()

	// OperatorBase methods
	SetInfo(info *OperatorInfo)
	AppendChild(child Operator)

	GetOperatorBase() *OperatorBase
}

type OperatorBase

type OperatorBase struct {
	OperatorInfo
	Children []Operator
}

func (*OperatorBase) AppendChild

func (o *OperatorBase) AppendChild(child Operator)

func (*OperatorBase) GetChildren

func (o *OperatorBase) GetChildren(idx int) Operator

func (*OperatorBase) GetCnAddr

func (o *OperatorBase) GetCnAddr() string

func (*OperatorBase) GetIdx

func (o *OperatorBase) GetIdx() int

func (*OperatorBase) GetIsFirst

func (o *OperatorBase) GetIsFirst() bool

func (*OperatorBase) GetIsLast

func (o *OperatorBase) GetIsLast() bool

func (*OperatorBase) GetMaxParallel

func (o *OperatorBase) GetMaxParallel() int32

func (*OperatorBase) GetOperatorID

func (o *OperatorBase) GetOperatorID() int32

func (*OperatorBase) GetParalleID

func (o *OperatorBase) GetParalleID() int32

func (*OperatorBase) GetParallelIdx

func (o *OperatorBase) GetParallelIdx() int

func (*OperatorBase) GetParallelMajor

func (o *OperatorBase) GetParallelMajor() bool

func (*OperatorBase) NumChildren

func (o *OperatorBase) NumChildren() int

func (*OperatorBase) SetChildren

func (o *OperatorBase) SetChildren(children []Operator)

func (*OperatorBase) SetInfo

func (o *OperatorBase) SetInfo(info *OperatorInfo)

type OperatorInfo

type OperatorInfo struct {
	Idx           int
	ParallelIdx   int
	ParallelMajor bool
	IsFirst       bool
	IsLast        bool

	CnAddr      string
	OperatorID  int32
	ParallelID  int32
	MaxParallel int32
}

func (OperatorInfo) GetAddress

func (info OperatorInfo) GetAddress() process.MessageAddress