module Elasticsearch::API::SQL::Actions
Public Instance Methods
Clears the SQL
cursor
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body Specify the cursor value in the ‘cursor` element to clean the cursor. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-sql-cursor-api.html
# File lib/elasticsearch/api/actions/sql/clear_cursor.rb, line 32 def clear_cursor(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.clear_cursor' } raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_sql/close' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Deletes an async SQL
search or a stored synchronous SQL
search. If the search is still running, the API
cancels it.
@option arguments [String] :id The async search ID @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-async-sql-search-api.html
# File lib/elasticsearch/api/actions/sql/delete_async.rb, line 32 def delete_async(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.delete_async' } defined_params = [:id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE path = "_sql/async/delete/#{Utils.__listify(_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Returns the current status and available results for an async SQL
search or stored synchronous SQL
search
@option arguments [String] :id The async search ID @option arguments [String] :delimiter Separator for CSV results @option arguments [String] :format Short version of the Accept header, e.g. json, yaml @option arguments [Time] :keep_alive Retention period for the search and its results @option arguments [Time] :wait_for_completion_timeout Duration to wait for complete results @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-api.html
# File lib/elasticsearch/api/actions/sql/get_async.rb, line 36 def get_async(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async' } defined_params = [:id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET path = "_sql/async/#{Utils.__listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Returns the current status of an async SQL
search or a stored synchronous SQL
search
@option arguments [String] :id The async search ID @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-status-api.html
# File lib/elasticsearch/api/actions/sql/get_async_status.rb, line 32 def get_async_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async_status' } defined_params = [:id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET path = "_sql/async/status/#{Utils.__listify(_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Executes a SQL
request
@option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body Use the ‘query` element to start a query. Use the `cursor` element to continue a query. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-search-api.html
# File lib/elasticsearch/api/actions/sql/query.rb, line 33 def query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.query' } raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_sql' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Translates SQL
into Elasticsearch
queries
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body Specify the query in the ‘query` element. (Required)
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-translate-api.html
# File lib/elasticsearch/api/actions/sql/translate.rb, line 32 def translate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.translate' } raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_sql/translate' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end