collection

Documentation

Index

• type Collection
  • func OpenCollection(filename string) (*Collection, error)
  • func (c *Collection) Close() error
  • func (c *Collection) Drop() error
  • func (c *Collection) DropIndex(name string) error
  • func (c *Collection) FindOne(data interface{})
  • func (c *Collection) Index(name string, options interface{}) error
  • func (c *Collection) Insert(item interface{}) (*Row, error)
  • func (c *Collection) Patch(row *Row, patch interface{}) error
  • func (c *Collection) Remove(r *Row) error
  • func (c *Collection) SetDefaults(defaults map[string]any) error
  • func (c *Collection) Traverse(f func(data []byte))
  • func (c *Collection) TraverseRange(from, to int, f func(row *Row))
• type Command
• type CreateIndexCommand
• type CreateIndexOptions
• type DropIndexCommand
• type Index
• type IndexBTreeOptions
• type IndexBtree
  • func NewIndexBTree(options *IndexBTreeOptions) *IndexBtree
  • func (b *IndexBtree) AddRow(r *Row) error
  • func (b *IndexBtree) RemoveRow(r *Row) error
  • func (b *IndexBtree) Traverse(optionsData []byte, f func(*Row) bool)
• type IndexBtreeTraverse
• type IndexMap
  • func NewIndexMap(options *IndexMapOptions) *IndexMap
  • func (i *IndexMap) AddRow(row *Row) error
  • func (i *IndexMap) RemoveRow(row *Row) error
  • func (i *IndexMap) Traverse(optionsData []byte, f func(row *Row) bool)
• type IndexMapOptions
• type IndexMapTraverse
• type Row
• type RowOrdered

Types

type Collection

type Collection struct {
	Filename string // Just informative...

	Rows []*Row

	Indexes map[string]*collectionIndex // todo: protect access with mutex or use sync.Map
	// buffer   *bufio.Writer // TODO: use write buffer to improve performance (x3 in tests)
	Defaults map[string]any
	// contains filtered or unexported fields
}

func OpenCollection

func OpenCollection(filename string) (*Collection, error)

func (*Collection) Close

func (c *Collection) Close() error

func (*Collection) Drop

func (c *Collection) Drop() error

func (*Collection) DropIndex

func (c *Collection) DropIndex(name string) error

func (*Collection) FindOne

func (c *Collection) FindOne(data interface{})

func (*Collection) Index

func (c *Collection) Index(name string, options interface{}) error

IndexMap create a unique index with a name Constraints: values can be only scalar strings or array of strings

func (*Collection) Insert

func (c *Collection) Insert(item interface{}) (*Row, error)

TODO: test concurrency

func (*Collection) Patch

func (c *Collection) Patch(row *Row, patch interface{}) error

func (*Collection) Remove

func (c *Collection) Remove(r *Row) error

func (*Collection) SetDefaults

func (c *Collection) SetDefaults(defaults map[string]any) error

func (*Collection) Traverse

func (c *Collection) Traverse(f func(data []byte))

func (*Collection) TraverseRange

func (c *Collection) TraverseRange(from, to int, f func(row *Row))

type Command

type Command struct {
	Name      string          `json:"name"`
	Uuid      string          `json:"uuid"`
	Timestamp int64           `json:"timestamp"`
	StartByte int64           `json:"start_byte"`
	Payload   json.RawMessage `json:"payload"`
}

type CreateIndexCommand

type CreateIndexCommand struct {
	Name    string      `json:"name"`
	Type    string      `json:"type"`
	Options interface{} `json:"options"`
}

type CreateIndexOptions

type CreateIndexOptions struct {
	Name    string      `json:"name"`
	Type    string      `json:"type"`
	Options interface{} `json:"options"`
}

type DropIndexCommand

type DropIndexCommand struct {
	Name string `json:"name"`
}

type Index

type Index interface {
	AddRow(row *Row) error
	RemoveRow(row *Row) error
	Traverse(options []byte, f func(row *Row) bool) // todo: return error?
}

type IndexBTreeOptions

type IndexBTreeOptions struct {
	Fields []string `json:"fields"`
	Sparse bool     `json:"sparse"`
	Unique bool     `json:"unique"`
}

type IndexBtree

type IndexBtree struct {
	Btree   *btree.BTreeG[*RowOrdered]
	Options *IndexBTreeOptions
}

func NewIndexBTree

func NewIndexBTree(options *IndexBTreeOptions) *IndexBtree

func (*IndexBtree) AddRow

func (b *IndexBtree) AddRow(r *Row) error

func (*IndexBtree) RemoveRow

func (b *IndexBtree) RemoveRow(r *Row) error

func (*IndexBtree) Traverse

func (b *IndexBtree) Traverse(optionsData []byte, f func(*Row) bool)

type IndexBtreeTraverse

type IndexBtreeTraverse struct {
	Reverse bool                   `json:"reverse"`
	From    map[string]interface{} `json:"from"`
	To      map[string]interface{} `json:"to"`
}

type IndexMap

type IndexMap struct {
	Entries map[string]*Row
	RWmutex *sync.RWMutex
	Options *IndexMapOptions
}

IndexMap should be an interface to allow multiple kinds and implementations

func NewIndexMap

func NewIndexMap(options *IndexMapOptions) *IndexMap

func (*IndexMap) AddRow

func (i *IndexMap) AddRow(row *Row) error

func (*IndexMap) RemoveRow

func (i *IndexMap) RemoveRow(row *Row) error

func (*IndexMap) Traverse

func (i *IndexMap) Traverse(optionsData []byte, f func(row *Row) bool)

type IndexMapOptions

type IndexMapOptions struct {
	Field  string `json:"field"`
	Sparse bool   `json:"sparse"`
}

IndexMapOptions should have attributes like unique, sparse, multikey, sorted, background, etc... IndexMap should be an interface to have multiple indexes implementations, key value, B-Tree, bitmap, geo, cache...

type IndexMapTraverse

type IndexMapTraverse struct {
	Value string `json:"value"`
}

type Row

type Row struct {
	I       int // position in Rows
	Payload json.RawMessage
}

type RowOrdered

type RowOrdered struct {
	*Row
	Values []interface{}
}