sqlobjectstore

Documentation

Index

• type FilterOption
  • func FilterByHash(hs ...object.Hash) FilterOption
  • func FilterByObjectType(typePatterns ...string) FilterOption
  • func FilterByOwner(hs ...crypto.PublicKey) FilterOption
  • func FilterByStreamHash(hs ...object.Hash) FilterOption
  • func FilterLimit(limit, offset int) FilterOption
  • func FilterOrderBy(orderBy string) FilterOption
  • func FilterOrderDir(orderDir string) FilterOption
• type FilterOptions
• type Store
  • func New(db *sql.DB) (*Store, error)
  • func (st *Store) Close() error
  • func (st *Store) Filter(filterOptions ...FilterOption) (object.ReadCloser, error)
  • func (st *Store) Get(hash object.Hash) (*object.Object, error)
  • func (st *Store) GetByStream(streamRootHash object.Hash) (object.ReadCloser, error)
  • func (st *Store) GetByType(objectType string) (object.ReadCloser, error)
  • func (st *Store) GetPinned() ([]object.Hash, error)
  • func (st *Store) GetRelations(parent object.Hash) ([]object.Hash, error)
  • func (st *Store) GetStreamLeaves(streamRootHash object.Hash) ([]object.Hash, error)
  • func (st *Store) Put(obj *object.Object) error
  • func (st *Store) PutWithTTL(obj *object.Object, ttl time.Duration) error
  • func (st *Store) Remove(hash object.Hash) error
  • func (st *Store) UpdateTTL(hash object.Hash, minutes int) error

Types

type FilterOption

type FilterOption func(*FilterOptions)

FilterOptions

func FilterByHash

func FilterByHash(hs ...object.Hash) FilterOption

func FilterByObjectType

func FilterByObjectType(typePatterns ...string) FilterOption

func FilterByOwner

func FilterByOwner(hs ...crypto.PublicKey) FilterOption

func FilterByStreamHash

func FilterByStreamHash(hs ...object.Hash) FilterOption

func FilterLimit

func FilterLimit(limit, offset int) FilterOption

func FilterOrderBy

func FilterOrderBy(orderBy string) FilterOption

func FilterOrderDir

func FilterOrderDir(orderDir string) FilterOption

type FilterOptions

type FilterOptions struct {
	// Filters are used to perform db queries for these filters
	// TODO find a better name for this
	Filters struct {
		ObjectHashes []object.Hash
		StreamHashes []object.Hash
		ContentTypes []string
		Owners       []crypto.PublicKey
		OrderBy      string
		OrderDir     string
		Limit        *int
		Offset       *int
	}
}

FilterOptions

type Store

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

func New

func New(
	db *sql.DB,
) (*Store, error)

func (*Store) Close

func (st *Store) Close() error

func (*Store) Filter

func (st *Store) Filter(
	filterOptions ...FilterOption,
) (object.ReadCloser, error)

func (*Store) Get

func (st *Store) Get(
	hash object.Hash,
) (*object.Object, error)

func (*Store) GetByStream

func (st *Store) GetByStream(
	streamRootHash object.Hash,
) (object.ReadCloser, error)

func (*Store) GetByType

func (st *Store) GetByType(
	objectType string,
) (object.ReadCloser, error)

func (*Store) GetPinned

func (st *Store) GetPinned() ([]object.Hash, error)

func (*Store) GetRelations

func (st *Store) GetRelations(
	parent object.Hash,
) ([]object.Hash, error)

func (*Store) GetStreamLeaves

func (st *Store) GetStreamLeaves(
	streamRootHash object.Hash,
) ([]object.Hash, error)

func (*Store) Put

func (st *Store) Put(
	obj *object.Object,
) error

func (*Store) PutWithTTL

func (st *Store) PutWithTTL(
	obj *object.Object,
	ttl time.Duration,
) error

func (*Store) Remove

func (st *Store) Remove(
	hash object.Hash,
) error

func (*Store) UpdateTTL

func (st *Store) UpdateTTL(
	hash object.Hash,
	minutes int,
) error