Skip to content

Commit 8fc8743

Browse files
committed
[API] Adds experimental endpoint esql/query
1 parent c102100 commit 8fc8743

File tree

1 file changed

+57
-0
lines changed
  • elasticsearch-api/lib/elasticsearch/api/actions/esql

1 file changed

+57
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
#
18+
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19+
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
20+
#
21+
module Elasticsearch
22+
module API
23+
module Esql
24+
module Actions
25+
# Executes an ESQL request
26+
# This functionality is Experimental and may be changed or removed
27+
# completely in a future release. Elastic will take a best effort approach
28+
# to fix any issues, but experimental features are not subject to the
29+
# support SLA of official GA features.
30+
#
31+
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
32+
# @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format.
33+
# @option arguments [Hash] :headers Custom HTTP headers
34+
# @option arguments [Hash] :body Use the `query` element to start a query. Use `time_zone` to specify an execution time zone and 'columnar' to format the answer. (*Required*)
35+
#
36+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html
37+
#
38+
def query(arguments = {})
39+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
40+
41+
arguments = arguments.clone
42+
headers = arguments.delete(:headers) || {}
43+
44+
body = arguments.delete(:body)
45+
46+
method = Elasticsearch::API::HTTP_POST
47+
path = "_query"
48+
params = Utils.process_params(arguments)
49+
50+
Elasticsearch::API::Response.new(
51+
perform_request(method, path, params, body, headers)
52+
)
53+
end
54+
end
55+
end
56+
end
57+
end

0 commit comments

Comments
 (0)