sqlcache

type FieldFunc ¶

type FieldFunc func(obj any) any

FieldFunc is a function from an object to a filterable/sortable property. Result can be string, int or bool

type Filter ¶

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

Filter represents a field to filter by. A subfield in an object is represented in a request query using . notation, e.g. 'metadata.name'. The subfield is internally represented as a slice, e.g. [metadata, name].

type Indexer ¶

type Indexer struct {
	*Store
	// contains filtered or unexported fields
}

Indexer is a SQLite-backed cache.Indexer which builds upon Store adding an index table

func NewIndexer(example any, keyFunc cache.KeyFunc, path string, indexers cache.Indexers) (*Indexer, error)

func (i *Indexer) AddIndexers(newIndexers cache.Indexers) error

func (i *Indexer) AfterUpsert(key string, obj any, tx *sql.Tx) error

func (i *Indexer) ByIndex(indexName, indexedValue string) ([]any, error)

func (i *Indexer) GetIndexers() cache.Indexers

func (i *Indexer) Index(indexName string, obj any) ([]any, error)

func (i *Indexer) IndexKeys(indexName, indexedValue string) ([]string, error)

func (i *Indexer) ListIndexFuncValues(name string) []string

func (i *Indexer) SafeListIndexFuncValues(indexName string) ([]string, error)

type ListOptionIndexer ¶

type ListOptionIndexer struct {
	*VersionedIndexer
	// contains filtered or unexported fields
}

ListOptionIndexer extends VersionedIndexer by allowing queries based on ListOption

func NewCustomListOptionIndexer(example meta.Object, keyFunc cache.KeyFunc, path string, fieldFuncs map[string]FieldFunc, indexers cache.Indexers) (*ListOptionIndexer, error)

func NewListOptionIndexer(example meta.Object, path string, fieldFuncs map[string]FieldFunc) (*ListOptionIndexer, error)

func (l *ListOptionIndexer) AfterUpsert(key string, obj any, tx *sql.Tx) error

func (l *ListOptionIndexer) ListByOptions(lo ListOptions) ([]any, error)

type ListOptions ¶

type ListOptions struct {
	ChunkSize  int
	Resume     string
	Filters    []Filter
	Sort       Sort
	Pagination Pagination
	Revision   string
}

ListOptions represents the query parameters that may be included in a list request.

type Pagination ¶

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

Pagination represents how to return paginated results.

type Sort ¶

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

Sort represents the criteria to sort on. The subfield to sort by is represented in a request query using . notation, e.g. 'metadata.name'. The subfield is internally represented as a slice, e.g. [metadata, name]. The order is represented by prefixing the sort key by '-', e.g. sort=-metadata.name.

type SortOrder ¶

type SortOrder int

SortOrder represents whether the list should be ascending or descending.

const (
	// ASC stands for ascending order.
	ASC SortOrder = iota
	// DESC stands for descending (reverse) order.
	DESC
)

type Store ¶

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

Store is a SQLite-backed cache.Store

func NewStore(example any, keyFunc cache.KeyFunc, path string) (*Store, error)

func (s *Store) Add(obj any) error

func (s *Store) Close() error

func (s *Store) Delete(obj any) error

func (s *Store) DeleteByKey(key string) error

func (s *Store) Get(obj any) (item any, exists bool, err error)

func (s *Store) GetByKey(key string) (item any, exists bool, err error)

func (s *Store) InitExec(stmt string) error

func (s *Store) List() []any

func (s *Store) ListKeys() []string

func (s *Store) Prepare(stmt string) *sql.Stmt

func (s *Store) QueryObjects(stmt *sql.Stmt, params ...any) ([]any, error)

func (s *Store) QueryStrings(stmt *sql.Stmt, params ...any) ([]string, error)

func (s *Store) RegisterAfterDelete(f func(key string, tx *sql.Tx) error)

func (s *Store) RegisterAfterUpsert(f func(key string, obj any, tx *sql.Tx) error)

func (s *Store) Replace(objects []any, _ string) error

func (s *Store) ReplaceByKey(objects map[string]any) error

func (s *Store) Resync() error

func (s *Store) Update(obj any) error

func (s *Store) Upsert(key string, obj any) error

type VersionFunc ¶

type VersionFunc func(obj any) (int, error)

type VersionedIndexer ¶

type VersionedIndexer struct {
	*Indexer
	// contains filtered or unexported fields
}

VersionedIndexer extends Indexer by storing a range of versions in addition to the latest one

func NewVersionedIndexer(example any, keyFunc cache.KeyFunc, versionFunc VersionFunc, path string, indexers cache.Indexers) (*VersionedIndexer, error)

func (v *VersionedIndexer) AfterDelete(key string, tx *sql.Tx) error

func (v *VersionedIndexer) AfterUpsert(key string, obj any, tx *sql.Tx) error

func (v *VersionedIndexer) GetByKeyAndVersion(key string, version int) (item any, exists bool, err error)