storage

Documentation

Index

• Constants
• type Model
• type Repository

Constants

const (
	// ErrModelRepositorySerialisation must be used when document repository encounters a marshalling error
	ErrModelRepositorySerialisation = errors.Error("model repository encountered a marshalling error")

	// ErrModelRepositoryNotFound must be used when model is not found in db
	ErrModelRepositoryNotFound = errors.Error("model not found in db")

	// ErrRepositoryModelSave must be used when db repository can not save the given model
	ErrRepositoryModelSave = errors.Error("db repository could not save the given model")

	// ErrRepositoryModelUpdateKeyNotFound must be used when db repository can not update the given model
	ErrRepositoryModelUpdateKeyNotFound = errors.Error("db repository could not update the given model, key not found")

	// ErrRepositoryModelCreateKeyExists must be used when db repository can not create the given model
	ErrRepositoryModelCreateKeyExists = errors.Error("db repository could not create the given model, key already exists")

	// ErrModelTypeNotRegistered must be used when model hasn't been registered in db
	ErrModelTypeNotRegistered = errors.Error("type not registered")
)

const (
	// BootstrappedDB is a key mapped to DB at boot
	BootstrappedDB string = "BootstrappedDB"
	// BootstrappedConfigDB is a key mapped to DB for configs at boot
	BootstrappedConfigDB string = "BootstrappedConfigDB"
)

Types

type Model

type Model interface {
	//Returns the underlying type of the Model
	Type() reflect.Type

	// JSON return the json representation of the model
	JSON() ([]byte, error)

	// FromJSON initialize the model with a json
	FromJSON(json []byte) error
}

Model is an interface to abstract away storage model specificness

type Repository

type Repository interface {
	Register(model Model)
	Exists(key []byte) bool
	Get(key []byte) (Model, error)
	GetAllByPrefix(prefix string) ([]Model, error)
	Create(key []byte, model Model) error
	Update(key []byte, model Model) error
	Delete(key []byte) error
	Close() error
}

Repository defines the required methods for standard storage repository.