explain

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 29, 2022 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

explain explain statement

Index

Constants

View Source 
const ExternalScan = "External Scan"
View Source 
const InputRows = "Input Rows"
View Source 
const InputSize = "Input Size"
View Source 
const TableScan = "Table Scan"

Variables

This section is empty.

Functions

func GetDeleteTableLableValue added in v0.6.0 

func GetDeleteTableLableValue(deleteCtxs []*plan.DeleteTableCtx, options *ExplainOptions) []string

func GetExprsLabelValue added in v0.6.0 

func GetExprsLabelValue(exprList []*plan.Expr, options *ExplainOptions) ([]string, error)

func GetTableColsLableValue added in v0.6.0 

func GetTableColsLableValue(cols []*plan.ColDef, options *ExplainOptions) []string

func GetUpdateTableColsLableValue added in v0.6.0 

func GetUpdateTableColsLableValue(cols []*plan.ColDef, db string, tname string, options *ExplainOptions) []string

func GetUpdateTableLableValue added in v0.6.0 

func GetUpdateTableLableValue(updateCtxs []*plan.UpdateCtx, options *ExplainOptions) []string

func GettOrderByLabelValue added in v0.6.0 

func GettOrderByLabelValue(orderbyList []*plan.OrderBySpec, options *ExplainOptions) ([]string, error)

func PreOrderPlan added in v0.6.0 

func PreOrderPlan(node *plan.Node, Nodes []*plan.Node, graphData *GraphData, options *ExplainOptions) error

Types

type AnalyzeInfoDescribeImpl added in v0.6.0 

type AnalyzeInfoDescribeImpl struct {
	AnalyzeInfo *plan.AnalyzeInfo
}

func NewAnalyzeInfoDescribeImpl added in v0.6.0 

func NewAnalyzeInfoDescribeImpl(analyze *plan.AnalyzeInfo) *AnalyzeInfoDescribeImpl

func (AnalyzeInfoDescribeImpl) GetDescription added in v0.6.0 

func (a AnalyzeInfoDescribeImpl) GetDescription(options *ExplainOptions) (string, error)

type Cost added in v0.6.0 

type Cost struct {
	Start   float64 `json:"start"`
	Total   float64 `json:"total"`
	Card    float64 `json:"card"`
	Ndv     float64 `json:"ndv"`
	Rowsize float64 `json:"rowsize"`
}

type CostDescribeImpl 

type CostDescribeImpl struct {
	Cost *plan.Cost
}

func (*CostDescribeImpl) GetDescription 

func (c *CostDescribeImpl) GetDescription(options *ExplainOptions) (string, error)

type Edge added in v0.6.0 

type Edge struct {
	Id     string `json:"id"`
	Src    string `json:"src"`
	Dst    string `json:"dst"`
	Output int64  `json:"output"`
	Unit   string `json:"unit"`
}

type ExplainData added in v0.6.0 

type ExplainData struct {
	Steps   []Step `json:"steps"`
	Code    uint16 `json:"code"`
	Message string `json:"message"`
	Success bool   `json:"success"`
	Uuid    string `json:"uuid"`
}

func NewExplainData added in v0.6.0 

func NewExplainData(uuid uuid.UUID) *ExplainData

func NewExplainDataFail added in v0.6.0 

func NewExplainDataFail(uuid uuid.UUID, code uint16, msg string) *ExplainData

func (*ExplainData) StatisticsRead added in v0.6.0 

func (d *ExplainData) StatisticsRead() (rows int64, size int64)

StatisticsRead statistics read rows, size in ExplainData

type ExplainDataBuffer 

type ExplainDataBuffer struct {
	Start       int
	End         int
	CurrentLine int
	NodeSize    int
	Lines       []string
}

func NewExplainDataBuffer 

func NewExplainDataBuffer() *ExplainDataBuffer

func (*ExplainDataBuffer) AppendCurrentLine 

func (buf *ExplainDataBuffer) AppendCurrentLine(temp string)

func (*ExplainDataBuffer) PushNewLine 

func (buf *ExplainDataBuffer) PushNewLine(line string, isNewNode bool, level int)

type ExplainFormat 

type ExplainFormat int32
const (
	EXPLAIN_FORMAT_TEXT ExplainFormat = 0
	EXPLAIN_FORMAT_XML  ExplainFormat = 1
	EXPLAIN_FORMAT_JSON ExplainFormat = 2
	EXPLAIN_FORMAT_DOT  ExplainFormat = 3
)

type ExplainOptions 

type ExplainOptions struct {
	Verbose bool
	Analyze bool
	Format  ExplainFormat
}

