state

Documentation

Overview

Package state contains the resources required to create a state store.

Index

• Variables
• type CommitState
• type Store

Variables

var (
	// ErrorStateIsEmpty is returned when a state is empty.
	ErrorStateIsEmpty error = errors.New("the state is empty")
	// ErrorCanNotReadState is returned when a state cannot be read.
	ErrorCanNotReadState error = errors.New("the state is could not be read")
	// ErrorCanNotWriteState is returned when a state cannot be written.
	ErrorCanNotWriteState error = errors.New("the state is could not be written")
)

Types

type CommitState

type CommitState struct {
	// Version of the commit
	Version int64 `json:"version"`
}

CommitState stores an attempt to `source` into `destination` and `version` for the latest commit.

type Store

type Store interface {
	// GetData() retrieves the data cached in the lock.
	// for a DeltaTable, the data will contain the current or prior locked commit version.
	Get() (CommitState, error)

	// GetData() retrieves the data cached in the lock.
	// for a DeltaTable, the data will contain the current or prior locked commit version.
	Put(CommitState) error
}

Store provides remote state storage for fast lookup on the current commit version.