search

package
v8.4.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 13, 2022 License: Apache-2.0 Imports: 14 Imported by: 4

Documentation

Overview

Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.

Index

Constants

This section is empty.

Variables

View Source 
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Functions

This section is empty.

Types

type NewSearch 

type NewSearch func(index string) *Search

NewSearch type alias for index.

func NewSearchFunc 

func NewSearchFunc(tp elastictransport.Interface) NewSearch

NewSearchFunc returns a new instance of Search with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request 

type Request struct {
	Aggregations map[string]types.AggregationContainer `json:"aggregations,omitempty"`

	Collapse *types.FieldCollapse `json:"collapse,omitempty"`

	// DocvalueFields Array of wildcard (*) patterns. The request returns doc values for field
	// names matching these patterns in the hits.fields property of the response.
	DocvalueFields []types.FieldAndFormat `json:"docvalue_fields,omitempty"`

	// Explain If true, returns detailed information about score computation as part of a
	// hit.
	Explain *bool `json:"explain,omitempty"`

	// Fields Array of wildcard (*) patterns. The request returns values for field names
	// matching these patterns in the hits.fields property of the response.
	Fields []types.FieldAndFormat `json:"fields,omitempty"`

	// From Starting document offset. By default, you cannot page through more than
	// 10,000
	// hits using the from and size parameters. To page through more hits, use the
	// search_after parameter.
	From *int `json:"from,omitempty"`

	Highlight *types.Highlight `json:"highlight,omitempty"`

	// IndicesBoost Boosts the _score of documents from specified indices.
	IndicesBoost []map[types.IndexName]float64 `json:"indices_boost,omitempty"`

	// MinScore Minimum _score for matching documents. Documents with a lower _score are
	// not included in the search results.
	MinScore *float64 `json:"min_score,omitempty"`

	// Pit Limits the search to a point in time (PIT). If you provide a PIT, you
	// cannot specify an <index> in the request path.
	Pit *types.PointInTimeReference `json:"pit,omitempty"`

	PostFilter *types.QueryContainer `json:"post_filter,omitempty"`

	Profile *bool `json:"profile,omitempty"`

	// Query Defines the search definition using the Query DSL.
	Query *types.QueryContainer `json:"query,omitempty"`

	Rescore []types.Rescore `json:"rescore,omitempty"`

	// RuntimeMappings Defines one or more runtime fields in the search request. These fields take
	// precedence over mapped fields with the same name.
	RuntimeMappings *types.RuntimeFields `json:"runtime_mappings,omitempty"`

	// ScriptFields Retrieve a script evaluation (based on different fields) for each hit.
	ScriptFields map[string]types.ScriptField `json:"script_fields,omitempty"`

	SearchAfter *types.SortResults `json:"search_after,omitempty"`

	// SeqNoPrimaryTerm If true, returns sequence number and primary term of the last modification
	// of each hit. See Optimistic concurrency control.
	SeqNoPrimaryTerm *bool `json:"seq_no_primary_term,omitempty"`

	// Size The number of hits to return. By default, you cannot page through more
	// than 10,000 hits using the from and size parameters. To page through more
	// hits, use the search_after parameter.
	Size *int `json:"size,omitempty"`

	Slice *types.SlicedScroll `json:"slice,omitempty"`

	Sort *types.Sort `json:"sort,omitempty"`

	// Source_ Indicates which source fields are returned for matching documents. These
	// fields are returned in the hits._source property of the search response.
	Source_ *types.SourceConfig `json:"_source,omitempty"`

	// Stats Stats groups to associate with the search. Each group maintains a statistics
	// aggregation for its associated searches. You can retrieve these stats using
	// the indices stats API.
	Stats []string `json:"stats,omitempty"`

	// StoredFields List of stored fields to return as part of a hit. If no fields are specified,
	// no stored fields are included in the response. If this field is specified,
	// the _source
	// parameter defaults to false. You can pass _source: true to return both source
	// fields
	// and stored fields in the search response.
	StoredFields *types.Fields `json:"stored_fields,omitempty"`

	Suggest *types.Suggester `json:"suggest,omitempty"`

	// TerminateAfter Maximum number of documents to collect for each shard. If a query reaches
	// this
	// limit, Elasticsearch terminates the query early. Elasticsearch collects
	// documents
	// before sorting. Defaults to 0, which does not terminate query execution
	// early.
	TerminateAfter *int64 `json:"terminate_after,omitempty"`

	// Timeout Specifies the period of time to wait for a response from each shard. If no
	// response
	// is received before the timeout expires, the request fails and returns an
	// error.
	// Defaults to no timeout.
	Timeout *string `json:"timeout,omitempty"`

	// TrackScores If true, calculate and return document scores, even if the scores are not
	// used for sorting.
	TrackScores *bool `json:"track_scores,omitempty"`

	// TrackTotalHits Number of hits matching the query to count accurately. If true, the exact
	// number of hits is returned at the cost of some performance. If false, the
	// response does not include the total number of hits matching the query.
	// Defaults to 10,000 hits.
	TrackTotalHits *types.TrackHits `json:"track_total_hits,omitempty"`

	// Version If true, returns document version as part of a hit.
	Version *bool `json:"version,omitempty"`
}

