search

type Aggregation struct {
	Type    AggregationType `json:"type"`
	Field   string          `json:"field"`
	Filters []Filter        `json:"filters"`
}

type AggregationType string

type BoolFilter struct {
	Field string `json:"field"`
	Value bool   `json:"value"`
}

type Bucket interface {
	BucketType() AggregationType
}

type DateRangeBucket struct {
	Min time.Time `json:"min"`
	Max time.Time `json:"max"`
}

type DateRangeFilter struct {
	Field string    `json:"field"`
	Min   time.Time `json:"min"`
	Max   time.Time `json:"max"`
}

type Filter interface {
	CacheKey() string
	// contains filtered or unexported methods
}

type Hit struct {
	// ID is the unique identifier of the stored entity. It might not match the
	// id of the entity in case it was indexed multiple times.
	ID string `json:"id"`
	// Type is the type of the document.
	Type string `json:"type"`
	// Raw contains the raw data of the document in the form of a json string.
	Raw string `json:"raw"`
}

type Indexable interface {
	// Identifier returns an id which should uniquely identify the object for
	// its type.
	Identifier() string

	// Type returns the type of the object.
	Type() string

	// QueryText returns the string to index for a text search.
	QueryText() string

	// SearchFields returns a map of additional fields to be indexed. Those
	// fields can be used for filtering or aggregations.
	SearchFields() map[string]interface{}
}

type NotFilter struct {
	Filter Filter
}

type NumericRangeFilter struct {
	Field string   `json:"field"`
	Min   *float64 `json:"min"`
	Max   *float64 `json:"max"`
}

type Options struct {
	// Query is the search query used for a text search.
	Query string `json:"query"`

	// Sort is the field, that should be sorted by.
	// When left empty, the default sorting is used.
	Sort string `json:"sort"`

	// SortDescending defines the sort order.
	SortDescending bool `json:"sortAscending"`

	// Page is current page.
	Page int `json:"page"`

	// PageSize defines the number of hits returned per page.
	//
	// PageSize is infinite when set to 0.
	PageSize int `json:"pageSize"`

	// Filters is a list of filters, that reduce the search result. All filters
	// are combined with AND logic in addition with the search query.
	Filters []Filter `json:"filter"`

	// Aggregations is a map of aggregations, to perform aggregations on fields.
	// The provided map key can be used to identify the corresponding bucket in
	// the result.
	Aggregations map[string]Aggregation `json:"aggregations"`
}

type Result struct {
	// Hits are the search hits for the current pagination.
	Hits []Hit `json:"hits"`

	// Total is the total number of search hits.
	// It is independet of the current pagination.
	Total uint64 `json:"total"`

	// Buckets is a set of aggregation buckets.
	// The map key corresponds to aggregation name.
	Buckets map[string]Bucket `json:"buckets"`
}

type Service interface {
	// Index takes one or many indexable document and adds them to the search index.
	Index(docs ...Indexable) error

	// Delete deletes the document with the given type and id.
	// Note: both type and id have to be provided in order to uniquely identify
	// the document.
	Delete(docType, id string) error

	// Search performes a full text search on all indexed documents.
	// Performes a wildcard match for empty queries.
	// In addition to the search query a set of additional search options can be
	// provided.
	Search(ctx context.Context, opts *Options) (*Result, error)

	// LastModified returns the last time, the store was updated. This can be
	// used to invalidate a client side cache.
	LastModified() time.Time

	// Stops the search service.
	Stop()
}

type Term struct {
	Term  string `json:"term"`
	Count int    `json:"count"`
}

type TermsBucket []Term

type TermsFilter struct {
	Field string   `json:"field"`
	Terms []string `json:"terms"`
}