# Packages
Package enginepb is a generated protocol buffer package.
# Functions
AccountForSelf adjusts ms to account for the predicted impact it will have on the values that it records when the structure is initially stored.
AllocIterKeyValue returns iter.Key() and iter.Value() with the underlying storage allocated from the passed ChunkAllocator.
ComputeStatsGo scans the underlying engine from start to end keys and computes stats counters based on the values.
DecodeKey decodes an engine.MVCCKey from its serialized representation.
EncodeKey encodes an engine.MVCC key into the RocksDB representation.
GetIterAndBuf returns a IterAndBuf for passing into various MVCC* methods.
IsIntentOf returns true if the meta record is an intent of the supplied transaction.
IsValidSplitKey returns whether the key is a valid split key.
MakeGarbageCollector allocates and returns a new GC, with expiration computed based on current time and policy.TTLSeconds.
MakeMVCCMetadataKey creates an MVCCKey from a roachpb.Key.
MakeValue returns the inline value.
MergeInternalTimeSeriesData exports the engine's C++ merge logic for InternalTimeSeriesData to higher level packages.
MVCCBlindConditionalPut is a fast-path of MVCCConditionalPut.
MVCCBlindInitPut is a fast-path of MVCCInitPut.
MVCCBlindPut is a fast-path of MVCCPut.
MVCCConditionalPut sets the value for a specified key only if the expected value matches.
MVCCDelete marks the key deleted so that it will not be returned in future get responses.
MVCCDeleteRange deletes the range of key/value pairs specified by start and end keys.
MVCCFindSplitKey suggests a split key from the given user-space key range that aims to roughly cut into half the total number of bytes used (in raw key and value byte strings) in both subranges.
MVCCGarbageCollect creates an iterator on the engine.
MVCCGet returns the value for the key specified in the request, while satisfying the given timestamp condition.
MVCCGetAsTxn constructs a temporary Transaction from the given txn metadata and calls MVCCGet as that transaction.
MVCCGetProto fetches the value at the specified key and unmarshals it into msg if msg is non-nil.
MVCCGetRangeStats reads stat counters for the specified range and sets the values in the enginepb.MVCCStats struct.
MVCCIncrement fetches the value for key, and assuming the value is an "integer" type, increments it by inc and stores the new value.
MVCCInitPut sets the value for a specified key if the key doesn't exist.
MVCCIterate iterates over the key range [start,end).
MVCCMerge implements a merge operation.
MVCCPut sets the value for a specified key.
MVCCPutProto sets the given key to the protobuf-serialized byte string of msg and the provided timestamp.
MVCCResolveWriteIntent either commits or aborts (rolls back) an extant write intent for a given txn according to commit parameter.
MVCCResolveWriteIntentRange commits or aborts (rolls back) the range of write intents specified by start and end keys for a given txn.
MVCCResolveWriteIntentRangeUsingIter commits or aborts (rolls back) the range of write intents specified by start and end keys for a given txn.
MVCCResolveWriteIntentUsingIter is a variant of MVCCResolveWriteIntent that uses iterator and buffer passed as parameters (e.g.
MVCCReverseScan scans the key range [start,end) key up to some maximum number of results in descending order.
MVCCScan scans the key range [start,end) key up to some maximum number of results in ascending order.
MVCCSetRangeStats sets stat counters for specified range.
NewInMem allocates and returns a new, opened InMem engine.
NewRocksDBBatchReader creates a RocksDBBatchReader from the given repr and verifies the header.
NewRocksDBMap creates a new RocksDBMap with the passed in Engine as the underlying store.
NewRocksDBMultiMap creates a new RocksDBMap with the passed in Engine as the underlying store.
NewTempEngine creates a new engine for DistSQL processors to use when the working set is larger than can be stored in memory.
PutProto sets the given key to the protobuf-serialized byte string of msg and the provided timestamp.
RocksDBBatchCount provides an efficient way to get the count of mutations in a RocksDB Batch representation.
Scan returns up to max key/value objects starting from start (inclusive) and ending at end (non-inclusive).
SplitMVCCKey returns the key and timestamp components of an encoded MVCC key.
# Constants
These constants come from rocksdb/db/dbformat.h.
These constants come from rocksdb/db/dbformat.h.
These constants come from rocksdb/db/dbformat.h.
# Variables
MVCCKeyMax is a maximum mvcc-encoded key value which sorts after all other keys.`.
NilKey is the nil MVCCKey.
# Structs
GarbageCollector GCs MVCC key/values using a zone-specific GC policy allows either the union or intersection of maximum # of versions and maximum age.
InMem wraps RocksDB and configures it for in-memory only storage.
IterAndBuf used to pass iterators and buffers between MVCC* calls, allowing reuse without the callers needing to know the particulars.
MVCCKey is a versioned key, distinguished from roachpb.Key with the addition of a timestamp.
MVCCKeyValue contains the raw bytes of the value for a key.
RocksDBBatchBuilder is used to construct the RocksDB batch representation.
RocksDBBatchReader is used to iterate the entries in a RocksDB batch representation.
RocksDBMap is a SortedDiskMap that uses RocksDB as its underlying storage engine.
RocksDBMapBatchWriter batches writes to a RocksDBMap.
RocksDBMapIterator iterates over the keys of a RocksDBMap in sorted order.
Stats is a set of RocksDB stats.
Version stores all the version information for all stores and is used as the format for the version file.
# Interfaces
Batch is the interface for batch specific operations.
Engine is the interface that wraps the core operations of a key/value store.
Iterator is an interface for iterating over key/value pairs in an engine.
Reader is the read interface to an engine's data.
ReadWriter is the read/write interface to an engine's data.
SimpleIterator is an interface for iterating over key/value pairs in an engine.
SortedDiskMap is an on-disk map.
SortedDiskMapBatchWriter batches writes to a SortedDiskMap.
SortedDiskMapIterator is a simple iterator used to iterate over keys and/or values.
Writer is the write interface to an engine's data.
# Type aliases
BatchType represents the type of an entry in an encoded RocksDB batch.