Request holds the request body struct for the package search

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/fleet/search/SearchRequest.ts#L54-L255

type RequestBuilder 

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

RequestBuilder is the builder API for the search.Request

func NewRequestBuilder 

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Aggregations 

func (rb *RequestBuilder) Aggregations(values map[string]*types.AggregationContainerBuilder) *RequestBuilder

func (*RequestBuilder) Build 

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Collapse 

func (rb *RequestBuilder) Collapse(collapse *types.FieldCollapseBuilder) *RequestBuilder

func (*RequestBuilder) DocvalueFields 

func (rb *RequestBuilder) DocvalueFields(docvalue_fields []types.FieldAndFormatBuilder) *RequestBuilder

func (*RequestBuilder) Explain 

func (rb *RequestBuilder) Explain(explain bool) *RequestBuilder

func (*RequestBuilder) Fields 

func (rb *RequestBuilder) Fields(fields []types.FieldAndFormatBuilder) *RequestBuilder

func (*RequestBuilder) From 

func (rb *RequestBuilder) From(from int) *RequestBuilder

func (*RequestBuilder) FromJSON 

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Highlight 

func (rb *RequestBuilder) Highlight(highlight *types.HighlightBuilder) *RequestBuilder

func (*RequestBuilder) IndicesBoost 

func (rb *RequestBuilder) IndicesBoost(value ...map[types.IndexName]float64) *RequestBuilder

func (*RequestBuilder) MinScore 

func (rb *RequestBuilder) MinScore(minscore float64) *RequestBuilder

func (*RequestBuilder) Pit 

func (rb *RequestBuilder) Pit(pit *types.PointInTimeReferenceBuilder) *RequestBuilder

func (*RequestBuilder) PostFilter 

func (rb *RequestBuilder) PostFilter(postfilter *types.QueryContainerBuilder) *RequestBuilder

func (*RequestBuilder) Profile 

func (rb *RequestBuilder) Profile(profile bool) *RequestBuilder

func (*RequestBuilder) Query 

func (rb *RequestBuilder) Query(query *types.QueryContainerBuilder) *RequestBuilder

func (*RequestBuilder) Rescore 

func (rb *RequestBuilder) Rescore(arg []types.Rescore) *RequestBuilder

func (*RequestBuilder) RuntimeMappings 

func (rb *RequestBuilder) RuntimeMappings(runtimemappings *types.RuntimeFieldsBuilder) *RequestBuilder

func (*RequestBuilder) ScriptFields 

func (rb *RequestBuilder) ScriptFields(values map[string]*types.ScriptFieldBuilder) *RequestBuilder

func (*RequestBuilder) SearchAfter 

func (rb *RequestBuilder) SearchAfter(searchafter *types.SortResultsBuilder) *RequestBuilder

