data_source

Documentation

Index

• type DataSource

Types

type DataSource

type DataSource interface {
	// Name returns the name of the data source. The name must be unique. Registering a data source with the same name
	// will replace the existing data source of the same name.
	Name() string

	// Start is called when the registry is started, and should be used to do any work to "start" the data source.
	Start() error

	// Stop is called when the registry is stopped, and should be used to do any work to "stop" the data source.
	Stop() error

	// All loads all entities from the data source returning a map of entity ID to entities.
	All() (map[string]map[string]interface{}, error)

	// Count returns the number of entities in the data source using the provided map.
	Count(map[string]interface{}) (int64, error)

	// Find returns a list of entities from executing a search against a provided map. It returns a list of entities as a
	// map keyed by their ids.
	Find(search map[string]interface{}) (map[string]map[string]interface{}, error)

	// FindOne returns a single id, and entity from executing a search against a provided map.
	FindOne(search map[string]interface{}) (string, map[string]interface{}, error)

	// Delete deletes an entity from the data source.
	Delete(entityId string) error

	// FindAndDelete deletes all entities from the data source that match the provided filter.
	FindAndDelete(search map[string]interface{}) error

	// Save saves an entity to the data source. The entity ID is the key used to save the entity. The entity is a map of
	// key/value pairs representing the component.
	Save(entityId string, entity map[string]interface{}) error
}

DataSource is a data source that can be used to retrieve and persist data. So long as the data source implements this interface, it can be registered and used.