package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
CheckForcedErr determines whether or not a command should be applied to the replicated state machine after it has been committed to the Raft log.
ContainsKey returns whether this range contains the specified key.
ContainsKeyRange returns whether this range contains the specified key range from start to end.
IntersectSpan takes an span and a descriptor.
LimitBulkIOWrite blocks until the provided limiter permits the specified cost to happen.
NewDuplicateKeyError constructs a DuplicateKeyError, copying its input.
WriteFileSyncing is essentially os.WriteFile -- writes data to a file named by filename -- but with rate limiting and periodic fsyncing controlled by settings and the passed limiter (should be the store's limiter).
# Constants
512 KB.
64 MB.
4 MB.
ProposalRejectionIllegalLeaseIndex indicates the proposal failed to apply as the assigned lease index had been consumed, and it is known that this proposal had not applied previously.
ProposalRejectionPermanent indicates that the rejection is permanent.
# Variables
ConsistencyQueueEnabled is a setting that controls whether the consistency queue is enabled.
LeaseQueueEnabled is a setting that controls whether the lease queue is enabled.
MaxCommandSize wraps "kv.raft.command.max_size".
MergeQueueEnabled is a setting that controls whether the merge queue is enabled.
MVCCGCQueueEnabled is a setting that controls whether the MVCC GC queue is enabled.
NoopOnProbeCommandErr is returned from CheckForcedErr when a raft command corresponding to a ProbeRequest is handled.
RaftLogQueueEnabled is a setting that controls whether the raft log queue is enabled.
RaftSnapshotQueueEnabled is a setting that controls whether the raft snapshot queue is enabled.
RangeFeedRefreshInterval is injected from kvserver to avoid import cycles when accessed from kvcoord.
ReplicaGCQueueEnabled is a setting that controls whether the replica GC queue is enabled.
ReplicateQueueEnabled is a setting that controls whether the replicate queue is enabled.
SplitByLoadMergeDelay wraps "kv.range_split.by_load_merge_delay".
SplitQueueEnabled is a setting that controls whether the split queue is enabled.
TimeSeriesMaintenanceQueueEnabled is a setting that controls whether the timeseries maintenance queue is enabled.
# Structs
ApplyFilterArgs groups the arguments to a ReplicaApplyFilter.
BatchEvalTestingKnobs contains testing helpers that are used during batch evaluation.
BulkAdderOptions is used to configure the behavior of a BulkAdder.
DuplicateKeyError represents a failed attempt to ingest the same key twice using a BulkAdder within the same batch.
FilterArgs groups the arguments to a ReplicaCommandFilter.
ForcedErrResult is the output from CheckForcedErr.
IntentResolverTestingKnobs contains testing helpers that are used during intent resolution.
ProposalFilterArgs groups the arguments to ReplicaProposalFilter.
UnsupportedStoresIterator is a StoresIterator that only returns "unsupported" errors.
# Interfaces
BulkAdder describes a bulk-adding helper that can be used to add lots of KVs.
Store is an adapter to the underlying KV store.
StoresIterator is able to iterate over all stores on a given node.
# Type aliases
BulkAdderFactory describes a factory function for BulkAdders.
CmdIDKey is a Raft command id.
ProposalRejectionType indicates how to handle a proposal that was rejected below raft (e.g.
A ReplicaApplyFilter is a testing hook into raft command application.
ReplicaCommandFilter may be used in tests through the StoreTestingKnobs to intercept the handling of commands and artificially generate errors.
ReplicaConcurrencyRetryFilter can be used to examine a concurrency retry error before it is handled and its batch is re-evaluated.
ReplicaProposalFilter can be used in testing to influence the error returned from proposals after a request is evaluated but before it is proposed.
ReplicaRangefeedFilter is used in unit tests to modify the request, inject responses, or return errors from rangefeeds.
ReplicaRequestFilter can be used in testing to influence the error returned from a request before it is evaluated.
ReplicaResponseFilter is used in unittests to modify the outbound response returned to a waiting client after a replica command has been processed.