store

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

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

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

type Log interface {
	// Create a new segment for writes.
	Create() (WriteSegment, error)

	// Query written and closed segments.
	Query(from, to time.Time, q string, regex, statsOnly bool) (QueryResult, error)

	// Overlapping returns segments that have a high degree of time overlap and
	// can be compacted.
	Overlapping() ([]ReadSegment, error)

	// Sequential returns segments that are small and sequential and can be
	// compacted.
	Sequential() ([]ReadSegment, error)

	// Trashable segments are read segments whose newest record is older than
	// the given time. They may be trashed, i.e. made unavailable for querying.
	Trashable(oldestRecord time.Time) ([]ReadSegment, error)

	// Purgable segments are trash segments whose modification time (i.e. the
	// time they were trashed) is older than the given time. They may be purged,
	// i.e. hard deleted.
	Purgeable(oldestModTime time.Time) ([]TrashSegment, error)

	// Stats of the current state of the store log.
	Stats() (LogStats, error)

	// Close the log, releasing any claimed lock.
	Close() error
}

type LogStats struct {
	ActiveSegments  int64
	ActiveBytes     int64
	FlushedSegments int64
	FlushedBytes    int64
	ReadingSegments int64
	ReadingBytes    int64
	TrashedSegments int64
	TrashedBytes    int64
}

type QueryResult struct {
	From     string `json:"from"`
	To       string `json:"to"`
	Q        string `json:"q"`
	Regex    bool   `json:"regex"`
	Duration string `json:"duration"`

	NodesQueried    int   `json:"nodes_queried"`
	SegmentsQueried int   `json:"segments_queried"`
	MaxDataSetSize  int64 `json:"max_data_set_size"`
	ErrorCount      int   `json:"error_count,omitempty"`

	Records io.ReadCloser // TODO(pb): audit to ensure closing is valid throughout
}

type ReadSegment interface {
	io.Reader
	Reset() error
	Trash() error
	Purge() error
}

type TrashSegment interface {
	Purge() error
}

type WriteSegment interface {
	io.Writer
	Close(low, high ulid.ULID) error
	Delete() error
}