indexes

Documentation

Index

• type ByField
  • func CreateByField[R record.Record]() ByField[R]
• type ConcurrentStorage
  • func CreateConcurrentStorage(original Storage, storeOnlyUniqID bool) ConcurrentStorage
• type Index
• type IndexComputer
• type IndexWeight
• type Key
• type Storage

Types

type ByField

type ByField[R record.Record] interface {
	Add(index Index[R])
	Insert(item R)
	Delete(item R)
	Update(oldItem, item R)
	SelectForCondition(condition where.Condition[R]) (
		indexExists bool,
		count int,
		ids []storage.IDIterator,
		idsUnique bool,
		err error,
	)
}

func CreateByField

func CreateByField[R record.Record]() ByField[R]

type ConcurrentStorage

type ConcurrentStorage interface {
	RLock()
	RUnlock()
	Unwrap() Storage
	Get(key Key) storage.IDStorage
	GetOrCreate(key Key) storage.IDStorage
}

ConcurrentStorage wrapped Storage for concurrent safe access.

func CreateConcurrentStorage

func CreateConcurrentStorage(original Storage, storeOnlyUniqID bool) ConcurrentStorage

type Index

type Index[R record.Record] interface {
	Field() record.Field
	Unique() bool
	Compute() IndexComputer[R]
	Weight(condition where.Condition[R]) (canApplyIndex bool, weight IndexWeight)
	Select(condition where.Condition[R]) (count int, ids []storage.IDIterator, err error)
	ConcurrentStorage() ConcurrentStorage
}

type IndexComputer

type IndexComputer[R record.Record] interface {
	ForRecord(item R) Key
	ForValue(value any) Key
	Check(indexKey Key, comparator where.FieldComparator[R]) (bool, error)
}

type IndexWeight

type IndexWeight uint8

const (
	IndexWeightLow    IndexWeight = 10
	IndexWeightMedium IndexWeight = 20
	IndexWeightHigh   IndexWeight = 30
)

type Key

type Key interface {
	Less(than Key) bool
}

type Storage

type Storage interface {
	Get(key Key) storage.IDStorage
	Set(key Key, records storage.IDStorage)
}

Storage is base interface for indexes.