search

type Atom string

type Backend interface {
	// Open returns an Index for the given name.
	Open(name string) (Index, error)

	// Close releases any resources held by the backend.
	Close() error
}

type Facet struct {
	// Name is the facet field name.
	Name string

	// Value is the facet value (Atom, Range, or string).
	Value interface{}
}

type FacetResult struct {
	// Name is the facet field name.
	Name string

	// Value is the facet value.
	Value interface{}

	// Count is the number of documents with this facet value.
	Count int
}

type FacetSearchOption struct {
	// Name is the facet field name (empty for auto-discovery).
	Name string

	// ValueLimit limits the number of values returned per facet.
	ValueLimit int

	// DiscoveryLimit limits the number of facets discovered (for auto-discovery).
	DiscoveryLimit int
}

type Index interface {
	// Search performs a search query and returns an iterator.
	Search(ctx context.Context, query string, opts *SearchOptions) Iterator

	// Put indexes a document with the given ID.
	Put(ctx context.Context, id string, doc interface{}) (string, error)

	// Get retrieves a document by ID.
	Get(ctx context.Context, id string, doc interface{}) error

	// Delete removes a document by ID.
	Delete(ctx context.Context, id string) error
}

type Iterator interface {
	// Next returns the next result. Returns Done when iteration is complete.
	Next(dst interface{}) (string, error)

	// Count returns the total number of results (may be approximate).
	Count() int

	// Facets returns facet results if requested.
	Facets() ([][]FacetResult, error)
}

type Range struct {
	Start float64
	End   float64
}

type SearchOptions struct {
	// IDsOnly returns only document IDs, not full documents.
	IDsOnly bool

	// Limit is the maximum number of results to return.
	Limit int

	// Offset is the number of results to skip.
	Offset int

	// Sort configures result sorting.
	Sort *SortOptions

	// Refinements filters results by facet values.
	Refinements []Facet

	// Facets configures which facets to return.
	Facets []FacetSearchOption

	// CountAccuracy configures count accuracy.
	CountAccuracy int
}

type SortExpression struct {
	// Expr is the field to sort by.
	Expr string

	// Reverse sorts in descending order if true.
	Reverse bool

	// Default is the default value for missing fields.
	Default interface{}
}

type SortOptions struct {
	Expressions []SortExpression
}