func NewExplainDefaultOptions 

func NewExplainDefaultOptions() *ExplainOptions

type ExplainQuery 

type ExplainQuery interface {
	ExplainPlan(buffer *ExplainDataBuffer, options *ExplainOptions) error
}

type ExplainQueryImpl 

type ExplainQueryImpl struct {
	QueryPlan *plan.Query
}

func NewExplainQueryImpl 

func NewExplainQueryImpl(query *plan.Query) *ExplainQueryImpl

func (*ExplainQueryImpl) BuildJsonPlan added in v0.6.0 

func (e *ExplainQueryImpl) BuildJsonPlan(uuid uuid.UUID, options *ExplainOptions) *ExplainData

func (*ExplainQueryImpl) ExplainPlan 

func (e *ExplainQueryImpl) ExplainPlan(buffer *ExplainDataBuffer, options *ExplainOptions) error

type ExprListDescribeImpl 

type ExprListDescribeImpl struct {
	ExprList []*plan.Expr // ProjectList,OnList,FilterList,GroupBy,GroupingSet and so on
}

func NewExprListDescribeImpl 

func NewExprListDescribeImpl(ExprList []*plan.Expr) *ExprListDescribeImpl

func (*ExprListDescribeImpl) GetDescription 

func (e *ExprListDescribeImpl) GetDescription(options *ExplainOptions) (string, error)

type FormatSettings 

type FormatSettings struct {
	// contains filtered or unexported fields
}

type Global added in v0.6.0 

type Global struct {
	Statistics Statistics `json:"statistics"`
	TotalStats TotalStats `json:"totalStats"`
}

func NewGlobal added in v0.6.0 

func NewGlobal() *Global

type GraphData added in v0.6.0 

type GraphData struct {
	Nodes  []Node  `json:"nodes"`
	Edges  []Edge  `json:"edges"`
	Labels []Label `json:"labels"`
	Global Global  `json:"global"`
}

func NewGraphData added in v0.6.0 

func NewGraphData() *GraphData

type Label added in v0.6.0 

type Label struct {
	Name  string      `json:"name"`
	Value interface{} `json:"value"`
}

func NewLabel added in v0.6.0 

func NewLabel(name string, value interface{}) *Label

type MarshalNode added in v0.6.0 

type MarshalNode interface {
	GetNodeName() (string, error)
	GetNodeTitle(options *ExplainOptions) (string, error)
	GetNodeLabels(options *ExplainOptions) ([]Label, error)
	GetStatistics(options *ExplainOptions) Statistics
	GetCost() Cost
	GetTotalStats() TotalStats
}

type MarshalNodeImpl added in v0.6.0 

type MarshalNodeImpl struct {
	// contains filtered or unexported fields
}

func NewMarshalNodeImpl added in v0.6.0 

func NewMarshalNodeImpl(node *plan.Node) *MarshalNodeImpl

func (MarshalNodeImpl) GetCost added in v0.6.0 

func (m MarshalNodeImpl) GetCost() Cost

func (MarshalNodeImpl) GetNodeLabels added in v0.6.0 

func (m MarshalNodeImpl) GetNodeLabels(options *ExplainOptions) ([]Label, error)

func (MarshalNodeImpl) GetNodeName added in v0.6.0 

func (m MarshalNodeImpl) GetNodeName() (string, error)

func (MarshalNodeImpl) GetNodeTitle added in v0.6.0 

func (m MarshalNodeImpl) GetNodeTitle(options *ExplainOptions) (string, error)

func (MarshalNodeImpl) GetStatistics added in v0.6.0 

func (m MarshalNodeImpl) GetStatistics(options *ExplainOptions) Statistics

func (MarshalNodeImpl) GetTotalStats added in v0.6.0 

func (m MarshalNodeImpl) GetTotalStats() TotalStats

type Node added in v0.6.0 

type Node struct {
	NodeId     string     `json:"id"`
	Name       string     `json:"name"`
	Title      string     `json:"title"`
	Labels     []Label    `json:"labels"`
	Statistics Statistics `json:"statistics"`
	Cost       Cost       `json:"cost"`
	TotalStats TotalStats `json:"totalStats"`
}

func ConvertNode added in v0.6.0 

func ConvertNode(node *plan.Node, options *ExplainOptions) (*Node, error)

type NodeDescribe 