func (*RequestBuilder) SeqNoPrimaryTerm 

func (rb *RequestBuilder) SeqNoPrimaryTerm(seqnoprimaryterm bool) *RequestBuilder

func (*RequestBuilder) Size 

func (rb *RequestBuilder) Size(size int) *RequestBuilder

func (*RequestBuilder) Slice 

func (rb *RequestBuilder) Slice(slice *types.SlicedScrollBuilder) *RequestBuilder

func (*RequestBuilder) Sort 

func (rb *RequestBuilder) Sort(sort *types.SortBuilder) *RequestBuilder

func (*RequestBuilder) Source_ 

func (rb *RequestBuilder) Source_(source_ *types.SourceConfigBuilder) *RequestBuilder

func (*RequestBuilder) Stats 

func (rb *RequestBuilder) Stats(stats ...string) *RequestBuilder

func (*RequestBuilder) StoredFields 

func (rb *RequestBuilder) StoredFields(storedfields *types.FieldsBuilder) *RequestBuilder

func (*RequestBuilder) Suggest 

func (rb *RequestBuilder) Suggest(suggest *types.SuggesterBuilder) *RequestBuilder

func (*RequestBuilder) TerminateAfter 

func (rb *RequestBuilder) TerminateAfter(terminateafter int64) *RequestBuilder

func (*RequestBuilder) Timeout 

func (rb *RequestBuilder) Timeout(timeout string) *RequestBuilder

func (*RequestBuilder) TrackScores 

func (rb *RequestBuilder) TrackScores(trackscores bool) *RequestBuilder

func (*RequestBuilder) TrackTotalHits 

func (rb *RequestBuilder) TrackTotalHits(tracktotalhits *types.TrackHitsBuilder) *RequestBuilder

func (*RequestBuilder) Version 

func (rb *RequestBuilder) Version(version bool) *RequestBuilder
type Search struct {
	// contains filtered or unexported fields
}

func New 

func New(tp elastictransport.Interface) *Search

Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.

func (*Search) AllowNoIndices 

func (r *Search) AllowNoIndices(b bool) *Search

API name: allow_no_indices

func (*Search) AllowPartialSearchResults 

func (r *Search) AllowPartialSearchResults(b bool) *Search

