engine

Documentation

Index

• type Engine
  • func New(resultCache cache.Interface, valueStore indexer.Interface, options ...Option) *Engine
  • func (e *Engine) Close() error
  • func (e *Engine) Flush() error
  • func (e *Engine) Get(m multihash.Multihash) ([]indexer.Value, bool, error)
  • func (e *Engine) Iter() (indexer.Iterator, error)
  • func (e *Engine) Put(value indexer.Value, mhs ...multihash.Multihash) error
  • func (e *Engine) Remove(value indexer.Value, mhs ...multihash.Multihash) error
  • func (e *Engine) RemoveProvider(ctx context.Context, providerID peer.ID) error
  • func (e *Engine) RemoveProviderContext(providerID peer.ID, contextID []byte) error
  • func (e *Engine) Size() (int64, error)
  • func (e *Engine) Stats() (*indexer.Stats, error)
• type Option
  • func WithCacheOnPut(on bool) Option
  • func WithDHBatchSize(size int) Option
  • func WithDHKeyShard(enabled bool) Option
  • func WithDHShardConcurrency(n int) Option
  • func WithDHStore(dhsURL string) Option
  • func WithDHStoreCluster(clusterUrls []string) Option
  • func WithHttpClientTimeout(timeout time.Duration) Option
  • func WithVSNoNewMH(ok bool) Option

Types

type Engine

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

Engine is an implementation of indexer.Interface that combines a result cache and a value store.

func New

func New(resultCache cache.Interface, valueStore indexer.Interface, options ...Option) *Engine

New implements the indexer.Interface. It creates a new Engine with the given result cache and value store.

func (*Engine) Close

func (e *Engine) Close() error

func (*Engine) Flush

func (e *Engine) Flush() error

func (*Engine) Get

func (e *Engine) Get(m multihash.Multihash) ([]indexer.Value, bool, error)

func (*Engine) Iter

func (e *Engine) Iter() (indexer.Iterator, error)

func (*Engine) Put

func (e *Engine) Put(value indexer.Value, mhs ...multihash.Multihash) error

func (*Engine) Remove

func (e *Engine) Remove(value indexer.Value, mhs ...multihash.Multihash) error

func (*Engine) RemoveProvider

func (e *Engine) RemoveProvider(ctx context.Context, providerID peer.ID) error

func (*Engine) RemoveProviderContext

func (e *Engine) RemoveProviderContext(providerID peer.ID, contextID []byte) error

func (*Engine) Size

func (e *Engine) Size() (int64, error)

func (*Engine) Stats

func (e *Engine) Stats() (*indexer.Stats, error)

type Option

type Option func(*config) error

func WithCacheOnPut

func WithCacheOnPut(on bool) Option

WithCacheOnPut sets whether or not entries are cached on Put.

func WithDHBatchSize

func WithDHBatchSize(size int) Option

WithDHBatchSize configures the batch size when sending batches of merge requests to DHStore. A value < 1 results in the default size.

func WithDHKeyShard

func WithDHKeyShard(enabled bool) Option

WithDHKeyShard enables/disabled the dhstore key sharding for the core. When key sharding is enabled (on by default), a shard key is included with each metadata put request, and a seperate merge request with a shard key is sent for each multihash. Context delete requests are also sent with a shard key.

func WithDHShardConcurrency

func WithDHShardConcurrency(n int) Option

func WithDHStore

func WithDHStore(dhsURL string) Option

WithDHStore sets the base URL for the dhstore service, and tells the core to send its values to the dhstore.

func WithDHStoreCluster

func WithDHStoreCluster(clusterUrls []string) Option

WithDHStoreCluster provide addional URLs that the core will send delete requests to. Deletes will be send to the dhstoreURL as well as to all dhstoreClusterURLs. This is required as deletes need to be applied to all nodes until consistent hashing is implemented. dhstoreURL shouldn't be included in this list.

func WithHttpClientTimeout

func WithHttpClientTimeout(timeout time.Duration) Option

WithHttpClientTimeout sets http timeout for queries to DHStore

func WithVSNoNewMH

func WithVSNoNewMH(ok bool) Option

WithVSNoNewMH blocks putting new multihashes into the value store when set to true. New indexes will still be send to the DHStore service if one is configured.