Search::Elasticsearch::Client::8_0::Direct::SQL(3pm)

Usage

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

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>

Version

version 8.12

General methods

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.

Copyright and license

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

12
13