kv

Documentation

Index

• Variables
• type Coordinate
  • func NewCoordinator(txm Transactional, r *raft.Raft) *Coordinate
  • func (c *Coordinate) Dispatch(reqs *OperationGroup[OP]) (*CoordinateResponse, error)
  • func (c *Coordinate) IsLeader() bool
• type CoordinateResponse
• type Coordinator
• type Elem
• type FSM
  • func NewKvFSM(store store.Store, lockStore store.TTLStore) FSM
• type OP
• type OperationGroup
• type TransactionManager
  • func NewTransaction(raft *raft.Raft) *TransactionManager
  • func (t *TransactionManager) Abort(reqs []*pb.Request) (*TransactionResponse, error)
  • func (t *TransactionManager) Commit(reqs []*pb.Request) (*TransactionResponse, error)
• type TransactionResponse
• type Transactional

Variables

var ErrInvalidRequest = errors.New("invalid request")

var ErrKeyAlreadyLocked = errors.New("key already locked")

var ErrKeyNotLocked = errors.New("key not locked")

var ErrNotImplemented = errors.New("not implemented")

var ErrUnknownRequestType = errors.New("unknown request type")

Types

type Coordinate

type Coordinate struct {
	// contains filtered or unexported fields
}

func NewCoordinator

func NewCoordinator(txm Transactional, r *raft.Raft) *Coordinate

func (*Coordinate) Dispatch

func (c *Coordinate) Dispatch(reqs *OperationGroup[OP]) (*CoordinateResponse, error)

func (*Coordinate) IsLeader

func (c *Coordinate) IsLeader() bool

type CoordinateResponse

type CoordinateResponse struct {
	CommitIndex uint64
}

type Coordinator

type Coordinator interface {
	Dispatch(reqs *OperationGroup[OP]) (*CoordinateResponse, error)
	IsLeader() bool
}

type Elem

type Elem[T OP] struct {
	Op    T
	Key   []byte
	Value []byte
}

Elem is an element of a transaction.

type FSM

type FSM interface {
	raft.FSM
}

func NewKvFSM

func NewKvFSM(store store.Store, lockStore store.TTLStore) FSM

type OP

type OP int

OP is an operation type.

const (
	Put OP = iota
	Del
)

Operation types.

type OperationGroup

type OperationGroup[T OP] struct {
	Elems []*Elem[T]
	IsTxn bool
}

OperationGroup is a group of operations that should be executed atomically.

type TransactionManager

type TransactionManager struct {
	// contains filtered or unexported fields
}

func NewTransaction

func NewTransaction(raft *raft.Raft) *TransactionManager

func (*TransactionManager) Abort

func (t *TransactionManager) Abort(reqs []*pb.Request) (*TransactionResponse, error)

func (*TransactionManager) Commit

func (t *TransactionManager) Commit(reqs []*pb.Request) (*TransactionResponse, error)

type TransactionResponse

type TransactionResponse struct {
	CommitIndex uint64
}

type Transactional

type Transactional interface {
	Commit(reqs []*pb.Request) (*TransactionResponse, error)
	Abort(reqs []*pb.Request) (*TransactionResponse, error)
}