spannerplan

May 6, 2026

Changes in this version

type QueryPlan

+ func (qp *QueryPlan) ParentLinks(childIndex int32) []ResolvedParentLink

+ type ResolvedParentLink struct

+ ChildLink *sppb.PlanNode_ChildLink

+ Parent *sppb.PlanNode

Apr 28, 2026

Changes in this version

+ var ErrChildLinkIndexOutOfRange = errors.New("spannerplan: childLink childIndex out of range")

+ var ErrNilChildLink = errors.New("spannerplan: childLink cannot be nil")

+ var ErrNilPlanNode = errors.New("spannerplan: planNode cannot be nil")

+ var ErrPlanNodeIndexMismatch = errors.New("spannerplan: planNode index must match slice position")

Jun 7, 2025

Changes in this version

type Option

+ func HideMetadata() Option

type QueryPlan

+ func (qp *QueryPlan) GetLinkType(link *sppb.PlanNode_ChildLink) string

Jun 4, 2025

Changes in this version

type ExecutionMethodFormat

+ func ParseExecutionMethodFormat(s string) (ExecutionMethodFormat, error)

type KnownFlagFormat

+ func ParseKnownFlagFormat(s string) (KnownFlagFormat, error)

type Option

+ func WithInlineStatsFunc(f func(*sppb.PlanNode) []string) Option

type TargetMetadataFormat

+ func ParseTargetMetadataFormat(s string) (TargetMetadataFormat, error)

Jun 2, 2025

Changes in this version

+ var ErrEmptyPlanNodes = errors.New("spannerplan: planNodes cannot be empty")

+ func HasStats(nodes []*sppb.PlanNode) bool

type QueryPlan

+ func (qp *QueryPlan) HasStats() bool

Jun 1, 2025

Changes in this version

+ const FullScanFormatLabel

+ const FullScanFormatRaw

+ const KnownFlagFormatLabel

+ const KnownFlagFormatRaw

+ func ExtractQueryPlan(b []byte) (*sppb.ResultSetStats, *sppb.StructType, error)

+ func NodeTitle(node *sppb.PlanNode, opts ...Option) string

+ type ExecutionMethodFormat int64

+ const ExecutionMethodFormatAngle

+ const ExecutionMethodFormatRaw

+ type FullScanFormat = KnownFlagFormat

+ type KnownFlagFormat int64

+ type Option func(o *option)

+ func EnableCompact() Option

+ func WithExecutionMethodFormat(fmt ExecutionMethodFormat) Option

+ func WithFullScanFormat(fmt FullScanFormat) Option

+ func WithKnownFlagFormat(fmt KnownFlagFormat) Option

+ func WithTargetMetadataFormat(fmt TargetMetadataFormat) Option

+ type QueryPlan struct

+ func New(planNodes []*sppb.PlanNode) *QueryPlan

+ func (qp *QueryPlan) GetNodeByChildLink(link *sppb.PlanNode_ChildLink) *sppb.PlanNode

+ func (qp *QueryPlan) GetNodeByIndex(id int32) *sppb.PlanNode

+ func (qp *QueryPlan) GetParentNodeByChildIndex(index int32) *sppb.PlanNode

+ func (qp *QueryPlan) GetParentNodeByChildLink(link *sppb.PlanNode_ChildLink) *sppb.PlanNode

+ func (qp *QueryPlan) IsFunction(childLink *sppb.PlanNode_ChildLink) bool

+ func (qp *QueryPlan) IsPredicate(childLink *sppb.PlanNode_ChildLink) bool

+ func (qp *QueryPlan) IsVisible(link *sppb.PlanNode_ChildLink) bool

+ func (qp *QueryPlan) PlanNodes() []*sppb.PlanNode

+ func (qp *QueryPlan) ResolveChildLink(item *sppb.PlanNode_ChildLink) *ResolvedChildLink

+ func (qp *QueryPlan) VisibleChildLinks(node *sppb.PlanNode) []*sppb.PlanNode_ChildLink

+ type ResolvedChildLink struct

+ Child *sppb.PlanNode

+ ChildLink *sppb.PlanNode_ChildLink

+ type TargetMetadataFormat int64

+ const TargetMetadataFormatOn

+ const TargetMetadataFormatRaw