temporal

type Database interface {

	// Create a new bucket
	Create(name string) error

	// This function adds the records
	Add(name string, timeseries TimeSeries) error

	// Get the records
	Query(q Query) (timeSeries TimeSeries, nextEntry *int64, err error)

	QueryOnChannel(q Query) (timeseries <-chan TimeEntry, nextEntry chan *int64, err chan error)
	// Get the total pages for a particular query.
	// This helps for any client to call multiple queries
	GetPages(q Query) (seriesList []int64, count int, err error)

	// Get the records
	Get(series string) (timeSeries TimeSeries, err error)
	// Returns two channels, one for Time entries and one for error.
	// This avoids the usage of an extra buffer by the database
	// Caution: first read the channel and then read the error. Error channel shall be written only after the timeseries channel is closed
	GetOnChannel(series string) (timeseries <-chan TimeEntry, err chan error)

	// Delete a complete Series
	Delete(series string) error

	// Close the database
	Close() error
}

type MemCacheConfig struct {
	Path string
	Mode os.FileMode
}

type MemCacheDB struct {
	// contains filtered or unexported fields
}

type Query struct {
	Series string

	From int64
	To   int64
	// Sorting order:
	// Possible values are ASC and DESC
	// ASC : The time Series will have the oldest data first
	// DESC: The time Series will have the latest  data first.
	Sort string

	// Number of entries to be returned per page. This is used for pagination.
	// The next sequence is found out using NextEntry variable of a query response.
	MaxEntries int
}

type TimeEntry struct {
	Time  int64
	Value []byte
}

type TimeSeries []TimeEntry