config

Documentation

Index

• Constants
• func ProvideIndex[T search.Searchable](ctx context.Context, logger logging.Logger, ...) (search.Index[T], error)
• type Config
  • func (cfg *Config) ValidateWithContext(ctx context.Context) error

Constants

const (
	// ElasticsearchProvider represents the elasticsearch search index provider.
	ElasticsearchProvider = "elasticsearch"
	// AlgoliaProvider represents the algolia search index provider.
	AlgoliaProvider = "algolia"
)

Functions

func ProvideIndex

func ProvideIndex[T search.Searchable](ctx context.Context, logger logging.Logger, tracerProvider tracing.TracerProvider, cfg *Config, indexName string) (search.Index[T], error)

ProvideIndex validates a Config struct.

Types

type Config

type Config struct {
	Algolia       *algolia.Config       `json:"algolia"       toml:"algolia,omitempty"`
	Elasticsearch *elasticsearch.Config `json:"elasticsearch" toml:"elasticsearch,omitempty"`
	Provider      string                `json:"provider"      toml:"provider,omitempty"`
	// contains filtered or unexported fields
}

Config contains settings regarding search indices.

func (*Config) ValidateWithContext

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.