sqlobjectstore

Documentation

Index

• type FilterOption
  • func FilterByCID(hs ...object.CID) FilterOption
  • func FilterByObjectType(typePatterns ...string) FilterOption
  • func FilterByOwner(hs ...crypto.PublicKey) FilterOption
  • func FilterByStreamCID(hs ...object.CID) 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(cid object.CID) (*object.Object, error)
  • func (st *Store) GetByStream(streamRootCID object.CID) (object.ReadCloser, error)
  • func (st *Store) GetByType(objectType string) (object.ReadCloser, error)
  • func (st *Store) GetPinned() ([]object.CID, error)
  • func (st *Store) GetRelations(parent object.CID) ([]object.CID, error)
  • func (st *Store) GetStreamLeaves(streamRootCID object.CID) ([]object.CID, error)
  • func (st *Store) IsPinned(cid object.CID) (bool, error)
  • func (st *Store) Pin(cid object.CID) error
  • func (st *Store) Put(obj *object.Object) error
  • func (st *Store) PutWithTTL(obj *object.Object, ttl time.Duration) error
  • func (st *Store) Remove(cid object.CID) error
  • func (st *Store) RemovePin(cid object.CID) error
  • func (st *Store) UpdateTTL(cid object.CID, minutes int) error

Types

type FilterOption

type FilterOption func(*FilterOptions)

FilterOptions

func FilterByCID

func FilterByCID(hs ...object.CID) FilterOption

func FilterByObjectType

func FilterByObjectType(typePatterns ...string) FilterOption

func FilterByOwner

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

func FilterByStreamCID

func FilterByStreamCID(hs ...object.CID) 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 {
		ObjectCIDs   []object.CID
		StreamCIDs   []object.CID
		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(
	cid object.CID,
) (*object.Object, error)

func (*Store) GetByStream

func (st *Store) GetByStream(
	streamRootCID object.CID,
) (object.ReadCloser, error)

func (*Store) GetByType

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

func (*Store) GetPinned

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

func (*Store) GetRelations

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

func (*Store) GetStreamLeaves

func (st *Store) GetStreamLeaves(
	streamRootCID object.CID,
) ([]object.CID, error)

func (*Store) IsPinned

func (st *Store) IsPinned(cid object.CID) (bool, error)

func (*Store) Pin

func (st *Store) Pin(
	cid object.CID,
) 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(
	cid object.CID,
) error

func (*Store) RemovePin

func (st *Store) RemovePin(
	cid object.CID,
) error

func (*Store) UpdateTTL

func (st *Store) UpdateTTL(
	cid object.CID,
	minutes int,
) error