sqlobjectstore

Documentation

Index

• type Event
• type EventAction
• type FilterOption
  • func FilterByHash(hs ...tilde.Digest) FilterOption
  • func FilterByObjectType(typePatterns ...string) FilterOption
  • func FilterByOwner(owners ...did.DID) FilterOption
  • func FilterByStreamHash(hs ...tilde.Digest) 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 tilde.Digest) (*object.Object, error)
  • func (st *Store) GetByStream(streamRootHash tilde.Digest) (object.ReadCloser, error)
  • func (st *Store) GetByType(objectType string) (object.ReadCloser, error)
  • func (st *Store) GetKey(publicKeyDigest tilde.Digest) (*crypto.PrivateKey, error)
  • func (st *Store) GetPinned() ([]tilde.Digest, error)
  • func (st *Store) GetRelations(parent tilde.Digest) ([]tilde.Digest, error)
  • func (st *Store) GetStreamLeaves(streamRootHash tilde.Digest) ([]tilde.Digest, error)
  • func (st *Store) IsPinned(hash tilde.Digest) (bool, error)
  • func (st *Store) ListHashes() ([]tilde.Digest, error)
  • func (st *Store) ListenForUpdates() (updates <-chan Event, cancel func())
  • func (st *Store) Pin(hash tilde.Digest) error
  • func (st *Store) Put(obj *object.Object) error
  • func (st *Store) PutKey(privateKey crypto.PrivateKey) error
  • func (st *Store) PutWithTTL(obj *object.Object, ttl time.Duration) error
  • func (st *Store) Remove(hash tilde.Digest) error
  • func (st *Store) RemovePin(hash tilde.Digest) error
  • func (st *Store) UpdateTTL(hash tilde.Digest, minutes int) error

Types

type Event

type Event struct {
	Action     EventAction
	ObjectHash tilde.Digest
}

type EventAction

type EventAction string

const (
	ObjectInserted EventAction = "objectInserted"
	ObjectRemoved  EventAction = "objectRemoved"
	ObjectPinned   EventAction = "objectPinned"
	ObjectUnpinned EventAction = "objectUnpinned"
)

type FilterOption

type FilterOption func(*FilterOptions)

FilterOptions

func FilterByHash

func FilterByHash(hs ...tilde.Digest) FilterOption

func FilterByObjectType

func FilterByObjectType(typePatterns ...string) FilterOption

func FilterByOwner

func FilterByOwner(owners ...did.DID) FilterOption

func FilterByStreamHash

func FilterByStreamHash(hs ...tilde.Digest) 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 []tilde.Digest
		StreamHashes []tilde.Digest
		ContentTypes []string
		Owners       []string
		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 tilde.Digest,
) (*object.Object, error)

func (*Store) GetByStream

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

func (*Store) GetByType

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

func (*Store) GetKey

func (st *Store) GetKey(
	publicKeyDigest tilde.Digest,
) (*crypto.PrivateKey, error)

func (*Store) GetPinned

func (st *Store) GetPinned() ([]tilde.Digest, error)

func (*Store) GetRelations

func (st *Store) GetRelations(
	parent tilde.Digest,
) ([]tilde.Digest, error)

func (*Store) GetStreamLeaves

func (st *Store) GetStreamLeaves(
	streamRootHash tilde.Digest,
) ([]tilde.Digest, error)

func (*Store) IsPinned

func (st *Store) IsPinned(hash tilde.Digest) (bool, error)

func (*Store) ListHashes

func (st *Store) ListHashes() ([]tilde.Digest, error)

func (*Store) ListenForUpdates

func (st *Store) ListenForUpdates() (
	updates <-chan Event,
	cancel func(),
)

func (*Store) Pin

func (st *Store) Pin(
	hash tilde.Digest,
) error

func (*Store) Put

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

func (*Store) PutKey

func (st *Store) PutKey(
	privateKey crypto.PrivateKey,
) error

func (*Store) PutWithTTL

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

func (*Store) Remove

func (st *Store) Remove(
	hash tilde.Digest,
) error

func (*Store) RemovePin

func (st *Store) RemovePin(
	hash tilde.Digest,
) error

func (*Store) UpdateTTL

func (st *Store) UpdateTTL(
	hash tilde.Digest,
	minutes int,
) error