translate

package
v8.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2022 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Overview

Translates SQL into Elasticsearch queries

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

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/555082f38110f65b60d470107d211fc354a5c55a/specification/sql/translate/TranslateSqlRequest.ts#L25-L37

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

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

FromJSON allows to load an arbitrary json into the request structure

type Translate

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

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL