package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
ComputeStatsForRange computes the stats for a given range by iterating over all key spans for the given range that should be accounted for in its stats.
ComputeStatsForRangeExcludingUser is like ComputeStatsForRange but iterates only over spans *not* corresponding to user keys.
ComputeStatsForRangeUserOnly is like ComputeStatsForRange but iterates only over spans corresponding to user keys.
ComputeStatsForRangeWithVisitors is like ComputeStatsForRange but also calls the given callbacks for every key.
ComputeStatsForRangeWithVisitorsExcludingUser is like ComputeStatsForRangeWithVisitors but computes stats only for spans corresponding to non-user keys.
ComputeStatsForRangeWithVisitorsUserOnly is like ComputeStatsForRangeWithVisitors but computes stats only for spans corresponding to user keys.
IterateMVCCReplicaKeySpans iterates over replica's key spans in the similar way to IterateReplicaKeySpans, but uses MVCCIterator and gives additional options to create reverse iterators and to combine keys are ranges.
IterateReplicaKeySpans iterates over each of a range's key spans, and calls the given visitor with an iterator over its data.
MakeAllKeySpans returns all key spans for the given Range, in sorted order.
MakeAllKeySpanSet is similar to makeAllKeySpans, except it creates a SpanSet instead of a slice of spans.
MakeReplicatedKeySpans returns all key spans that are fully Raft replicated for the given Range, in lexicographically sorted order:
1.
MakeReplicatedKeySpanSet is similar to MakeReplicatedKeySpans, except it creates a SpanSet instead of a slice of spans.
MakeReplicatedKeySpansExcludingUser returns all key spans corresponding to non-user keys.
MakeReplicatedKeySpansUserOnly returns all key spans corresponding to user keys.
NewReplicaMVCCDataIterator creates a ReplicaMVCCDataIterator for the given replica.
Select returns a slice of disjoint sorted[^1] Spans describing all or a part of a Replica's keyspace, depending on the supplied SelectOpts.
# Constants
ReplicatedSpansAll includes all replicated spans, including user keys, range descriptors, and lock keys.
ReplicatedSpansExcludeLocks includes all replicated spans except for the lock table.
ReplicatedSpansExcludeUser includes all replicated spans except for user keys.
ReplicatedSpansLocksOnly includes just spans for the lock table, and no other replicated spans.
ReplicatedSpansUserOnly includes just user keys, and no other replicated spans.
# Variables
IterateReplicaKeySpansShared is a shared-replicate version of IterateReplicaKeySpans.
# Structs
IterateOptions instructs how points and ranges should be presented to visitor and if iterators should be visited in forward or reverse order.
ReplicaDataIteratorOptions defines ReplicaMVCCDataIterator creation options.
ReplicaMVCCDataIterator provides a complete iteration over MVCC or unversioned (which can be made to look like an MVCCKey) key / value rows in a range, including system-local metadata and user data.
SelectOpts configures which spans for a Replica to return from Select.
# Type aliases
ReplicatedSpansFilter is used to declare filters when selecting replicated spans.