translate

package
v8.13.1 Latest Latest
Warning

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

Go to latest
Published: Apr 10, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

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 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/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/sql/translate/TranslateSqlRequest.ts#L25-L54

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/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/sql/translate/TranslateSqlResponse.ts#L28-L38

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

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

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

Jump to

Keyboard shortcuts

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