moduletools

Documentation

Overview

moduletools contains helpers that are passed to modules as part of their capability methods

Index

• type ClassConfig
• type InitParams
  • func (p *InitParams) GetAppState() interface{}
  • func (p *InitParams) GetConfig() config.Config
  • func (p *InitParams) GetLogger() logrus.FieldLogger
  • func (p *InitParams) GetStorageProvider() StorageProvider
• type ModuleInitParams
  • func NewInitParams(storageProvider StorageProvider, appState interface{}, config config.Config, ...) ModuleInitParams
• type PropsComparatorFactory
• type ScanFn
• type Storage
• type StorageProvider
• type VectorizablePropsComparator
  • func NewVectorizablePropsComparator(propsSchema []*models.Property, nextProps, prevProps models.PropertySchema, ...) VectorizablePropsComparator
  • func NewVectorizablePropsComparatorDummy(propsSchema []*models.Property, nextProps models.PropertySchema) VectorizablePropsComparator
• type VectorizablePropsIterator

Types

type ClassConfig

type ClassConfig interface {
	TargetVector() string
	Tenant() string
	Class() map[string]interface{}
	ClassByModuleName(moduleName string) map[string]interface{}
	Property(propName string) map[string]interface{}
}

ClassConfig is a helper type which is passed to the module to read it's per-class config. This is - among other places - used when vectorizing and when validation schema config

type InitParams

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

func (*InitParams) GetAppState

func (p *InitParams) GetAppState() interface{}

func (*InitParams) GetConfig

func (p *InitParams) GetConfig() config.Config

func (*InitParams) GetLogger

func (p *InitParams) GetLogger() logrus.FieldLogger

func (*InitParams) GetStorageProvider

func (p *InitParams) GetStorageProvider() StorageProvider

type ModuleInitParams

type ModuleInitParams interface {
	GetStorageProvider() StorageProvider
	GetAppState() interface{}
	GetLogger() logrus.FieldLogger
	GetConfig() config.Config
}

func NewInitParams

func NewInitParams(storageProvider StorageProvider, appState interface{},
	config config.Config, logger logrus.FieldLogger,
) ModuleInitParams

type PropsComparatorFactory

type PropsComparatorFactory func() (VectorizablePropsComparator, error)

type ScanFn

type ScanFn func(k, v []byte) (bool, error)

type Storage

type Storage interface {
	Get(key []byte) ([]byte, error)
	Scan(scan ScanFn) error
	Put(key, value []byte) error
}

type StorageProvider

type StorageProvider interface {
	Storage(name string) (Storage, error)
	DataPath() string
}

type VectorizablePropsComparator

type VectorizablePropsComparator interface {
	PropsIterator() VectorizablePropsIterator
	IsChanged(propName string) bool
	PrevVector() []float32
	PrevVectorForName(targetVector string) []float32
}

func NewVectorizablePropsComparator

func NewVectorizablePropsComparator(propsSchema []*models.Property,
	nextProps, prevProps models.PropertySchema, prevVector []float32,
	prevVectors models.Vectors,
) VectorizablePropsComparator

func NewVectorizablePropsComparatorDummy

func NewVectorizablePropsComparatorDummy(propsSchema []*models.Property, nextProps models.PropertySchema,
) VectorizablePropsComparator

type VectorizablePropsIterator

type VectorizablePropsIterator interface {
	Next() (propName string, propValue interface{}, ok bool)
}