translate

Documentation

Overview

Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL.

Index

• Variables
• type NewTranslate
  • func NewTranslateFunc(tp elastictransport.Interface) NewTranslate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error
• type Translate
  • func New(tp elastictransport.Interface) *Translate
  • func (r Translate) Do(providedCtx context.Context) (*Response, error)
  • func (r *Translate) ErrorTrace(errortrace bool) *Translate
  • func (r *Translate) FetchSize(fetchsize int) *Translate
  • func (r *Translate) Filter(filter *types.Query) *Translate
  • func (r *Translate) FilterPath(filterpaths ...string) *Translate
  • func (r *Translate) Header(key, value string) *Translate
  • func (r *Translate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Translate) Human(human bool) *Translate
  • func (r Translate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Translate) Pretty(pretty bool) *Translate
  • func (r *Translate) Query(query string) *Translate
  • func (r *Translate) Raw(raw io.Reader) *Translate
  • func (r *Translate) Request(req *Request) *Translate
  • func (r *Translate) TimeZone(timezone string) *Translate

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 NewTranslate

type NewTranslate func() *Translate

NewTranslate type alias for index.

func NewTranslateFunc

func NewTranslateFunc(tp elastictransport.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

type Request struct {

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

Request holds the request body struct for the package translate

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/sql/translate/TranslateSqlRequest.ts#L25-L56

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

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

type Response

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"`
}

Response holds the response body struct for the package translate

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/sql/translate/TranslateSqlResponse.ts#L27-L37

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

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

type Translate

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

func New

func New(tp elastictransport.Interface) *Translate

Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL.

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

func (Translate) Do

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

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

func (*Translate) ErrorTrace

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

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

func (*Translate) FetchSize

func (r *Translate) FetchSize(fetchsize int) *Translate

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

func (*Translate) Filter

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

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

func (*Translate) FilterPath

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

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

func (*Translate) Header

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

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

func (*Translate) HttpRequest

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

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

func (*Translate) Human

func (r *Translate) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (Translate) Perform

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

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

func (*Translate) Pretty

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

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

func (*Translate) Query

func (r *Translate) Query(query string) *Translate

Query SQL query to run. API name: query

func (*Translate) Raw

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

Raw takes a json payload as input which is then passed to the http.Request If 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

func (r *Translate) TimeZone(timezone string) *Translate

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