getquery

Documentation

Overview

Get a specific running ES|QL query information. Returns an object extended information about a running ES|QL query.

Index

• Variables
• type GetQuery
  • func New(tp elastictransport.Interface) *GetQuery
  • func (r GetQuery) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetQuery) ErrorTrace(errortrace bool) *GetQuery
  • func (r *GetQuery) FilterPath(filterpaths ...string) *GetQuery
  • func (r *GetQuery) Header(key, value string) *GetQuery
  • func (r *GetQuery) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetQuery) Human(human bool) *GetQuery
  • func (r GetQuery) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetQuery) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetQuery) Pretty(pretty bool) *GetQuery
• type NewGetQuery
  • func NewGetQueryFunc(tp elastictransport.Interface) NewGetQuery
• type Response
  • func NewResponse() *Response

Variables

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.

Types

type GetQuery

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

func New

func New(tp elastictransport.Interface) *GetQuery

Get a specific running ES|QL query information. Returns an object extended information about a running ES|QL query.

func (GetQuery) Do

func (r GetQuery) Do(providedCtx context.Context) (*Response, error)

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

func (*GetQuery) ErrorTrace

func (r *GetQuery) ErrorTrace(errortrace bool) *GetQuery

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

func (*GetQuery) FilterPath

func (r *GetQuery) FilterPath(filterpaths ...string) *GetQuery

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

func (*GetQuery) Header

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

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

func (*GetQuery) HttpRequest

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

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

func (*GetQuery) Human

func (r *GetQuery) Human(human bool) *GetQuery

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (GetQuery) IsSuccess

func (r GetQuery) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (GetQuery) Perform

func (r GetQuery) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*GetQuery) Pretty

func (r *GetQuery) Pretty(pretty bool) *GetQuery

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

type NewGetQuery

type NewGetQuery func(id string) *GetQuery

NewGetQuery type alias for index.

func NewGetQueryFunc

func NewGetQueryFunc(tp elastictransport.Interface) NewGetQuery

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

type Response

type Response struct {
	CoordinatingNode string   `json:"coordinating_node"`
	DataNodes        []string `json:"data_nodes"`
	Id               int64    `json:"id"`
	Node             string   `json:"node"`
	Query            string   `json:"query"`
	RunningTimeNanos int64    `json:"running_time_nanos"`
	StartTimeMillis  int64    `json:"start_time_millis"`
}

Response holds the response body struct for the package getquery

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/esql/get_query/GetQueryResponse.ts#L23-L33

func NewResponse

func NewResponse() *Response

NewResponse returns a Response