Module: Elasticsearch::XPack::API::SQL::Actions

Included in:
SQLClient
Defined in:
lib/elasticsearch/xpack/api/namespace/sql.rb,
lib/elasticsearch/xpack/api/actions/sql/query.rb,
lib/elasticsearch/xpack/api/actions/sql/get_async.rb,
lib/elasticsearch/xpack/api/actions/sql/translate.rb,
lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb,
lib/elasticsearch/xpack/api/actions/sql/delete_async.rb,
lib/elasticsearch/xpack/api/actions/sql/params_registry.rb,
lib/elasticsearch/xpack/api/actions/sql/get_async_status.rb

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#clear_cursor(arguments = {}) ⇒ Object

Clears the SQL cursor

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    Specify the cursor value in the ‘cursor` element to clean the cursor. (Required)

Raises:

  • (ArgumentError)

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb', line 30

def clear_cursor(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_POST
  path   = "_sql/close"
  params = {}

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
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.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :id (String) —

    The async search ID

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/elasticsearch/xpack/api/actions/sql/delete_async.rb', line 30

def delete_async(arguments = {})
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_sql/async/delete/#{Elasticsearch::API::Utils.__listify(_id)}"
  params = {}

  body = nil
  perform_request(method, path, params, body, headers).body
end

#get_async(arguments = {}) ⇒ Object

Returns the current status and available results for an async SQL search or stored synchronous SQL search

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :id (String) —

    The async search ID

  • :delimiter (String) —

    Separator for CSV results

  • :format (String) —

    Short version of the Accept header, e.g. json, yaml

  • :keep_alive (Time) —

    Retention period for the search and its results

  • :wait_for_completion_timeout (Time) —

    Duration to wait for complete results

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/elasticsearch/xpack/api/actions/sql/get_async.rb', line 34

def get_async(arguments = {})
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_GET
  path   = "_sql/async/#{Elasticsearch::API::Utils.__listify(_id)}"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end

#get_async_status(arguments = {}) ⇒ Object

Returns the current status of an async SQL search or a stored synchronous SQL search

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :id (String) —

    The async search ID

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/elasticsearch/xpack/api/actions/sql/get_async_status.rb', line 30

def get_async_status(arguments = {})
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_GET
  path   = "_sql/async/status/#{Elasticsearch::API::Utils.__listify(_id)}"
  params = {}

  body = nil
  perform_request(method, path, params, body, headers).body
end

#query(arguments = {}) ⇒ Object

Executes a SQL request

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :format (String) —

    a short version of the Accept header, e.g. json, yaml

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    Use the ‘query` element to start a query. Use the `cursor` element to continue a query. (Required)

Raises:

  • (ArgumentError)

See Also:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/elasticsearch/xpack/api/actions/sql/query.rb', line 31

def query(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_POST
  path   = "_sql"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end

#translate(arguments = {}) ⇒ Object

Translates SQL into Elasticsearch queries

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    Specify the query in the ‘query` element. (Required)

Raises:

  • (ArgumentError)

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/elasticsearch/xpack/api/actions/sql/translate.rb', line 30

def translate(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_POST
  path   = "_sql/translate"
  params = {}

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end