storage

type Afero ¶

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

func NewAfero(fs afero.Fs, path string, mode Mode, perm os.FileMode) *Afero

func (s Afero) GetMode() Mode

func (s Afero) GetShard(ts time.Time) (Shard, error)

func (s Afero) GetShards() ([]Shard, error)

func (s Afero) GetShardsRange(from time.Time, to time.Time) ([]Shard, error)

type AferoShard ¶

type AferoShard struct {
	FileShard
	// contains filtered or unexported fields
}

func (s AferoShard) Add(records []Record) (int, error)

func (s AferoShard) GetAllCallback(callback QueryCallback) error

func (s AferoShard) GetDate() time.Time

type File ¶

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

func NewFile(path string, mode Mode, perm os.FileMode) *File

func (s File) GetMode() Mode

func (s File) GetShard(ts time.Time) (Shard, error)

func (s File) GetShards() ([]Shard, error)

func (s File) GetShardsRange(from time.Time, to time.Time) ([]Shard, error)

type FileShard ¶

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

func (s FileShard) Add(records []Record) (int, error)

func (s FileShard) GetAllCallback(callback QueryCallback) error

func (s FileShard) GetDate() time.Time

type Memory ¶

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

Memory implements the QuartzDBStorage client interface in memory useful for testing as the data is not persisted

func NewMemory(mode Mode) *Memory

func (s Memory) GetMode() Mode

func (s *Memory) GetShard(ts time.Time) (Shard, error)

func (s *Memory) GetShards() ([]Shard, error)

func (s *Memory) GetShardsRange(from time.Time, to time.Time) ([]Shard, error)

type MemoryShard ¶

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

MemoryShard implements the Shard interface for the Memory storage

func (s *MemoryShard) Add(records []Record) (int, error)

func (s MemoryShard) GetAllCallback(callback QueryCallback) error

func (s MemoryShard) GetDate() time.Time

type Mode ¶

type Mode rune

Mode determines the client data access mode read/read-write

const (
	// ModeRead opens the database in read only mode
	ModeRead Mode = 'r'
	// ModeWrite opens the database in read-write mode
	ModeWrite Mode = 'w'
)

type QuartzDBStorage ¶

type QuartzDBStorage interface {
	GetMode() Mode
	GetShard(ts time.Time) (Shard, error)
	GetShards() ([]Shard, error)
	GetShardsRange(from time.Time, to time.Time) ([]Shard, error)
}

QuartzDBStorage is a QuartzDB storage interface

type QueryCallback ¶

type QueryCallback = func(record Record) (stop bool, err error)

QueryCallback is a callback function function used to iterate over records

type RawRecord ¶

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

RawRecord implements Record which can contain any raw bytes data

func NewRawRecord(ts time.Time, bytes []byte) RawRecord

func (mr RawRecord) Bytes() []byte

func (mr RawRecord) Time() time.Time

type Record ¶

type Record interface {
	Time() time.Time
	Bytes() []byte
}

Record is an interface for single record item. Every record must be timestamped and serializeabe to array of bytes

type Shard ¶

type Shard interface {
	GetDate() time.Time
	Add(records []Record) (int, error)
	GetAllCallback(callback QueryCallback) error
}

Shard is a date based shard of records. A shard must contain only records from the same UTC date