translate

Documentation

Overview

Translates SQL into Elasticsearch queries

Index

• Variables
• type NewTranslate
  • func NewTranslateFunc(tp elastictransport.Interface) NewTranslate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FetchSize(fetchsize int) *RequestBuilder
  • func (rb *RequestBuilder) Filter(filter *types.QueryContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Query(query string) *RequestBuilder
  • func (rb *RequestBuilder) TimeZone(timezone types.TimeZone) *RequestBuilder
• type Translate
  • func New(tp elastictransport.Interface) *Translate
  • func (r Translate) Do(ctx context.Context) (*http.Response, error)
  • func (r *Translate) Header(key, value string) *Translate
  • func (r *Translate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Translate) Raw(raw json.RawMessage) *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.QueryContainer `json:"filter,omitempty"`

	Query string `json:"query"`

	TimeZone *types.TimeZone `json:"time_zone,omitempty"`
}

Request holds the request body struct for the package translate

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

type RequestBuilder

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

RequestBuilder is the builder API for the translate.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FetchSize

func (rb *RequestBuilder) FetchSize(fetchsize int) *RequestBuilder

func (*RequestBuilder) Filter

func (rb *RequestBuilder) Filter(filter *types.QueryContainerBuilder) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Query

func (rb *RequestBuilder) Query(query string) *RequestBuilder

func (*RequestBuilder) TimeZone

func (rb *RequestBuilder) TimeZone(timezone types.TimeZone) *RequestBuilder

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) (*http.Response, error)

Do runs the http.Request through the provided transport.

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

func (r *Translate) Raw(raw json.RawMessage) *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.