essence

Documentation

Index

• type Collection
• type KeyValueCollection
• type ListCollection
• type Store

Types

type Collection

type Collection interface {
	Kind() string
	Name() string
	Store() Store
	Keyspace() string
}

a Collection is like a table. A discrete and namespaced area for data of a particular Kind

type KeyValueCollection

type KeyValueCollection interface {
	Collection
	Get(context.Context, string) ([]byte, error)
	Set(context.Context, string, []byte) error
	Keys(context.Context) []string
	All(context.Context) map[string][]byte
	Destroy(context.Context) error
}

a KeyValueCollection has methods allowing it to behave as a key-value store

type ListCollection

type ListCollection interface {
	Collection
	Pop(context.Context) ([]byte, error)
	Push(context.Context, []byte) error
	Shift(context.Context) ([]byte, error)
	Unshift(context.Context, []byte) error
	All(context.Context) [][]byte
	Size(context.Context) int
	Head(context.Context) ([]byte, error)
	Tail(context.Context) ([]byte, error)
	Destroy(context.Context) error
}

a ListCollection has methods allowing it to be operated on as a list

type Store

type Store interface {
	KeyValueCollection(context.Context, string) (KeyValueCollection, error)
	ListCollection(context.Context, string) (ListCollection, error)
	RemoveCollection(context.Context, Collection)
	CollectionExists(context.Context, string, string) bool
	KeyValueCollections(context.Context) map[string]KeyValueCollection
	ListCollections(context.Context) map[string]ListCollection
	Destroy(context.Context) error
}

a store is a logical namespace that contains collections, which are themselves logical namespaces