datastore

Documentation

Index

• type DataStorer

Types

type DataStorer

type DataStorer interface {
	UpsertClipInfo(*contracts.ClipInfo) error

	UpsertEpisodeInfo(*contracts.EpisodeInfo) error

	CreateResearchLease(*uuid.UUID, *contracts.EpisodeInfo, []*contracts.ClipInfo, time.Time) error
	RenewResearchLease(uuid.UUID, time.Time) error
	RevokeResearchLease(uuid.UUID) error

	GetHighestPriorityEpisode() (*contracts.EpisodeInfo, error)
	GetHighestPriorityClipsForEpisode(episode *contracts.EpisodeInfo, limit int) ([]*contracts.ClipInfo, error)
	RecordCompletedResearch(*contracts.CompletedResearchItem) error
}

A DataStorer is anything that is able to store and retrieve data from a persistant data store. Each of the methods of this interface must be implemented as atomic actions. Thus, if an error is returned by any of these methods, the consumer should trust that the underlaying data layer has made all possible attempts to leave the datastore in a safe state. If such a condition cannot be guaranteed, the implementor should expose error types that describe the severity of the issue.