dsl

Documentation

Index

• Constants
• func Bool(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, ...) error
• func Bytes(r *roaring.Bitmap, tr tr.Translate, _ protoreflect.FieldDescriptor, id uint64, ...) error
• func Enum(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, ...) error
• func Float64(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, ...) error
• func Int64(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, ...) error
• func String(r *roaring.Bitmap, tr tr.Translate, field protoreflect.FieldDescriptor, ...) error
• func Uint64(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, ...) error
• func ViewKey(field, view string) string
• type Fields
• type Ops
  • func (o *Ops) Close() error
• type Option
  • func WithSkip[T proto.Message](field ...string) Option[T]
  • func WithTimestampField[T proto.Message](name string) Option[T]
• type RangeCallback
• type Reader
  • func (r Reader[T]) Range(start, end time.Time) []Shard
  • func (r Reader[T]) RangeUnit(start, end time.Time, unit rune) []Shard
  • func (r *Reader[T]) Release() error
  • func (r Reader[T]) Standard() Shard
  • func (r *Reader[T]) Tr() *tr.Read
  • func (r *Reader[T]) View(shard Shard, f func(txn *tx.Tx) error) error
• type Schema
  • func (s *Schema[T]) Commit(m map[string]*roaring.Bitmap) error
  • func (s *Schema[T]) Range(f RangeCallback) error
  • func (s *Schema[T]) Release() (err error)
  • func (s *Schema[T]) Save() error
  • func (s *Schema[T]) Write(msg T) error
• type Shard
• type Shards
• type Store
  • func New[T proto.Message](path string, opts ...Option[T]) (*Store[T], error)
  • func (s *Store[T]) Append(data []T) error
  • func (s *Store[T]) Close() error
  • func (s *Store[T]) DB() *db.Shards
  • func (s *Store[T]) Reader() (*Reader[T], error)
  • func (s *Store[T]) Schema() (*Schema[T], error)
• type Views
• type Writers

Constants

const (
	StandardView   = "standard"
	Quantum        = "20060102"
	TimestampField = protoreflect.Name("timestamp")
	ID             = "_id"

	// It might be excessive but our goal is to be extremely useful and by having
	// database per shard we can afford being this granular
	//
	// Timeseries endpoints for vince requires
	IngestQuantum = "YMDH"
)

Functions

func Bool

func Bool(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, value protoreflect.Value) error

Bool writes a boolean proto value

func Bytes

func Bytes(r *roaring.Bitmap, tr tr.Translate, _ protoreflect.FieldDescriptor, id uint64, value protoreflect.Value) error

func Enum

func Enum(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, value protoreflect.Value) error

Enum writes enum proto value

func Float64

func Float64(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, value protoreflect.Value) error

func Int64

func Int64(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, value protoreflect.Value) error

Int64 writes int64 proto value

func String

func String(r *roaring.Bitmap, tr tr.Translate, field protoreflect.FieldDescriptor, id uint64, value protoreflect.Value) error

func Uint64

func Uint64(r *roaring.Bitmap, _ tr.Translate, _ protoreflect.FieldDescriptor, id uint64, value protoreflect.Value) error

func ViewKey

func ViewKey(field, view string) string

Types

type Fields

type Fields map[string]*roaring.Bitmap

type Ops

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

func (*Ops) Close

func (o *Ops) Close() error

type Option

type Option[T proto.Message] func(store *Store[T])

func WithSkip

func WithSkip[T proto.Message](field ...string) Option[T]

func WithTimestampField

func WithTimestampField[T proto.Message](name string) Option[T]

type RangeCallback

type RangeCallback func(shard uint64, views Views) error

type Reader

type Reader[T proto.Message] struct {
	// contains filtered or unexported fields
}

func (Reader[T]) Range

func (r Reader[T]) Range(start, end time.Time) []Shard

Range returns shards for the time range. We select possible views to read from based on start and end.

We Store Hour, Day, Month and Year Quantum.

func (Reader[T]) RangeUnit

func (r Reader[T]) RangeUnit(start, end time.Time, unit rune) []Shard

func (*Reader[T]) Release

func (r *Reader[T]) Release() error

func (Reader[T]) Standard

func (r Reader[T]) Standard() Shard

Standard returns the standard shard. Use this to query global data

func (*Reader[T]) Tr

func (r *Reader[T]) Tr() *tr.Read

func (*Reader[T]) View

func (r *Reader[T]) View(shard Shard, f func(txn *tx.Tx) error) error

type Schema

type Schema[T proto.Message] struct {
	// contains filtered or unexported fields
}

Schema maps proto fields to rbf types.

func (*Schema[T]) Commit

func (s *Schema[T]) Commit(m map[string]*roaring.Bitmap) error

func (*Schema[T]) Range

func (s *Schema[T]) Range(f RangeCallback) error

func (*Schema[T]) Release

func (s *Schema[T]) Release() (err error)

func (*Schema[T]) Save

func (s *Schema[T]) Save() error

func (*Schema[T]) Write

func (s *Schema[T]) Write(msg T) error

type Shard

type Shard struct {
	Shard uint64
	Views []string
}

type Shards

type Shards map[uint64]Views

type Store

type Store[T proto.Message] struct {
	// contains filtered or unexported fields
}

func New

func New[T proto.Message](path string, opts ...Option[T]) (*Store[T], error)

func (*Store[T]) Append

func (s *Store[T]) Append(data []T) error

func (*Store[T]) Close

func (s *Store[T]) Close() error

func (*Store[T]) DB

func (s *Store[T]) DB() *db.Shards

func (*Store[T]) Reader

func (s *Store[T]) Reader() (*Reader[T], error)

Reader creates a new Reader for querying the store T. Make sure the reader is released after use.

func (*Store[T]) Schema

func (s *Store[T]) Schema() (*Schema[T], error)

type Views

type Views map[string]Fields

type Writers

type Writers map[string]writeFn