type NodeDescribe interface {
	GetNodeBasicInfo(options *ExplainOptions) (string, error)
	GetExtraInfo(options *ExplainOptions) ([]string, error)
	GetProjectListInfo(options *ExplainOptions) (string, error)
	GetJoinTypeInfo(options *ExplainOptions) (string, error)
	GetJoinConditionInfo(options *ExplainOptions) (string, error)
	GetFilterConditionInfo(options *ExplainOptions) (string, error)
	GetOrderByInfo(options *ExplainOptions) (string, error)
	GetGroupByInfo(options *ExplainOptions) (string, error)
	GetTableDef(options *ExplainOptions) (string, error)
	GetActualAnalyzeInfo(options *ExplainOptions) (string, error)
}

type NodeDescribeImpl 

type NodeDescribeImpl struct {
	Node *plan.Node
}

func NewNodeDescriptionImpl 

func NewNodeDescriptionImpl(node *plan.Node) *NodeDescribeImpl

func (*NodeDescribeImpl) GetActualAnalyzeInfo added in v0.6.0 

func (ndesc *NodeDescribeImpl) GetActualAnalyzeInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetAggregationInfo 

func (ndesc *NodeDescribeImpl) GetAggregationInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetExtraInfo 

func (ndesc *NodeDescribeImpl) GetExtraInfo(options *ExplainOptions) ([]string, error)

func (*NodeDescribeImpl) GetFilterConditionInfo 

func (ndesc *NodeDescribeImpl) GetFilterConditionInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetGroupByInfo 

func (ndesc *NodeDescribeImpl) GetGroupByInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetJoinConditionInfo 

func (ndesc *NodeDescribeImpl) GetJoinConditionInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetJoinTypeInfo 

func (ndesc *NodeDescribeImpl) GetJoinTypeInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetNodeBasicInfo 

func (ndesc *NodeDescribeImpl) GetNodeBasicInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetOrderByInfo 

func (ndesc *NodeDescribeImpl) GetOrderByInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetProjectListInfo 

func (ndesc *NodeDescribeImpl) GetProjectListInfo(options *ExplainOptions) (string, error)

func (*NodeDescribeImpl) GetTableDef 

func (ndesc *NodeDescribeImpl) GetTableDef(options *ExplainOptions) (string, error)

type NodeElemDescribe 

type NodeElemDescribe interface {
	GetDescription(options *ExplainOptions) (string, error)
}

type OrderByDescribeImpl 

type OrderByDescribeImpl struct {
	OrderBy []*plan.OrderBySpec
}

func NewOrderByDescribeImpl 

func NewOrderByDescribeImpl(OrderBy []*plan.OrderBySpec) *OrderByDescribeImpl

func (*OrderByDescribeImpl) GetDescription 

func (o *OrderByDescribeImpl) GetDescription(options *ExplainOptions) (string, error)

type RowsetDataDescribeImpl 

type RowsetDataDescribeImpl struct {
	RowsetData *plan.RowsetData
}

func (*RowsetDataDescribeImpl) GetDescription 

func (r *RowsetDataDescribeImpl) GetDescription(options *ExplainOptions) (string, error)

type StatisticValue added in v0.6.0 

type StatisticValue struct {
	Name  string `json:"name"`
	Value int64  `json:"value"`
	Unit  string `json:"unit"`
}

type Statistics added in v0.6.0 

type Statistics struct {
	Memory     []StatisticValue `json:"Memory"`
	Throughput []StatisticValue `json:"Throughput"`
	IO         []StatisticValue `json:"IO"`
	Network    []StatisticValue `json:"Network"`
}

func NewStatistics added in v0.6.0 

func NewStatistics() *Statistics

type Stats added in v0.6.0 

type Stats struct {
}

type Step added in v0.6.0 

type Step struct {
	GraphData   GraphData `json:"graphData"`
	Step        int       `json:"step"`
	Description string    `json:"description"`
	State       string    `json:"state"`
	Stats       Stats     `json:"stats"`
}

func NewStep added in v0.6.0 

func NewStep(step int) *Step

type TotalStats added in v0.6.0 

type TotalStats struct {
	Name  string `json:"name"`
	Value int64  `json:"value"`
	Unit  string `json:"unit"`
}

type UpdateCtxsDescribeImpl added in v0.6.0 

type UpdateCtxsDescribeImpl struct {
	UpdateCtxs []*plan.UpdateCtx
}

func (*UpdateCtxsDescribeImpl) GetDescription added in v0.6.0 

func (u *UpdateCtxsDescribeImpl) GetDescription(options *ExplainOptions) (string, error)

type WinSpecDescribeImpl 

type WinSpecDescribeImpl struct {
	WinSpec *plan.WindowSpec
}

func (*WinSpecDescribeImpl) GetDescription 

func (w *WinSpecDescribeImpl) GetDescription(options *ExplainOptions) (string, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.