Documentation
¶
Overview ¶
Translates SQL into Elasticsearch queries
Index ¶
- Variables
- type NewTranslate
- type Request
- type Response
- type Translate
- func (r Translate) Do(providedCtx context.Context) (*Response, error)
- func (r *Translate) FetchSize(fetchsize int) *Translate
- func (r *Translate) Filter(filter *types.Query) *Translate
- func (r *Translate) Header(key, value string) *Translate
- func (r *Translate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Translate) Perform(providedCtx context.Context) (*http.Response, error)
- 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
Constants ¶
This section is empty.
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.
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
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶ added in v8.7.0
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
func (*Response) UnmarshalJSON ¶ added in v8.7.1
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 ¶
Do runs the request through the transport, handle the response and returns a translate.Response
func (*Translate) FetchSize ¶ added in v8.9.0
FetchSize The maximum number of rows (or entries) to return in one response. API name: fetch_size
func (*Translate) Filter ¶ added in v8.9.0
Filter Elasticsearch query DSL for additional filtering. API name: filter
func (*Translate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Translate) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Translate) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
Source Files