Package plantest contains utilities for testing each query planning phase.

Add two cost structures together.

AnyMultiSuccessor returns a pattern that matches any node with any number of successors.

AnySingleSuccessor returns a pattern that matches any node that has a single successor.

CheckRequiredAttributes will check that if the given node requires any attributes from its predecessors, then they are provided, either directly or because a predecessor passes on the attribute from one of its own predecessors.

CheckSuccessorsMustRequire will return an error if the node has an output attribute that must be required by *all* successors, but there exists some node that does not require it.

ComputeBounds computes the time bounds for a plan node from the bounds of its predecessors.

CreateLogicalNode creates a single logical plan node from a procedure spec.

CreatePhysicalNode creates a single physical plan node from a procedure spec.

DisableIntegrityChecks disables integrity checks in the logical planner.

DisableValidation disables validation in the physical planner.

Formatted accepts a plan.Spec and options, and returns a Formatter that can be used with the standard fmt package, e.g., fmt.Println(Formatted(plan, WithDetails()).

GetOutputAttribute will return the attribute with the given key provided by the given plan node, traversing backwards through predecessors as needed for attributes that may pass through.

IndexOfNode is a utility function that will return the offset of the given node in the slice of nodes.

MergeToLogicalNode merges top and bottom plan nodes into a new plan node, with the given procedure spec.

MultiSuccessor returns a pattern that can match a plan node with the given ProcedureKind and whose predecessors match the given predecessor patterns.

MultiSuccessorOneOf matches any plan node from a given set of ProcedureKind and whose predecessors match the given predecessor patterns.

NewLogicalPlanner returns a new logical plan with the given options.

NewPhysicalPlanner creates a new physical plan with the specified options.

NewPlanSpec initializes a new query plan.

OnlyLogicalRules produces a logical plan option that forces only a set of particular rules to be applied.

OnlyPhysicalRules produces a physical plan option that forces only a particular set of rules to be applied.

PhysPat returns a pattern that matches a physical plan node with the given ProcedureKind and whose predecessors match the given predecessor patterns.

RegisterLogicalRules registers the rule created by createFn with the logical plan.

RegisterParallelizationRule registers the rule created by createFn with the physical plan.

RegisterPhysicalRules registers the rule created by createFn with the physical plan.

RegisterProcedureSpec registers a new procedure with the specified kind.

RegisterProcedureSpecWithSideEffect registers a new procedure that produces side effects.

ReplaceNode accepts two nodes and attaches all the predecessors of the old node to the new node.

ReplacePhysicalNodes accepts a connected group of nodes that has a single output and a single input, and replaces them with a single node with the predecessors of the old input node.

SingleSuccessor returns a pattern that can match a plan node with the given ProcedureKind and whose predecessors match the given predecessor patterns.

SingleSuccessorOneOf matches any plan node from a given set of ProcedureKind and whose predecessors match the given predecessor patterns.

SwapPlanNodes swaps two plan nodes and returns an equivalent sub-plan with the nodes swapped.

WalkPredecessor visits every node in the plan rooted at `roots` in topological order, following predecessor links.

WalkSuccessors visits every node in the plan rooted at `roots` in topological order, following successor links.

WithDefaultMemoryLimit sets the default memory limit for plans generated by the plan.

WithDetails returns a FormatOption that can be used to provide extra details in a formatted plan.

DefaultYieldName is the name of a result that doesn't have any name assigned.

EmptyBounds is a time range containing only a single point.

Bounds is a range of time.

CollationAttr is a physical attribute that describes the collation of the rows within a table.

Cost stores various dimensions of the cost of a query plan.

GeneratedYieldProcedureSpec provides a special planner-generated yield for queries that don't have explicit calls to yield().

LogicalNode consists of the input and output edges and a procedure spec that describes what the node does.

ParallelMergeAttribute means that the node accepts parallel data, merges the streams, and produces non-parallel data that covers the entire data source.

ParallelRunAttribute means the node executes in parallel when present.

PhysicalOneKindPattern matches a physical operator pattern.

PhysicalPlanNode represents a physical operation in a plan.

PlannerBuilder provides clients with an easy way to create planners.

Spec holds the result nodes of a query plan with associated metadata.

UnionKindPattern matches any one of a set of procedures that have a specified predecessor pattern.

BoundsAwareProcedureSpec is any procedure that modifies the time bounds of its data.

Detailer provides an optional interface that ProcedureSpecs can implement.

LogicalOption is an option to configure the behavior of the logical plan.

LogicalPlanner translates a flux.Spec into a plan.Spec and applies any registered logical rules to the plan.

Node defines the common interface for interacting with logical and physical plan nodes.

OutputAttributer is an interface to be implemented by PhysicalProcedureSpec implementations that produce output that has particular attributes.

PassThroughAttributer is an interface to be implemented by PhysicalProcedureSpec implementations that allow attributes to propagate from input to output.

Pattern represents an operator tree pattern It can match itself against a query plan.

PhysicalAttr represents an attribute (collation, parallel execution) of a plan node.

PhysicalOption is an option to configure the behavior of the physical plan.

PhysicalPlanner performs transforms a logical plan to a physical plan, by applying any registered physical rules.

PhysicalProcedureSpec is similar to its logical counterpart but must provide a method to determine cost.

PostPhysicalValidator provides an interface that can be implemented by PhysicalProcedureSpecs for any validation checks to be performed post-physical planning.

ProcedureSpec specifies a query operation.

RequiredAttributer is an interface to be implemented by PhysicalProcedureSpec implementations that require physical attributes to be provided by inputs.

Rule is transformation rule for a query operation.

YieldProcedureSpec is a special procedure that has the side effect of returning a result to the client.

CreateProcedureSpec creates a ProcedureSpec from an OperationSpec and Administration.

PhysicalAttributes encapsulates any physical attributes of the result produced by a physical plan node, such as collation, etc.

ProcedureKind denotes the kind of operation.