translate

Documentation

Overview

Translates SQL into Elasticsearch queries

Index

• Variables
• type NewTranslate
  • func NewTranslateFunc(tp elastictransport.Interface) NewTranslate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, 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(ctx context.Context) (*Response, error)
  • func (r *Translate) Header(key, value string) *Translate
  • func (r *Translate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Translate) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Translate) Raw(raw io.Reader) *Translate
  • func (r *Translate) Request(req *Request) *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 *int         `json:"fetch_size,omitempty"`
	Filter    *types.Query `json:"filter,omitempty"`
	Query     string       `json:"query"`
	TimeZone  *string      `json:"time_zone,omitempty"`
}

Request holds the request body struct for the package translate

https://github.com/elastic/elasticsearch-specification/blob/363111664e81786557afe06e68221018847b3676/specification/sql/translate/TranslateSqlRequest.ts#L25-L37

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

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

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

Translates SQL into Elasticsearch queries

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

func (Translate) Do

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

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

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) Perform

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

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

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.