Module: Elasticsearch::API::SQL::Actions
- Included in:
- SQLClient
- Defined in:
- lib/elasticsearch/api/namespace/sql.rb,
lib/elasticsearch/api/actions/sql/query.rb,
lib/elasticsearch/api/actions/sql/get_async.rb,
lib/elasticsearch/api/actions/sql/translate.rb,
lib/elasticsearch/api/actions/sql/clear_cursor.rb,
lib/elasticsearch/api/actions/sql/delete_async.rb,
lib/elasticsearch/api/actions/sql/get_async_status.rb
Instance Method Summary collapse
-
#clear_cursor(arguments = {}) ⇒ Object
Clears the SQL cursor.
-
#delete_async(arguments = {}) ⇒ Object
Deletes an async SQL search or a stored synchronous SQL search.
-
#get_async(arguments = {}) ⇒ Object
Returns the current status and available results for an async SQL search or stored synchronous SQL search.
-
#get_async_status(arguments = {}) ⇒ Object
Returns the current status of an async SQL search or a stored synchronous SQL search.
-
#query(arguments = {}) ⇒ Object
Executes a SQL request.
-
#translate(arguments = {}) ⇒ Object
Translates SQL into Elasticsearch queries.
Instance Method Details
#clear_cursor(arguments = {}) ⇒ Object
Clears the SQL cursor
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# 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 |
#delete_async(arguments = {}) ⇒ Object
Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# 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 |
#get_async(arguments = {}) ⇒ Object
Returns the current status and available results for an async SQL search or stored synchronous SQL search
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# 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 |
#get_async_status(arguments = {}) ⇒ Object
Returns the current status of an async SQL search or a stored synchronous SQL search
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# 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 |
#query(arguments = {}) ⇒ Object
Executes a SQL request
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# 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 |
#translate(arguments = {}) ⇒ Object
Translates SQL into Elasticsearch queries
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# 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 |