keys

Documentation

Index

• Variables
• func DataKey(logTerm, logIndex uint64) multiraftbase.Key
• func GroupDescriptorKey(groupID multiraftbase.GroupID) multiraftbase.Key
• func GroupStatusKey(groupID multiraftbase.GroupID) multiraftbase.Key
• func MakeGroupIDPrefix(groupID multiraftbase.GroupID) multiraftbase.Key
• func MakeGroupIDUnreplicatedPrefix(groupID multiraftbase.GroupID) multiraftbase.Key
• func RaftLogKey(groupID multiraftbase.GroupID, logIndex uint64) multiraftbase.Key
• type GroupIDPrefixBuf
  • func MakeGroupIDPrefixBuf(groupID multiraftbase.GroupID) GroupIDPrefixBuf
  • func (b GroupIDPrefixBuf) GroupReplicaDestroyedErrorKey() multiraftbase.Key
  • func (b GroupIDPrefixBuf) RaftAppliedIndexKey() multiraftbase.Key
  • func (b GroupIDPrefixBuf) RaftHardStateKey() multiraftbase.Key
  • func (b GroupIDPrefixBuf) RaftLastIndexKey() multiraftbase.Key
  • func (b GroupIDPrefixBuf) RaftLogKey(logIndex uint64) multiraftbase.Key
  • func (b GroupIDPrefixBuf) RaftLogPrefix() multiraftbase.Key
  • func (b GroupIDPrefixBuf) RaftTruncatedStateKey() multiraftbase.Key

Variables

var (

	// LocalRaftAppliedIndexSuffix is the suffix for the raft applied index.
	LocalRaftAppliedIndexSuffix = []byte("rfta")

	LocalGroupReplicaMembersSuffix = []byte("g")

	LocalGroupReplicaDestroyedErrorSuffix = []byte("rrde")

	LocalRaftLastIndexSuffix = []byte("rfti")

	LocalRaftTruncatedStateSuffix = []byte("rftt")

	LocalRaftHardStateSuffix = []byte("rfth")

	LocalRaftLogSuffix = []byte("rftl")

	LocalGroupIDPrefix = multiraftbase.RKey(makeKey(localPrefix, multiraftbase.Key("i")))
)

Functions

func DataKey

func DataKey(logTerm, logIndex uint64) multiraftbase.Key

func GroupDescriptorKey

func GroupDescriptorKey(groupID multiraftbase.GroupID) multiraftbase.Key

GroupDescriptorKey returns a range-local key for the descriptor for the range with specified key.

func GroupStatusKey

func GroupStatusKey(groupID multiraftbase.GroupID) multiraftbase.Key

func MakeGroupIDPrefix

func MakeGroupIDPrefix(groupID multiraftbase.GroupID) multiraftbase.Key

MakeGroupIDPrefix creates a range-local key prefix from rangeID for both replicated and unreplicated data.

func MakeGroupIDUnreplicatedPrefix

func MakeGroupIDUnreplicatedPrefix(groupID multiraftbase.GroupID) multiraftbase.Key

MakeRangeIDUnreplicatedPrefix creates a range-local key prefix from rangeID for all unreplicated data.

func RaftLogKey

func RaftLogKey(groupID multiraftbase.GroupID, logIndex uint64) multiraftbase.Key

RaftLogKey returns a system-local key for a Raft log entry.

Types

type GroupIDPrefixBuf

type GroupIDPrefixBuf multiraftbase.Key

GroupIDPrefixBuf provides methods for generating range ID local keys while avoiding an allocation on every key generated. The generated keys are only valid until the next call to one of the key generation methods.

func MakeGroupIDPrefixBuf

func MakeGroupIDPrefixBuf(groupID multiraftbase.GroupID) GroupIDPrefixBuf

MakeRangeIDPrefixBuf creates a new range ID prefix buf suitable for generating the various range ID local keys.

func (GroupIDPrefixBuf) GroupReplicaDestroyedErrorKey

func (b GroupIDPrefixBuf) GroupReplicaDestroyedErrorKey() multiraftbase.Key

RangeReplicaDestroyedErrorKey returns a range-local key for the range's replica destroyed error.

func (GroupIDPrefixBuf) RaftAppliedIndexKey

func (b GroupIDPrefixBuf) RaftAppliedIndexKey() multiraftbase.Key

RaftAppliedIndexKey returns a system-local key for a raft applied index.

func (GroupIDPrefixBuf) RaftHardStateKey

func (b GroupIDPrefixBuf) RaftHardStateKey() multiraftbase.Key

RaftHardStateKey returns a system-local key for a Raft HardState.

func (GroupIDPrefixBuf) RaftLastIndexKey

func (b GroupIDPrefixBuf) RaftLastIndexKey() multiraftbase.Key

RaftLastIndexKey returns a system-local key for the last index of the Raft log.

func (GroupIDPrefixBuf) RaftLogKey

func (b GroupIDPrefixBuf) RaftLogKey(logIndex uint64) multiraftbase.Key

RaftLogKey returns a system-local key for a Raft log entry.

func (GroupIDPrefixBuf) RaftLogPrefix

func (b GroupIDPrefixBuf) RaftLogPrefix() multiraftbase.Key

RaftLogPrefix returns the system-local prefix shared by all entries in a Raft log.

func (GroupIDPrefixBuf) RaftTruncatedStateKey

func (b GroupIDPrefixBuf) RaftTruncatedStateKey() multiraftbase.Key

RaftTruncatedStateKey returns a system-local key for a RaftTruncatedState.