store

Documentation

Overview

Ensign maintains two separate storage locations on disk: the event store which is intended to be an append-only fast disk write for incoming events and a meta store which is used to persist operational metadata such as topic and placement information.

Index

• func Open(conf config.StorageConfig) (data EventStore, meta MetaStore, err error)
• func OpenEvents(conf config.StorageConfig) (*events.Store, error)
• func OpenMeta(conf config.StorageConfig) (*meta.Store, error)
• type EventHashStore
• type EventStore
• type GroupStore
• type MetaStore
• type Store
• type TopicInfoStore
• type TopicNamesStore
• type TopicStore

Functions

func Open

func Open(conf config.StorageConfig) (data EventStore, meta MetaStore, err error)

func OpenEvents

func OpenEvents(conf config.StorageConfig) (*events.Store, error)

func OpenMeta

func OpenMeta(conf config.StorageConfig) (*meta.Store, error)

Types

type EventHashStore

type EventHashStore interface {
	// Indash is a combination of "Index" and "Hash"
	Indash(topicID ulid.ULID, hash []byte, eventID rlid.RLID) error
	Unhash(topicID ulid.ULID, hash []byte) (*api.EventWrapper, error)
	LoadIndash(topicID ulid.ULID) iterator.IndashIterator
	ClearIndash(topicID ulid.ULID) error
}

type EventStore

type EventStore interface {
	Store
	EventHashStore
	Insert(*api.EventWrapper) error
	List(topicID ulid.ULID) iterator.EventIterator
	Retrieve(topicID ulid.ULID, eventID rlid.RLID) (*api.EventWrapper, error)
	Destroy(topicID ulid.ULID) error
}

type GroupStore

type GroupStore interface {
	ListGroups(projectID ulid.ULID) iterator.GroupIterator
	GetOrCreateGroup(*api.ConsumerGroup) (bool, error)
	UpdateGroup(*api.ConsumerGroup) error
	DeleteGroup(*api.ConsumerGroup) error
}

type MetaStore

type MetaStore interface {
	Store
	TopicStore
	TopicNamesStore
	TopicInfoStore
}

type Store

type Store interface {
	io.Closer
	ReadOnly() bool
}

type TopicInfoStore

type TopicInfoStore interface {
	ListAllTopics() iterator.TopicIterator
	TopicInfo(topicID ulid.ULID) (*api.TopicInfo, error)
	UpdateTopicInfo(*api.TopicInfo) error
}

type TopicNamesStore

type TopicNamesStore interface {
	ListTopicNames(projectID ulid.ULID) iterator.TopicNamesIterator
	TopicExists(in *api.TopicName) (*api.TopicExistsInfo, error)
	TopicName(topicID ulid.ULID) (string, error)
	LookupTopicID(name string, projectID ulid.ULID) (topicID ulid.ULID, err error)
}

type TopicStore

type TopicStore interface {
	AllowedTopics(projectID ulid.ULID) ([]ulid.ULID, error)
	ListTopics(projectID ulid.ULID) iterator.TopicIterator
	CreateTopic(*api.Topic) error
	RetrieveTopic(topicID ulid.ULID) (*api.Topic, error)
	UpdateTopic(*api.Topic) error
	DeleteTopic(topicID ulid.ULID) error
}