elasticxmsearch

Documentation

Index

• type Item
• type Option
  • func AllowNoIndices(b bool) Option
  • func CcsMinimizeRoundtrips(b bool) Option
  • func ErrorTrace(b bool) Option
  • func ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) Option
  • func FilterPath(s ...string) Option
  • func Human(b bool) Option
  • func IgnoreThrottled(b bool) Option
  • func IgnoreUnavailable(b bool) Option
  • func MaxConcurrentSearches(s string) Option
  • func MaxConcurrentShardRequests(s string) Option
  • func PreFilterShardSize(s string) Option
  • func Pretty(b bool) Option
  • func RestTotalHitsAsInt(b bool) Option
  • func Routing(r string) Option
  • func SearchType(s searchtype.SearchType) Option
  • func TypedKeys(b bool) Option

Types

type Item

type Item struct {
	Header types.MultisearchHeader
	Body   types.MultisearchBody
}

type Option

type Option func(*msearch.Msearch)

func AllowNoIndices

func AllowNoIndices(b bool) Option

AllowNoIndices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. API name: allow_no_indices

func CcsMinimizeRoundtrips

func CcsMinimizeRoundtrips(b bool) Option

CcsMinimizeRoundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. API name: ccs_minimize_roundtrips

func ErrorTrace

func ErrorTrace(b bool) Option

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func ExpandWildcards

func ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) Option

ExpandWildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. API name: expand_wildcards

func FilterPath

func FilterPath(s ...string) Option

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func Human

func Human(b bool) Option

Human Whether to return time and byte values in human-readable format. API name: human

func IgnoreThrottled

func IgnoreThrottled(b bool) Option

IgnoreThrottled If true, concrete, expanded or aliased indices are ignored when frozen. API name: ignore_throttled

func IgnoreUnavailable

func IgnoreUnavailable(b bool) Option

IgnoreUnavailable If true, missing or closed indices are not included in the response. API name: ignore_unavailable

func MaxConcurrentSearches

func MaxConcurrentSearches(s string) Option

MaxConcurrentSearches The number of concurrent searches the multi search api can execute. API name: max_concurrent_searches

func MaxConcurrentShardRequests

func MaxConcurrentShardRequests(s string) Option

MaxConcurrentShardRequests The number of concurrent shard requests the multi search api can execute per search. API name: max_concurrent_shard_requests

func PreFilterShardSize

func PreFilterShardSize(s string) Option

PreFilterShardSize A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of search shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match. API name: pre_filter_shard_size

func Pretty

func Pretty(b bool) Option

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func RestTotalHitsAsInt

func RestTotalHitsAsInt(b bool) Option

RestTotalHitsAsInt Indicates whether hits.total should be rendered as an integer or an object in the rest search response. API name: rest_total_hits_as_int

func Routing

func Routing(r string) Option

Routing A comma-separated list of specific routing values. API name: routing

func SearchType

func SearchType(s searchtype.SearchType) Option

SearchType Search operation type. API name: search_type

func TypedKeys

func TypedKeys(b bool) Option

TypedKeys Specify whether aggregation and suggester names should be prefixed by their respective types in the response. API name: typed_keys