sqlobjectstore

Documentation

Index

• Constants
• type LookupOption
  • func FilterByHash(h object.Hash) LookupOption
  • func FilterByObjectType(typePatterns ...string) LookupOption
  • func FilterByOwner(h crypto.PublicKey) LookupOption
  • func FilterByStreamHash(h object.Hash) LookupOption
• type LookupOptions
• type Option
  • func WithTTL(minutes int) Option
• type Options
• type SqlStoreFilter
• type SqlStorePubSub
  • func NewSqlStorePubSub() SqlStorePubSub
• type SqlStoreSubscription
• type Store
  • func New(db *sql.DB) (*Store, error)
  • func (st *Store) Close() error
  • func (st *Store) Filter(lookupOptions ...LookupOption) ([]object.Object, error)
  • func (st *Store) Get(hash object.Hash) (object.Object, error)
  • func (st *Store) GetRelations(parent object.Hash) ([]object.Hash, error)
  • func (st *Store) Put(obj object.Object, opts ...Option) error
  • func (st *Store) Remove(hash object.Hash) error
  • func (st *Store) Subscribe(lookupOptions ...LookupOption) SqlStoreSubscription
  • func (st *Store) UpdateTTL(hash object.Hash, minutes int) error

Constants

const (
	// ErrNotFound is returned when a requested object or hash is not found
	ErrNotFound = errors.Error("not found")
)

Types

type LookupOption

type LookupOption func(*LookupOptions)

LookupOptions

func FilterByHash

func FilterByHash(h object.Hash) LookupOption

func FilterByObjectType

func FilterByObjectType(typePatterns ...string) LookupOption

func FilterByOwner

func FilterByOwner(h crypto.PublicKey) LookupOption

func FilterByStreamHash

func FilterByStreamHash(h object.Hash) LookupOption

type LookupOptions

type LookupOptions struct {
	// Lookups are used to perform db queries for these filters
	// TODO find a better name for this
	Lookups struct {
		ObjectHashes []object.Hash
		StreamHashes []object.Hash
		ContentTypes []string
		Owners       []crypto.PublicKey
	}
	// filters are the lookups equivalents for matching objects for pubsub
	Filters []SqlStoreFilter
}

LookupOptions

type Option

type Option func(*Options)

func WithTTL

func WithTTL(minutes int) Option

type Options

type Options struct {
	TTL int // minutes
}

type SqlStoreFilter

type SqlStoreFilter func(object.Object) bool

type SqlStorePubSub

type SqlStorePubSub interface {
	Publish(object.Object)
	Subscribe(...SqlStoreFilter) SqlStoreSubscription
}

SqlStorePubSub -

func NewSqlStorePubSub

func NewSqlStorePubSub() SqlStorePubSub

NewSqlStore constructs and returns a new SqlStorePubSub

type SqlStoreSubscription

type SqlStoreSubscription interface {
	Next() (object.Object, error)
	Cancel()
}

SqlStoreSubscription is returned for every subscription

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(
	lookupOptions ...LookupOption,
) ([]object.Object, error)

func (*Store) Get

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

func (*Store) GetRelations

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

func (*Store) Put

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

func (*Store) Remove

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

func (*Store) Subscribe

func (st *Store) Subscribe(
	lookupOptions ...LookupOption,
) SqlStoreSubscription

func (*Store) UpdateTTL

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