module Elasticsearch::API::SQL::Actions
Public Instance Methods
Source
# 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
Clear an SQL
search cursor.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-clear-cursor
Source
# File lib/elasticsearch/api/actions/sql/delete_async.rb, line 37 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
Delete an async SQL
search. Delete an async SQL
search or a stored synchronous SQL
search. If the search is still running, the API
cancels it. If the Elasticsearch
security features are enabled, only the following users can use this API
to delete a search:
-
Users with the
cancel_task
cluster privilege. -
The user who first submitted the search.
@option arguments [String] :id The identifier for the search. (Required) @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-delete-async
Source
# File lib/elasticsearch/api/actions/sql/get_async.rb, line 43 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
Get async SQL
search results. Get the current status and available results for an async SQL
search or stored synchronous SQL
search. If the Elasticsearch
security features are enabled, only the user who first submitted the SQL
search can retrieve the search using this API
.
@option arguments [String] :id The identifier for the search. (Required) @option arguments [String] :delimiter The separator for CSV results.
The API supports this parameter only for CSV responses. Server default: ,.
@option arguments [String] :format The format for the response.
You must specify a format using this parameter or the +Accept+ HTTP header. If you specify both, the API uses this parameter.
@option arguments [Time] :keep_alive The retention period for the search and its results.
It defaults to the +keep_alive+ period for the original SQL search.
@option arguments [Time] :wait_for_completion_timeout The period to wait for complete results.
It defaults to no timeout, meaning the request waits for complete search results.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async
Source
# File lib/elasticsearch/api/actions/sql/get_async_status.rb, line 33 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
Get the async SQL
search status. Get the current status of an async SQL
search or a stored synchronous SQL
search.
@option arguments [String] :id The identifier for the search. (Required) @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async-status
Source
# File lib/elasticsearch/api/actions/sql/query.rb, line 36 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
Get SQL
search results. Run an SQL
request.
@option arguments [String] :format The format for the response.
You can also specify a format using the +Accept+ HTTP header. If you specify both this parameter and the +Accept+ HTTP header, this parameter takes precedence.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-query
Source
# File lib/elasticsearch/api/actions/sql/translate.rb, line 34 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
Translate SQL
into Elasticsearch
queries. Translate an SQL
search into a search API
request containing Query DSL. It accepts the same request body parameters as the SQL
search API
, excluding cursor
.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-translate