AllowPartialSearchResults If true, returns partial results if there are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures). If false, returns an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results` which is true by default. API name: allow_partial_search_results

func (*Search) AnalyzeWildcard 

func (r *Search) AnalyzeWildcard(b bool) *Search

API name: analyze_wildcard

func (*Search) Analyzer 

func (r *Search) Analyzer(value string) *Search

API name: analyzer

func (*Search) BatchedReduceSize 

func (r *Search) BatchedReduceSize(value string) *Search

API name: batched_reduce_size

func (*Search) CcsMinimizeRoundtrips 

func (r *Search) CcsMinimizeRoundtrips(b bool) *Search

API name: ccs_minimize_roundtrips

func (*Search) DefaultOperator 

func (r *Search) DefaultOperator(enum operator.Operator) *Search

API name: default_operator

func (*Search) Df 

func (r *Search) Df(value string) *Search

API name: df

func (Search) Do 

func (r Search) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*Search) DocvalueFields 

func (r *Search) DocvalueFields(value string) *Search

API name: docvalue_fields

func (*Search) ExpandWildcards 

func (r *Search) ExpandWildcards(value string) *Search

API name: expand_wildcards

func (*Search) Explain 

func (r *Search) Explain(b bool) *Search

API name: explain

func (*Search) From 

func (r *Search) From(i int) *Search

API name: from

func (*Search) Header 

func (r *Search) Header(key, value string) *Search

Header set a key, value pair in the Search headers map.

func (*Search) HttpRequest 

func (r *Search) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Search) IgnoreThrottled 

func (r *Search) IgnoreThrottled(b bool) *Search

API name: ignore_throttled

func (*Search) IgnoreUnavailable 

func (r *Search) IgnoreUnavailable(b bool) *Search

API name: ignore_unavailable

func (*Search) Index 

func (r *Search) Index(v string) *Search

Index A single target to search. If the target is an index alias, it must resolve to a single index. API Name: index

func (*Search) Lenient 

func (r *Search) Lenient(b bool) *Search

API name: lenient

func (*Search) MaxConcurrentShardRequests 

func (r *Search) MaxConcurrentShardRequests(value string) *Search

API name: max_concurrent_shard_requests

func (*Search) MinCompatibleShardNode 

func (r *Search) MinCompatibleShardNode(value string) *Search

API name: min_compatible_shard_node

func (*Search) PreFilterShardSize 

func (r *Search) PreFilterShardSize(value string) *Search

API name: pre_filter_shard_size

func (*Search) Preference 

func (r *Search) Preference(value string) *Search

API name: preference

func (*Search) Q 

func (r *Search) Q(value string) *Search

API name: q

func (*Search) Raw 

func (r *Search) Raw(raw json.RawMessage) *Search

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Search) Request 

func (r *Search) Request(req *Request) *Search

Request allows to set the request property with the appropriate payload.

func (*Search) RequestCache 

func (r *Search) RequestCache(b bool) *Search

API name: request_cache

func (*Search) RestTotalHitsAsInt 

func (r *Search) RestTotalHitsAsInt(b bool) *Search

API name: rest_total_hits_as_int

func (*Search) Routing 

func (r *Search) Routing(value string) *Search

API name: routing

func (*Search) Scroll 

func (r *Search) Scroll(value string) *Search

API name: scroll

func (*Search) SearchType 

func (r *Search) SearchType(enum searchtype.SearchType) *Search

API name: search_type

func (*Search) SeqNoPrimaryTerm 

func (r *Search) SeqNoPrimaryTerm(b bool) *Search

API name: seq_no_primary_term

func (*Search) Size 

func (r *Search) Size(i int) *Search

API name: size

func (*Search) Sort 

func (r *Search) Sort(value string) *Search

API name: sort

func (*Search) SourceExcludes_ 

func (r *Search) SourceExcludes_(value string) *Search

API name: _source_excludes

func (*Search) SourceIncludes_ 

func (r *Search) SourceIncludes_(value string) *Search

API name: _source_includes

func (*Search) Source_ 

func (r *Search) Source_(value string) *Search

API name: _source

func (*Search) Stats 

func (r *Search) Stats(value string) *Search

API name: stats

func (*Search) StoredFields 

func (r *Search) StoredFields(value string) *Search

API name: stored_fields

func (*Search) SuggestField 

func (r *Search) SuggestField(value string) *Search

SuggestField Specifies which field to use for suggestions. API name: suggest_field

func (*Search) SuggestMode 

func (r *Search) SuggestMode(enum suggestmode.SuggestMode) *Search

API name: suggest_mode

func (*Search) SuggestSize 

func (r *Search) SuggestSize(value string) *Search

API name: suggest_size

func (*Search) SuggestText 

func (r *Search) SuggestText(value string) *Search

SuggestText The source text for which the suggestions should be returned. API name: suggest_text

func (*Search) TerminateAfter 

func (r *Search) TerminateAfter(value string) *Search

API name: terminate_after

func (*Search) Timeout 

func (r *Search) Timeout(value string) *Search

API name: timeout

func (*Search) TrackScores 

func (r *Search) TrackScores(b bool) *Search

API name: track_scores

func (*Search) TrackTotalHits 

func (r *Search) TrackTotalHits(value string) *Search

API name: track_total_hits

func (*Search) TypedKeys 

func (r *Search) TypedKeys(b bool) *Search

API name: typed_keys

func (*Search) Version 

func (r *Search) Version(b bool) *Search

API name: version

func (*Search) WaitForCheckpoints 

func (r *Search) WaitForCheckpoints(value string) *Search

WaitForCheckpoints A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search. API name: wait_for_checkpoints

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.