tapedb

README

tapedb

Embbeded database for Go programs

Project

The implementation was provided by simia.tech GmbH.

License

The project is licensed under Apache 2.0 (see LICENSE file).

Documentation

Index

• Constants
• Variables
• func GenerateUUID() string
• type Base
• type Change
• type Database
• type Factory
• type State

Constants

const (
	FileNameDatabase    = "db"
	FileNameNewDatabase = "db.new"
	FilePrefixPayload   = "payload-"

	HeaderNonce = "Nonce"
)

Variables

var (
	ErrUnknownChangeType = errors.New("unknown change type")
)

Functions

func GenerateUUID

func GenerateUUID() string

Types

type Base

type Base interface {
	io.ReaderFrom
	io.WriterTo

	Apply(Change) error
}

type Change

type Change interface {
	io.ReaderFrom
	io.WriterTo

	TypeName() string
}

type Database

type Database[B Base, S State] interface {
	Base() B
	State() S
	Apply(Change) error
	Close() error
}

type Factory

type Factory[B Base, S State] interface {
	NewBase() B
	NewState(B, sync.Locker) S
	NewChange(string) (Change, error)
}

type State

type State interface {
	Apply(Change) error
}