Documentation ¶
Index ¶
- Constants
- Variables
- func AbortCacheKey(rangeID roachpb.RangeID, txnID uuid.UUID) roachpb.Key
- func Addr(k roachpb.Key) (roachpb.RKey, error)
- func AddrUpperBound(k roachpb.Key) (roachpb.RKey, error)
- func DecodeAbortCacheKey(key roachpb.Key, dest []byte) (uuid.UUID, error)
- func DecodeRangeIDKey(key roachpb.Key) (rangeID roachpb.RangeID, infix, suffix, detail roachpb.Key, err error)
- func DecodeRangeKey(key roachpb.Key) (startKey, suffix, detail roachpb.Key, err error)
- func DecodeTablePrefix(key roachpb.Key) ([]byte, uint64, error)
- func EnsureSafeSplitKey(key roachpb.Key) (roachpb.Key, error)
- func IsLocal(k roachpb.Key) bool
- func LeaseAppliedIndexKey(rangeID roachpb.RangeID) roachpb.Key
- func MakeFamilyKey(key []byte, famID uint32) []byte
- func MakeRangeIDPrefix(rangeID roachpb.RangeID) roachpb.Key
- func MakeRangeIDReplicatedKey(rangeID roachpb.RangeID, suffix, detail roachpb.RKey) roachpb.Key
- func MakeRangeIDReplicatedPrefix(rangeID roachpb.RangeID) roachpb.Key
- func MakeRangeIDUnreplicatedKey(rangeID roachpb.RangeID, suffix roachpb.RKey, detail roachpb.RKey) roachpb.Key
- func MakeRangeIDUnreplicatedPrefix(rangeID roachpb.RangeID) roachpb.Key
- func MakeRangeKey(key, suffix, detail roachpb.RKey) roachpb.Key
- func MakeRangeKeyPrefix(key roachpb.RKey) roachpb.Key
- func MakeRowSentinelKey(key []byte) []byte
- func MakeStoreKey(suffix, detail roachpb.RKey) roachpb.Key
- func MakeTablePrefix(tableID uint32) []byte
- func MassagePrettyPrintedSpanForTest(span string, dirs []encoding.Direction) string
- func MetaReverseScanBounds(key roachpb.RKey) (roachpb.Key, roachpb.Key, error)
- func MetaScanBounds(key roachpb.RKey) (roachpb.Key, roachpb.Key, error)
- func MustAddr(k roachpb.Key) roachpb.RKey
- func NodeLastUsageReportKey(nodeID roachpb.NodeID) roachpb.Key
- func NodeLivenessKey(nodeID roachpb.NodeID) roachpb.Key
- func NodeStatusKey(nodeID roachpb.NodeID) roachpb.Key
- func PrettyPrint(key roachpb.Key) string
- func PrettyPrintRange(b *bytes.Buffer, start, end roachpb.Key, maxChars int)
- func QueueLastProcessedKey(key roachpb.RKey, queue string) roachpb.Key
- func RaftAppliedIndexKey(rangeID roachpb.RangeID) roachpb.Key
- func RaftHardStateKey(rangeID roachpb.RangeID) roachpb.Key
- func RaftLastIndexKey(rangeID roachpb.RangeID) roachpb.Key
- func RaftLogKey(rangeID roachpb.RangeID, logIndex uint64) roachpb.Key
- func RaftLogPrefix(rangeID roachpb.RangeID) roachpb.Key
- func RaftTombstoneKey(rangeID roachpb.RangeID) roachpb.Key
- func RaftTruncatedStateKey(rangeID roachpb.RangeID) roachpb.Key
- func Range(ba roachpb.BatchRequest) (roachpb.RSpan, error)
- func RangeDescriptorKey(key roachpb.RKey) roachpb.Key
- func RangeFrozenStatusKey(rangeID roachpb.RangeID) roachpb.Key
- func RangeLastGCKey(rangeID roachpb.RangeID) roachpb.Key
- func RangeLastReplicaGCTimestampKey(rangeID roachpb.RangeID) roachpb.Key
- func RangeLastVerificationTimestampKeyDeprecated(rangeID roachpb.RangeID) roachpb.Key
- func RangeLeaseKey(rangeID roachpb.RangeID) roachpb.Key
- func RangeMetaKey(key roachpb.RKey) roachpb.Key
- func RangeReplicaDestroyedErrorKey(rangeID roachpb.RangeID) roachpb.Key
- func RangeStatsKey(rangeID roachpb.RangeID) roachpb.Key
- func RangeTxnSpanGCThresholdKey(rangeID roachpb.RangeID) roachpb.Key
- func StoreGossipKey() roachpb.Key
- func StoreIdentKey() roachpb.Key
- func TransactionKey(key roachpb.Key, txnID uuid.UUID) roachpb.Key
- func UglyPrint(input string) (_ roachpb.Key, rErr error)
- func UserKey(key roachpb.RKey) roachpb.RKey
- type InvalidRangeMetaKeyError
Constants ¶
const ( // MaxSystemConfigDescID is the maximum system descriptor ID that will be // gossiped as part of the SystemConfig. Be careful adding new descriptors to // this ID range. MaxSystemConfigDescID = 10 // MaxReservedDescID is the maximum value of reserved descriptor // IDs. Reserved IDs are used by namespaces and tables used internally by // cockroach. MaxReservedDescID = 49 // VirtualDescriptorID is the ID used by all virtual descriptors. VirtualDescriptorID = math.MaxUint32 // RootNamespaceID is the ID of the root namespace. RootNamespaceID = 0 // SystemDatabaseID and following are the database/table IDs for objects // in the system span. // NOTE: IDs must be <= MaxSystemConfigDescID. SystemDatabaseID = 1 NamespaceTableID = 2 DescriptorTableID = 3 UsersTableID = 4 ZonesTableID = 5 // Reserved IDs for other system tables. If you're adding a new system table, // it probably belongs here. // NOTE: IDs must be <= MaxReservedDescID. LeaseTableID = 11 EventLogTableID = 12 RangeEventTableID = 13 UITableID = 14 )
Various IDs used by the structured data layer. NOTE: these must not change during the lifetime of a cluster.
const SentinelFamilyID = 0
SentinelFamilyID indicates that MakeFamilyKey should make a sentinel key.
Variables ¶
var ( // LocalMax is the end of the local key range. It is itself a global // key. LocalMax = roachpb.Key{localMaxByte} // LocalRangeIDPrefix is the prefix identifying per-range data // indexed by Range ID. The Range ID is appended to this prefix, // encoded using EncodeUvarint. The specific sort of per-range // metadata is identified by one of the suffixes listed below, along // with potentially additional encoded key info, for instance in the // case of abort cache entry. // // NOTE: LocalRangeIDPrefix must be kept in sync with the value // in storage/engine/rocksdb/db.cc. LocalRangeIDPrefix = roachpb.RKey(makeKey(localPrefix, roachpb.Key("i"))) // LocalAbortCacheSuffix is the suffix for abort cache entries. The // abort cache protects a transaction from re-reading its own intents // after it's been aborted. LocalAbortCacheSuffix = []byte("abc-") // LocalRangeFrozenStatusSuffix is the suffix for a frozen status. LocalRangeFrozenStatusSuffix = []byte("fzn-") // LocalRangeLastGCSuffix is the suffix for the last GC. LocalRangeLastGCSuffix = []byte("lgc-") // LocalRaftAppliedIndexSuffix is the suffix for the raft applied index. LocalRaftAppliedIndexSuffix = []byte("rfta") // LocalRaftTombstoneSuffix is the suffix for the raft tombstone. LocalRaftTombstoneSuffix = []byte("rftb") // LocalRaftTruncatedStateSuffix is the suffix for the RaftTruncatedState. LocalRaftTruncatedStateSuffix = []byte("rftt") // LocalRangeLeaseSuffix is the suffix for a range lease. LocalRangeLeaseSuffix = []byte("rll-") // LocalLeaseAppliedIndexSuffix is the suffix for the applied lease index. LocalLeaseAppliedIndexSuffix = []byte("rlla") // LocalRangeStatsSuffix is the suffix for range statistics. LocalRangeStatsSuffix = []byte("stat") // LocalTxnSpanGCThresholdSuffix is the suffix for the last txn span GC's // threshold. LocalTxnSpanGCThresholdSuffix = []byte("tst-") // LocalRaftHardStateSuffix is the Suffix for the raft HardState. LocalRaftHardStateSuffix = []byte("rfth") // LocalRaftLastIndexSuffix is the suffix for raft's last index. LocalRaftLastIndexSuffix = []byte("rfti") // LocalRaftLogSuffix is the suffix for the raft log. LocalRaftLogSuffix = []byte("rftl") // LocalRangeLastReplicaGCTimestampSuffix is the suffix for a range's // last replica GC timestamp (for GC of old replicas). LocalRangeLastReplicaGCTimestampSuffix = []byte("rlrt") // LocalRangeLastVerificationTimestampSuffixDeprecated is the suffix for a range's // last verification timestamp (for checking integrity of on-disk data). // Note: DEPRECATED. LocalRangeLastVerificationTimestampSuffixDeprecated = []byte("rlvt") // LocalRangeReplicaDestroyedErrorSuffix is the suffix for a range's replica // destroyed error (for marking replicas as dead). LocalRangeReplicaDestroyedErrorSuffix = []byte("rrde") // LocalRangePrefix is the prefix identifying per-range data indexed // by range key (either start key, or some key in the range). The // key is appended to this prefix, encoded using EncodeBytes. The // specific sort of per-range metadata is identified by one of the // suffixes listed below, along with potentially additional encoded // key info, such as the txn ID in the case of a transaction record. // // NOTE: LocalRangePrefix must be kept in sync with the value in // storage/engine/rocksdb/db.cc. LocalRangePrefix = roachpb.Key(makeKey(localPrefix, roachpb.RKey("k"))) LocalRangeMax = LocalRangePrefix.PrefixEnd() // LocalRangeDescriptorSuffix is the suffix for keys storing // range descriptors. The value is a struct of type RangeDescriptor. LocalRangeDescriptorSuffix = roachpb.RKey("rdsc") // LocalTransactionSuffix specifies the key suffix for // transaction records. The additional detail is the transaction id. // NOTE: if this value changes, it must be updated in C++ // (storage/engine/rocksdb/db.cc). LocalTransactionSuffix = roachpb.RKey("txn-") // LocalQueueLastProcessedSuffix is the suffix for replica queue state keys. LocalQueueLastProcessedSuffix = roachpb.RKey("qlpt") // Meta1Prefix is the first level of key addressing. It is selected such that // all range addressing records sort before any system tables which they // might describe. The value is a RangeDescriptor struct. Meta1Prefix = roachpb.Key{meta1PrefixByte} // Meta2Prefix is the second level of key addressing. The value is a // RangeDescriptor struct. Meta2Prefix = roachpb.Key{meta2PrefixByte} // Meta1KeyMax is the end of the range of the first level of key addressing. // The value is a RangeDescriptor struct. Meta1KeyMax = roachpb.Key(makeKey(Meta1Prefix, roachpb.RKeyMax)) // Meta2KeyMax is the end of the range of the second level of key addressing. // The value is a RangeDescriptor struct. Meta2KeyMax = roachpb.Key(makeKey(Meta2Prefix, roachpb.RKeyMax)) // MetaMin is the start of the range of addressing keys. MetaMin = Meta1Prefix // MetaMax is the end of the range of addressing keys. MetaMax = roachpb.Key{metaMaxByte} // SystemPrefix indicates the beginning of the key range for // global, system data which are replicated across the cluster. SystemPrefix = roachpb.Key{systemPrefixByte} SystemMax = roachpb.Key{systemMaxByte} // MigrationPrefix specifies the key prefix to store all migration details. MigrationPrefix = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("system-version/"))) // MigrationKeyMax is the maximum value for any system migration key. MigrationKeyMax = MigrationPrefix.PrefixEnd() // MigrationLease is the key that nodes must take a lease on in order to run // system migrations on the cluster. MigrationLease = roachpb.Key(makeKey(MigrationPrefix, roachpb.RKey("lease"))) // NodeLivenessPrefix specifies the key prefix for the node liveness // table. Note that this should sort before the rest of the system // keyspace in order to limit the number of ranges which must use // expiration-based range leases instead of the more efficient // node-liveness epoch-based range leases (see // https://github.com/cockroachdb/cockroach/blob/master/docs/RFCS/range_leases.md) NodeLivenessPrefix = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("\x00liveness-"))) // NodeLivenessKeyMax is the maximum value for any node liveness key. NodeLivenessKeyMax = NodeLivenessPrefix.PrefixEnd() // DescIDGenerator is the global descriptor ID generator sequence used for // table and namespace IDs. DescIDGenerator = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("desc-idgen"))) // NodeIDGenerator is the global node ID generator sequence. NodeIDGenerator = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("node-idgen"))) // RangeIDGenerator is the global range ID generator sequence. RangeIDGenerator = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("range-idgen"))) // StoreIDGenerator is the global store ID generator sequence. StoreIDGenerator = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("store-idgen"))) // StatusPrefix specifies the key prefix to store all status details. StatusPrefix = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("status-"))) // StatusNodePrefix stores all status info for nodes. StatusNodePrefix = roachpb.Key(makeKey(StatusPrefix, roachpb.RKey("node-"))) // TimeseriesPrefix is the key prefix for all timeseries data. TimeseriesPrefix = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("tsd"))) // UpdateCheckPrefix is the key prefix for all update check times. UpdateCheckPrefix = roachpb.Key(makeKey(SystemPrefix, roachpb.RKey("update-"))) UpdateCheckCluster = roachpb.Key(makeKey(UpdateCheckPrefix, roachpb.RKey("cluster"))) // TableDataMin is the start of the range of table data keys. TableDataMin = roachpb.Key(encoding.EncodeVarintAscending(nil, math.MinInt64)) // TableDataMin is the end of the range of table data keys. TableDataMax = roachpb.Key(encoding.EncodeVarintAscending(nil, math.MaxInt64)) // SystemConfigTableDataMax is the end key of system config structured data. SystemConfigTableDataMax = roachpb.Key(MakeTablePrefix(MaxSystemConfigDescID + 1)) // UserTableDataMin is the start key of user structured data. UserTableDataMin = roachpb.Key(MakeTablePrefix(MaxReservedDescID + 1)) // MaxKey is the infinity marker which is larger than any other key. MaxKey = roachpb.KeyMax // MinKey is a minimum key value which sorts before all other keys. MinKey = roachpb.KeyMin )
Constants for system-reserved keys in the KV map.
Note: preserve group-wise ordering when adding new constants.
var ( // Meta1Span holds all first level addressing. Meta1Span = roachpb.Span{Key: roachpb.KeyMin, EndKey: Meta2Prefix} // NodeLivenessSpan holds the liveness records for nodes in the cluster. NodeLivenessSpan = roachpb.Span{Key: NodeLivenessPrefix, EndKey: NodeLivenessKeyMax} // SystemConfigSpan is the range of system objects which will be gossiped. SystemConfigSpan = roachpb.Span{Key: TableDataMin, EndKey: SystemConfigTableDataMax} // UserDataSpan is the non-meta and non-structured portion of the key space. UserDataSpan = roachpb.Span{Key: SystemMax, EndKey: TableDataMin} // GossipedSystemSpans are spans which contain system data which needs to be // shared with other nodes in the system via gossip. GossipedSystemSpans = []roachpb.Span{NodeLivenessSpan, SystemConfigSpan} // NoSplitSpans describes the ranges that should never be split. // Meta1Span: needed to find other ranges. // NodeLivenessSpan: liveness information on nodes in the cluster. // SystemConfigSpan: system objects which will be gossiped. NoSplitSpans = []roachpb.Span{Meta1Span, NodeLivenessSpan, SystemConfigSpan} )
var PrettyPrintTimeseriesKey func(key roachpb.Key) string
PrettyPrintTimeseriesKey is a hook for pretty printing a timeseries key. The timeseries key prefix will already have been stripped off.
Functions ¶
func AbortCacheKey ¶
AbortCacheKey returns a range-local key by Range ID for an abort cache entry, with detail specified by encoding the supplied transaction ID.
func Addr ¶
Addr returns the address for the key, used to lookup the range containing the key. In the normal case, this is simply the key's value. However, for local keys, such as transaction records, range-spanning binary tree node pointers, the address is the inner encoded key, with the local key prefix and the suffix and optional detail removed. This address unwrapping is performed repeatedly in the case of doubly-local keys. In this way, local keys address to the same range as non-local keys, but are stored separately so that they don't collide with user-space or global system keys.
However, not all local keys are addressable in the global map. Only range local keys incorporating a range key (start key or transaction key) are addressable (e.g. range metadata and txn records). Range local keys incorporating the Range ID are not (e.g. abort cache entries, and range stats).
func AddrUpperBound ¶
AddrUpperBound returns the address for the key, used to lookup the range containing the key. However, unlike Addr, it will return the following key that local range keys address to. This is necessary because range-local keys exist conceptually in the space between regular keys. Addr() returns the regular key that is just to the left of a range-local key, which is guaranteed to be located on the same range. AddrUpperBound() returns the regular key that is just to the right, which may not be on the same range but is suitable for use as the EndKey of a span involving a range-local key.
func DecodeAbortCacheKey ¶
DecodeAbortCacheKey decodes the provided abort cache entry, returning the transaction ID.
func DecodeRangeIDKey ¶
func DecodeRangeIDKey( key roachpb.Key, ) (rangeID roachpb.RangeID, infix, suffix, detail roachpb.Key, err error)
DecodeRangeIDKey parses a local range ID key into range ID, infix, suffix, and detail.
func DecodeRangeKey ¶
DecodeRangeKey decodes the range key into range start key, suffix and optional detail (may be nil).
func DecodeTablePrefix ¶
DecodeTablePrefix validates that the given key has a table prefix, returning the remainder of the key (with the prefix removed) and the decoded descriptor ID of the table.
func EnsureSafeSplitKey ¶
EnsureSafeSplitKey transforms an SQL table key such that it is a valid split key (i.e. does not occur in the middle of a row).
func IsLocal ¶
IsLocal performs a cheap check that returns true iff a range-local key is passed, that is, a key for which `Addr` would return a non-identical RKey (or a decoding error).
TODO(tschottdorf): we need a better name for these keys as only some of them are local and it's been identified as an area that is not understood by many of the team's developers. An obvious suggestion is "system" (as opposed to "user") keys, but unfortunately that name has already been claimed by a related (but not identical) concept.
func LeaseAppliedIndexKey ¶
LeaseAppliedIndexKey returns a system-local key for a lease applied index.
func MakeFamilyKey ¶
MakeFamilyKey returns the key for the family in the given row by appending to the passed key. If SentinelFamilyID is passed, a sentinel key (which is the first key in a sql table row) is returned.
func MakeRangeIDPrefix ¶
MakeRangeIDPrefix creates a range-local key prefix from rangeID for both replicated and unreplicated data.
func MakeRangeIDReplicatedKey ¶
MakeRangeIDReplicatedKey creates a range-local key based on the range's Range ID, metadata key suffix, and optional detail.
func MakeRangeIDReplicatedPrefix ¶
MakeRangeIDReplicatedPrefix creates a range-local key prefix from rangeID for all Raft replicated data.
func MakeRangeIDUnreplicatedKey ¶
func MakeRangeIDUnreplicatedKey( rangeID roachpb.RangeID, suffix roachpb.RKey, detail roachpb.RKey, ) roachpb.Key
MakeRangeIDUnreplicatedKey creates a range-local unreplicated key based on the range's Range ID, metadata key suffix, and optional detail.
func MakeRangeIDUnreplicatedPrefix ¶
MakeRangeIDUnreplicatedPrefix creates a range-local key prefix from rangeID for all unreplicated data.
func MakeRangeKey ¶
MakeRangeKey creates a range-local key based on the range start key, metadata key suffix, and optional detail (e.g. the transaction ID for a txn record, etc.).
func MakeRangeKeyPrefix ¶
MakeRangeKeyPrefix creates a key prefix under which all range-local keys can be found.
func MakeRowSentinelKey ¶
MakeRowSentinelKey creates the first key in a sql table row.
func MakeStoreKey ¶
MakeStoreKey creates a store-local key based on the metadata key suffix, and optional detail.
func MakeTablePrefix ¶
MakeTablePrefix returns the key prefix used for the table's data.
func MassagePrettyPrintedSpanForTest ¶
MassagePrettyPrintedSpanForTest does some transformations on pretty-printed spans and keys: - if dirs is not nil, replace all ints with their ones' complement for descendingly-encoded columns. - strips line numbers from error messages.
func MetaReverseScanBounds ¶
MetaReverseScanBounds returns the range [start,end) within which the desired meta record can be found by means of a reverse engine scan. The given key must be a valid RangeMetaKey as defined by validateRangeMetaKey.
func MetaScanBounds ¶
MetaScanBounds returns the range [start,end) within which the desired meta record can be found by means of an engine scan. The given key must be a valid RangeMetaKey as defined by validateRangeMetaKey. TODO(tschottdorf): a lot of casting going on inside.
func NodeLastUsageReportKey ¶
NodeLastUsageReportKey returns the key for accessing the node last update check time (when version check or usage reporting was done).
func NodeLivenessKey ¶
NodeLivenessKey returns the key for the node liveness record.
func NodeStatusKey ¶
NodeStatusKey returns the key for accessing the node status for the specified node ID.
func PrettyPrint ¶
PrettyPrint prints the key in a human readable format:
Key's Format Key's Value /Local/... "\x01"+...
/Store/... "\x01s"+... /RangeID/... "\x01s"+[rangeid] /[rangeid]/AbortCache/[id] "\x01s"+[rangeid]+"abc-"+[id] /[rangeid]/Lease "\x01s"+[rangeid]+"rfll" /[rangeid]/RaftTombstone "\x01s"+[rangeid]+"rftb" /[rangeid]/RaftHardState "\x01s"+[rangeid]+"rfth" /[rangeid]/RaftAppliedIndex "\x01s"+[rangeid]+"rfta" /[rangeid]/RaftLog/logIndex:[logIndex] "\x01s"+[rangeid]+"rftl"+[logIndex] /[rangeid]/RaftTruncatedState "\x01s"+[rangeid]+"rftt" /[rangeid]/RaftLastIndex "\x01s"+[rangeid]+"rfti" /[rangeid]/RangeLastReplicaGCTimestamp "\x01s"+[rangeid]+"rlrt" /[rangeid]/RangeLastVerificationTimestamp "\x01s"+[rangeid]+"rlvt" /[rangeid]/RangeStats "\x01s"+[rangeid]+"stat" /Range/... "\x01k"+... /RangeDescriptor/[key] "\x01k"+[key]+"rdsc" /Transaction/addrKey:[key]/id:[id] "\x01k"+[key]+"txn-"+[txn-id] /QueueLastProcessed/addrKey:[key]/id:[queue] "\x01k"+[key]+"qlpt"+[queue]
/Local/Max "\x02"
/Meta1/[key] "\x02"+[key] /Meta2/[key] "\x03"+[key] /System/... "\x04"
/NodeLiveness/[key] "\x04\0x00liveness-"+[key] /StatusNode/[key] "\x04status-node-"+[key]
/System/Max "\x05"
/Table/[key] [key]
/Min "" /Max "\xff\xff"
func PrettyPrintRange ¶
PrettyPrintRange pretty prints a compact representation of a key range. The output is of the form:
commonPrefix{remainingStart-remainingEnd}
It prints at most maxChars, truncating components as needed. See TestPrettyPrintRange for some examples.
func QueueLastProcessedKey ¶
QueueLastProcessedKey returns a range-local key for last processed timestamps for the named queue. These keys represent per-range last processed times.
func RaftAppliedIndexKey ¶
RaftAppliedIndexKey returns a system-local key for a raft applied index.
func RaftHardStateKey ¶
RaftHardStateKey returns a system-local key for a Raft HardState.
func RaftLastIndexKey ¶
RaftLastIndexKey returns a system-local key for the last index of the Raft log.
func RaftLogKey ¶
RaftLogKey returns a system-local key for a Raft log entry.
func RaftLogPrefix ¶
RaftLogPrefix returns the system-local prefix shared by all entries in a Raft log.
func RaftTombstoneKey ¶
RaftTombstoneKey returns a system-local key for a raft tombstone.
func RaftTruncatedStateKey ¶
RaftTruncatedStateKey returns a system-local key for a RaftTruncatedState.
func Range ¶
func Range(ba roachpb.BatchRequest) (roachpb.RSpan, error)
Range returns a key range encompassing all the keys in the Batch.
func RangeDescriptorKey ¶
RangeDescriptorKey returns a range-local key for the descriptor for the range with specified key.
func RangeFrozenStatusKey ¶
RangeFrozenStatusKey returns a system-local key for the frozen status.
func RangeLastGCKey ¶
RangeLastGCKey returns a system-local key for the last GC.
func RangeLastReplicaGCTimestampKey ¶
RangeLastReplicaGCTimestampKey returns a range-local key for the range's last replica GC timestamp.
func RangeLastVerificationTimestampKeyDeprecated ¶
RangeLastVerificationTimestampKeyDeprecated returns a range-local key for the range's last verification timestamp.
func RangeLeaseKey ¶
RangeLeaseKey returns a system-local key for a range lease.
func RangeMetaKey ¶
RangeMetaKey returns a range metadata (meta1, meta2) indexing key for the given key.
- For RKeyMin, KeyMin is returned. - For a meta1 key, KeyMin is returned. - For a meta2 key, a meta1 key is returned. - For an ordinary key, a meta2 key is returned.
func RangeReplicaDestroyedErrorKey ¶
RangeReplicaDestroyedErrorKey returns a range-local key for the range's replica destroyed error.
func RangeStatsKey ¶
RangeStatsKey returns the key for accessing the MVCCStats struct for the specified Range ID.
func RangeTxnSpanGCThresholdKey ¶
RangeTxnSpanGCThresholdKey returns a system-local key for last used GC threshold on the txn span.
func StoreGossipKey ¶
StoreGossipKey returns a store-local key for the gossip bootstrap metadata.
func StoreIdentKey ¶
StoreIdentKey returns a store-local key for the store metadata.
func TransactionKey ¶
TransactionKey returns a transaction key based on the provided transaction key and ID. The base key is encoded in order to guarantee that all transaction records for a range sort together.
func UglyPrint ¶
UglyPrint is a partial right inverse to PrettyPrint: it takes a key formatted for human consumption and attempts to translate it into a roachpb.Key. Not all key types are supported and no optimization has been performed. This is intended for use in debugging only.
Types ¶
type InvalidRangeMetaKeyError ¶
InvalidRangeMetaKeyError indicates that a Range Metadata key is somehow invalid.
func NewInvalidRangeMetaKeyError ¶
func NewInvalidRangeMetaKeyError(msg string, k []byte) *InvalidRangeMetaKeyError
NewInvalidRangeMetaKeyError returns a new InvalidRangeMetaKeyError
func (*InvalidRangeMetaKeyError) Error ¶
func (i *InvalidRangeMetaKeyError) Error() string
Error formats error string.