storage

Documentation

Index

• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) BackedBy(backing ItemStorageBacking) *Builder
  • func (b *Builder) Build() ItemStorage
  • func (b *Builder) WithBacking(backingType string) *Builder
  • func (b *Builder) WithDefaultBacking() *Builder
  • func (b *Builder) WithEndpoint(endpoint string) *Builder
  • func (b *Builder) WithNamespace(ns string) *Builder
  • func (b *Builder) WithPK(keyFields *indexing.Key) *Builder
  • func (b *Builder) WithRecord(recordTypePtr interface{}) *Builder
• type ItemStorage
• type ItemStorageBacking
• type KeyedStorage
  • func (s *KeyedStorage) Add(item search.Record) error
  • func (s *KeyedStorage) AddUniqueIndex(key *indexing.Key)
  • func (s *KeyedStorage) Close()
  • func (s *KeyedStorage) Find(query indexing.Query, output *search.ExternalResultItem) error
  • func (s *KeyedStorage) ForEach(callback func(record interface{}))
  • func (s *KeyedStorage) GetNewest(count int) []search.ExternalResultItem
  • func (s *KeyedStorage) NewWithKey(key *indexing.Key) ItemStorage
  • func (s *KeyedStorage) SetKey(index *indexing.Key) error
  • func (s *KeyedStorage) Size() int64

Types

type Builder

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

Builder for ItemStorage

func NewBuilder

func NewBuilder() *Builder

func (*Builder) BackedBy

func (b *Builder) BackedBy(backing ItemStorageBacking) *Builder

BackedBy can be used if you already have an initialized storage backing.

func (*Builder) Build

func (b *Builder) Build() ItemStorage

Build the storage object

func (*Builder) WithBacking

func (b *Builder) WithBacking(backingType string) *Builder

WithBacking set the data backing type. ex: boltdb, firebase, sqlite.

func (*Builder) WithDefaultBacking

func (b *Builder) WithDefaultBacking() *Builder

WithDefaultBacking sets the storage backing to `boltdb`

func (*Builder) WithEndpoint

func (b *Builder) WithEndpoint(endpoint string) *Builder

WithEndpoint if your storage location has a specific location (ex: db path)

func (*Builder) WithNamespace

func (b *Builder) WithNamespace(ns string) *Builder

WithNamespace make sure all data is in that namespace

func (*Builder) WithPK

func (b *Builder) WithPK(keyFields *indexing.Key) *Builder

WithPK use a primary key to store the data. By default an UUID is used.

func (*Builder) WithRecord

func (b *Builder) WithRecord(recordTypePtr interface{}) *Builder

WithRecord set the type of the items you'll be working with, this is needed for unmarshaling and querying.

type ItemStorage

type ItemStorage interface {
	Size() int64
	Find(query indexing.Query, output *search.ExternalResultItem) error
	Add(item search.Record) error
	AddUniqueIndex(key *indexing.Key)
	NewWithKey(pk *indexing.Key) ItemStorage
	Close()
	SetKey(index *indexing.Key) error
	GetNewest(count int) []search.ExternalResultItem
	ForEach(callback func(record interface{}))
}

type ItemStorageBacking

type ItemStorageBacking interface {
	//Tries to find a single record matching the query.
	Find(query indexing.Query, result interface{}) error
	HasIndex(meta *indexing.IndexMetadata) bool
	Update(query indexing.Query, item interface{}) error
	//CreateWithId creates a new record using a custom key
	CreateWithId(parts *indexing.Key, item search.Record, uniqueIndexKeys *indexing.Key) error
	//Create a new record with the default key (UUIDValue)
	Create(item search.Record, additionalPK *indexing.Key) error
	//Size is the size of the storage, as in records count
	Size() int64
	//GetNewest returns the latest `count` of records.
	GetNewest(count int) []search.ExternalResultItem
	Close()
	ForEach(callback func(record interface{}))
}

type KeyedStorage

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

func (*KeyedStorage) Add

func (s *KeyedStorage) Add(item search.Record) error

Add handles the discovery of the result, adding additional information like staleness state.

func (*KeyedStorage) AddUniqueIndex

func (s *KeyedStorage) AddUniqueIndex(key *indexing.Key)

AddUniqueIndex adds a new key set as unique for this storage.

func (*KeyedStorage) Close

func (s *KeyedStorage) Close()

func (*KeyedStorage) Find

func (s *KeyedStorage) Find(query indexing.Query, output *search.ExternalResultItem) error

func (*KeyedStorage) ForEach

func (s *KeyedStorage) ForEach(callback func(record interface{}))

func (*KeyedStorage) GetNewest

func (s *KeyedStorage) GetNewest(count int) []search.ExternalResultItem

func (*KeyedStorage) NewWithKey

func (s *KeyedStorage) NewWithKey(key *indexing.Key) ItemStorage

NewWithKey gets a storage backed in the same way, with a different key.

func (*KeyedStorage) SetKey

func (s *KeyedStorage) SetKey(index *indexing.Key) error

func (*KeyedStorage) Size

func (s *KeyedStorage) Size() int64