package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
DecodePlanGistToPlan constructs an explain.Node tree from a gist.
DecodePlanGistToRows converts a gist to a logical plan and returns the rows.
Emit produces the EXPLAIN output against the given OutputBuilder.
MakeFlags crates Flags from ExplainOptions.
NewFactory creates a new explain factory.
NewOutputBuilder creates a new OutputBuilder.
# Constants
DeflakeAll has all redact flags set.
DeflakeDistribution hides the value of the "distribution" field.
DeflakeNodes hides cluster nodes involved.
DeflakeVectorized hides the value of the "vectorized" field.
DeflakeVolatile hides any values that can vary from one query run to the other, even without changes to the configuration or data distribution (e.g.
# Variables
MaybeAdjustVirtualIndexScan is injected from the sql package.
# Structs
Factory implements exec.ExplainFactory.
Flags are modifiers for EXPLAIN.
Node in a plan tree; records the operation and arguments passed to the factory method and provides access to the corresponding exec.Node (produced by the wrapped factory).
OutputBuilder is used to build the output of an explain tree.
Plan is the result of ConstructPlan; provides access to the exec.Plan produced by the wrapped factory.
PlanGist is a compact representation of a logical plan meant to be used as a key and log for different plans used to implement a particular query.
PlanGistFactory is an exec.Factory that produces a gist by eaves dropping on the exec builder phase of compilation.
# Type aliases
DeflakeFlags control hiding of various field values.
SpanFormatFn is a function used to format spans for EXPLAIN.