validatequery

package
v8.9.0 Latest Latest
Warning

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

 Go to latest Published: Jul 27, 2023 License: Apache-2.0 Imports: 14 Imported by: 3

Documentation

Overview

Allows a user to validate a potentially expensive query without executing it.

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 NewValidateQuery 

type NewValidateQuery func() *ValidateQuery

NewValidateQuery type alias for index.

func NewValidateQueryFunc 

func NewValidateQueryFunc(tp elastictransport.Interface) NewValidateQuery

NewValidateQueryFunc returns a new instance of ValidateQuery 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 {
	Query *types.Query `json:"query,omitempty"`
}

Request holds the request body struct for the package validatequery

https://github.com/elastic/elasticsearch-specification/blob/656080dee792f93a849cd7fbf566f528f858a5ea/specification/indices/validate_query/IndicesValidateQueryRequest.ts#L25-L51

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0 

type Response struct {
	Error        *string                              `json:"error,omitempty"`
	Explanations []types.IndicesValidationExplanation `json:"explanations,omitempty"`
	Shards_      *types.ShardStatistics               `json:"_shards,omitempty"`
	Valid        bool                                 `json:"valid"`
}

func NewResponse added in v8.7.0 

func NewResponse() *Response

NewResponse returns a Response

type ValidateQuery 

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

func New 

func New(tp elastictransport.Interface) *ValidateQuery

Allows a user to validate a potentially expensive query without executing it.

https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html

func (*ValidateQuery) AllShards 

func (r *ValidateQuery) AllShards(allshards bool) *ValidateQuery

AllShards Execute validation on all shards instead of one random shard per index API name: all_shards

func (*ValidateQuery) AllowNoIndices 

func (r *ValidateQuery) AllowNoIndices(allownoindices bool) *ValidateQuery

AllowNoIndices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) API name: allow_no_indices

func (*ValidateQuery) AnalyzeWildcard 

func (r *ValidateQuery) AnalyzeWildcard(analyzewildcard bool) *ValidateQuery

AnalyzeWildcard Specify whether wildcard and prefix queries should be analyzed (default: false) API name: analyze_wildcard

func (*ValidateQuery) Analyzer 

func (r *ValidateQuery) Analyzer(analyzer string) *ValidateQuery

Analyzer The analyzer to use for the query string API name: analyzer

func (*ValidateQuery) DefaultOperator 

func (r *ValidateQuery) DefaultOperator(defaultoperator operator.Operator) *ValidateQuery

DefaultOperator The default operator for query string query (AND or OR) API name: default_operator

func (*ValidateQuery) Df 

func (r *ValidateQuery) Df(df string) *ValidateQuery

Df The field to use as default where no field prefix is given in the query string API name: df

func (ValidateQuery) Do 

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

Do runs the request through the transport, handle the response and returns a validatequery.Response

func (*ValidateQuery) ExpandWildcards 

func (r *ValidateQuery) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ValidateQuery

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards

func (*ValidateQuery) Explain 

func (r *ValidateQuery) Explain(explain bool) *ValidateQuery

Explain Return detailed information about the error API name: explain

func (*ValidateQuery) Header 

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

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

func (*ValidateQuery) HttpRequest 

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

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

func (*ValidateQuery) IgnoreUnavailable 

func (r *ValidateQuery) IgnoreUnavailable(ignoreunavailable bool) *ValidateQuery

IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable

func (*ValidateQuery) Index 

func (r *ValidateQuery) Index(index string) *ValidateQuery

Index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices API Name: index

func (*ValidateQuery) Lenient 

func (r *ValidateQuery) Lenient(lenient bool) *ValidateQuery

Lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored API name: lenient

func (ValidateQuery) Perform added in v8.7.0 

func (r ValidateQuery) Perform(ctx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*ValidateQuery) Q 

func (r *ValidateQuery) Q(q string) *ValidateQuery

Q Query in the Lucene query string syntax API name: q

func (*ValidateQuery) Query added in v8.9.0 

func (r *ValidateQuery) Query(query *types.Query) *ValidateQuery

API name: query

func (*ValidateQuery) Raw 

func (r *ValidateQuery) Raw(raw io.Reader) *ValidateQuery

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

func (*ValidateQuery) Request 

func (r *ValidateQuery) Request(req *Request) *ValidateQuery

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

func (*ValidateQuery) Rewrite 

func (r *ValidateQuery) Rewrite(rewrite bool) *ValidateQuery

Rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed. API name: rewrite

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.