.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Search::Elasticsearch::Client::8_0::Direct::SQL 3pm"
.TH Search::Elasticsearch::Client::8_0::Direct::SQL 3pm 2024-02-04 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Search::Elasticsearch::Client::8_0::Direct::SQL \- Plugin providing SQL for Search::Elasticsearch 8.x
.SH VERSION
.IX Header "VERSION"
version 8.12
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my $response = $es\->sql\->query( body => {...} )
.Ve
.SS DESCRIPTION
.IX Subsection "DESCRIPTION"
This class extends the Search::Elasticsearch client with an \f(CW\*(C`sql\*(C'\fR
namespace, to support the
SQL APIs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html>.
.PP
The full documentation for the SQL feature is available here:
<https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack\-sql.html>
.SH "GENERAL METHODS"
.IX Header "GENERAL METHODS"
.ie n .SS query()
.el .SS \f(CWquery()\fP
.IX Subsection "query()"
.Vb 3
\&    $response = $es\->sql\->query(
\&        body    => {...} # required
\&    )
.Ve
.PP
The \f(CWquery()\fR method executes an SQL query and returns the results.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`filter_path\*(C'\fR,
    \f(CW\*(C`format\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR
.PP
See the query docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html>
for more information.
.ie n .SS translate()
.el .SS \f(CWtranslate()\fP
.IX Subsection "translate()"
.Vb 3
\&    $response = $es\->sql\->translate(
\&        body    => {...} # required
\&    )
.Ve
.PP
The \f(CWtranslate()\fR method takes an SQL query and returns the query DSL which would be executed.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`filter_path\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR
.PP
See the translate docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate.html>
for more information.
.ie n .SS clear_cursor()
.el .SS \f(CWclear_cursor()\fP
.IX Subsection "clear_cursor()"
.Vb 3
\&    $response = $es\->sql\->clear_cursor(
\&        body    => {...} # required
\&    )
.Ve
.PP
The \f(CWclear_cursor()\fR method cleans up an ongoing scroll request.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`filter_path\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR
.PP
See the query docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html>
for more information.
.SH AUTHOR
.IX Header "AUTHOR"
Enrico Zimuel <enrico.zimuel@elastic.co>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2024 by Elasticsearch BV.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve