package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
MakeOneInputCloserHelper returns a new OneInputCloserHelper.
MakeOneInputHelper returns a new OneInputHelper.
MakeOneInputInitCloserHelper returns a new OneInputInitCloserHelper.
MakeTwoInputInitHelper returns a new TwoInputInitHelper.
NewBatchBuffer creates a new BatchBuffer.
NewFeedOperator returns a new feed operator.
NewNoop returns a new noop Operator.
NewOneInputNode returns an execopnode.OpNode with a single Operator input.
NewRepeatableBatchSource returns a new Operator initialized to return its input batch forever.
NewTestingSemaphore initializes a new TestingSemaphore with the provided limit.
# Constants
BufferingOpCanReuse indicates that the BufferingInMemoryOperator _might_ be reused after ExportBuffered call, so all memory resources should be preserved.
BufferingOpNoReuse indicates that the BufferingInMemoryOperator will **not** be reused after ExportBuffered call, so any memory resources could be fully released.
ExternalHJMinPartitions determines the minimum number of file descriptors that the external hash joiner needs to have in order to make progress.
ExternalSorterMinPartitions determines the minimum number of file descriptors that the external sorter needs to have in order to make progress (when merging, we have to merge at least two partitions into a new third one).
SortMergeNonSortMinFDsOpen determines the minimum number of file descriptors that are needed in the sort-merge fallback strategy of the external hash joiner outside of the needs of the external sorters.
# Structs
BatchBuffer exposes a buffer of coldata.Batches through an Operator interface.
CallbackOperator is a testing utility struct that delegates calls to Init, Next, and Close to the callbacks provided by the user.
CloserHelper is a simple helper that helps Operators implement Closer.
FeedOperator is used to feed an Operator chain with input by manually setting the next batch.
InitHelper is a simple struct that helps Operators implement Init() method.
OneInputCloserHelper is an execopnode.OpNode with a single Operator input that might need to be Close()'d.
OneInputHelper is an execopnode.OpNode which only needs to initialize its single Operator input in Init().
OneInputInitCloserHelper is an execopnode.OpNode that only needs to initialize its single Operator input in Init() and might need to Close() it too.
OneInputNode is an execopnode.OpNode with a single Operator input.
RepeatableBatchSource is an Operator that returns the same batch forever.
TestingSemaphore is a semaphore.Semaphore that never blocks and is always successful.
TwoInputInitHelper is an extension of InitHelper that additionally also is an execopnode.OpNode with two Operator inputs and provides a reset helper.
ZeroInputNode is an execopnode.OpNode with no inputs.
# Interfaces
BufferingInMemoryOperator is an Operator that buffers up intermediate tuples in memory and knows how to export them once the memory limit has been reached.
ClosableOperator is an Operator that needs to be Close()'d.
Closer is an object that releases resources when Close is called.
DrainableClosableOperator is a ClosableOperator that also implements DrainMeta.
KVReader is an operator that performs KV reads.
MetadataSource is an interface implemented by processors and columnar operators that can produce metadata.
NonExplainable is a marker interface which identifies an Operator that should be omitted from the output of EXPLAIN (VEC).
Operator is a column vector operator that produces a Batch as output.
ResettableOperator is an Operator that can be reset.
Resetter is an interface that operators can implement if they can be reset either for reusing (to keep the already allocated memory) or during tests.
VectorizedStatsCollector is the common interface implemented by several variations of the execution statistics collectors.
# Type aliases
BufferingOpReuseMode determines whether the BufferingInMemoryOperator can be reused after ExportBuffered call (after being Reset).
Closers is a slice of Closers.
MetadataSources is a slice of MetadataSource.