search

package

v0.0.0-...-9518a5e Latest Latest Go to latest Published: Oct 6, 2021 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.com/verygoodsoftwarenotvirus/todo

Links

Open Source Insights

Documentation ¶

Overview ¶

Package search defines an interface for a search index management structure

Index ¶

Constants
type Config
- func (cfg *Config) ValidateWithContext(ctx context.Context) error
type IndexManager
type IndexManagerProvider
type IndexName
type IndexPath

Constants ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Provider string `json:"provider" mapstructure:"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.

type IndexManager ¶

type IndexManager interface {
	Index(ctx context.Context, id string, value interface{}) error
	Search(ctx context.Context, query, accountID string) (ids []string, err error)
	SearchForAdmin(ctx context.Context, query string) (ids []string, err error)
	Delete(ctx context.Context, id string) (err error)
}

IndexManager is our wrapper interface for a text search index.

type IndexManagerProvider ¶

type IndexManagerProvider func(context.Context, logging.Logger, *http.Client, IndexPath, IndexName, ...string) (IndexManager, error)

IndexManagerProvider is a function that provides an IndexManager for a given index.

type IndexName ¶

type IndexName string

IndexName is a type alias for dependency injection's sake.

type IndexPath ¶

type IndexPath string

IndexPath is a type alias for dependency injection's sake.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
elasticsearch Package elasticsearch provides an interface-compatible wrapper around the elasticsearch indexer	Package elasticsearch provides an interface-compatible wrapper around the elasticsearch indexer
mock Package mocksearch provides an interface-compatible search index mock	Package mocksearch provides an interface-compatible search index mock

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL