package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
GetPatherFunc returns a GetPather initialized from a closure.
NewDiskQueue creates a Queue that spills to disk.
NewPartitionedDiskQueue creates a PartitionedDiskQueue whose partitions are all on-disk queues.
NewRewindableDiskQueue creates a RewindableQueue that spills to disk.
# Constants
DiskQueueCacheModeClearAndReuseCache is the same as DiskQueueCacheModeReuseCache with the additional behavior that when a coldata.ZeroBatch is Enqueued, the cache will be released to the GC.
DiskQueueCacheModeIntertwinedCalls is the cache mode in which Enqueues and Dequeues may happen in any order.
DiskQueueCacheModeReuseCache imposes a limitation that all Enqueues happen before all Dequeues to be able to reuse more memory.
PartitionerStrategyCloseOnNewPartition is a partitioner strategy that closes an open partition for writing if a new partition is created.
PartitionerStrategyDefault is a partitioner strategy in which the PartitionedQueue will keep all partitions open for writing.
# Structs
DiskQueueCfg is a struct holding the configuration options for a DiskQueue.
PartitionedDiskQueue is a PartitionedQueue whose partitions are on-disk.
# Interfaces
GetPather is an object that has a temporary directory.
PartitionedQueue is the abstraction for on-disk storage.
Queue describes a simple queue interface to which coldata.Batches can be Enqueued and Dequeued.
RewindableQueue is a Queue that can be read from multiple times.
# Type aliases
DiskQueueCacheMode specifies a pattern that a DiskQueue should use regarding its cache.
PartitionerStrategy describes a strategy used by the PartitionedQueue during its operation.