DESCRIPTION¶

This class extends the Search::Elasticsearch client with an "sql" namespace, to support the SQL APIs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html>.

The full documentation for the SQL feature is available here: <https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html>

query()¶

    $response = $es->sql->query(
        body    => {...} # required
    )

The query() method executes an SQL query and returns the results.

Query string parameters:
"error_trace",
"filter_path",
"format",
"human"

See the query docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html> for more information.

translate()¶

    $response = $es->sql->translate(
        body    => {...} # required
    )

The translate() method takes an SQL query and returns the query DSL which would be executed.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the translate docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate.html> for more information.

clear_cursor()¶

    $response = $es->sql->clear_cursor(
        body    => {...} # required
    )

The clear_cursor() method cleans up an ongoing scroll request.

Query string parameters:
"error_trace",
"filter_path",
"human"

See the query docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html> for more information.