type NewTranslate func() *Translate

funcNewTranslateFunc¶

func NewTranslateFunc(tpelastictransport.Interface)NewTranslate

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

type Request struct {// FetchSize The maximum number of rows (or entries) to return in one response.FetchSize *int `json:"fetch_size,omitempty"`// Filter The Elasticsearch query DSL for additional filtering.Filter *types.Query `json:"filter,omitempty"`// Query The SQL query to run.Querystring `json:"query"`// TimeZone The ISO-8601 time zone ID for the search.TimeZone *string `json:"time_zone,omitempty"`}

funcNewRequest¶added inv8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request)FromJSON¶added inv8.5.0

func (r *Request) FromJSON(datastring) (*Request,error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request)UnmarshalJSON¶added inv8.12.1

func (s *Request) UnmarshalJSON(data []byte)error

type Response struct {Aggregations map[string]types.Aggregations `json:"aggregations,omitempty"`Fields       []types.FieldAndFormat        `json:"fields,omitempty"`Query        *types.Query                  `json:"query,omitempty"`Size         *int64                        `json:"size,omitempty"`Sort         []types.SortCombinations      `json:"sort,omitempty"`Source_types.SourceConfig            `json:"_source,omitempty"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response

func (*Response)UnmarshalJSON¶added inv8.7.1

func (s *Response) UnmarshalJSON(data []byte)error

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

funcNew¶

func New(tpelastictransport.Interface) *Translate

Translate SQL into Elasticsearch queries.Translate an SQL search into a search API request containing Query DSL.It accepts the same request body parameters as the SQL search API, excluding`cursor`.

https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html

func (Translate)Do¶

func (rTranslate) Do(providedCtxcontext.Context) (*Response,error)

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

func (*Translate)ErrorTrace¶added inv8.14.0

func (r *Translate) ErrorTrace(errortracebool) *Translate

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

func (*Translate)FetchSize¶added inv8.9.0

func (r *Translate) FetchSize(fetchsizeint) *Translate

FetchSize The maximum number of rows (or entries) to return in one response.API name: fetch_size

func (*Translate)Filter¶added inv8.9.0

func (r *Translate) Filter(filter *types.Query) *Translate

Filter The Elasticsearch query DSL for additional filtering.API name: filter

func (*Translate)FilterPath¶added inv8.14.0

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

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

func (*Translate)Header¶

func (r *Translate) Header(key, valuestring) *Translate

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

func (*Translate)HttpRequest¶

func (r *Translate) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*Translate)Human¶added inv8.14.0

func (r *Translate) Human(humanbool) *Translate

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

func (Translate)Perform¶added inv8.7.0

func (rTranslate) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*Translate)Pretty¶added inv8.14.0

func (r *Translate) Pretty(prettybool) *Translate

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

func (*Translate)Query¶added inv8.9.0

func (r *Translate) Query(querystring) *Translate

Query The SQL query to run.API name: query

func (*Translate)Raw¶

func (r *Translate) Raw(rawio.Reader) *Translate

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

func (*Translate)Request¶

func (r *Translate) Request(req *Request) *Translate

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

func (*Translate)TimeZone¶added inv8.9.0

func (r *Translate) TimeZone(timezonestring) *Translate

TimeZone The ISO-8601 time zone ID for the search.API name: time_zone