index

Documentation

Index

• type Index
  • func CreateIndex(collection, field string, idxType Type, tx store.Tx) Index
• type Info
• type Query
• type Range
  • func (r *Range) Intersect(r2 *Range) *Range
  • func (r *Range) IsEmpty() bool
  • func (r *Range) IsNil() bool
• type RangeIndex
• type RangeIndexQuery
  • func (q *RangeIndexQuery) Run(onValue func(docId string) error) error
• type Type

Types

type Index

type Index interface {
	Add(docId string, v interface{}, ttl time.Duration) error
	Remove(docId string, v interface{}) error
	Iterate(reverse bool, onValue func(docId string) error) error
	Drop() error
	Type() Type
	Collection() string
	Field() string
}

func CreateIndex

func CreateIndex(collection, field string, idxType Type, tx store.Tx) Index

type Info

type Info struct {
	Field string
	Type  Type
}

type Query

type Query interface {
	Run(onValue func(docId string) error) error
}

type Range

type Range struct {
	Start, End                 interface{}
	StartIncluded, EndIncluded bool
}

func (*Range) Intersect

func (r *Range) Intersect(r2 *Range) *Range

func (*Range) IsEmpty

func (r *Range) IsEmpty() bool

func (*Range) IsNil

func (r *Range) IsNil() bool

type RangeIndex

type RangeIndex interface {
	Index
	IterateRange(vRange *Range, reverse bool, onValue func(docId string) error) error
}

type RangeIndexQuery

type RangeIndexQuery struct {
	Range   *Range
	Reverse bool
	Idx     RangeIndex
}

func (*RangeIndexQuery) Run

func (q *RangeIndexQuery) Run(onValue func(docId string) error) error

type Type

type Type int

const (
	SingleField Type = iota
)