1Search::Elasticsearch::UCsleirenCtoS:ne:ta7rr_ic0bh:u::t:DeEidlraePscettri:lc:sSDeQoaLcr(uc3mh)e:n:tCaltiieonnt::7_0::Direct::SQL(3)
2
3
4

NAME

6       Search::Elasticsearch::Client::7_0::Direct::SQL - Plugin providing SQL
7       for Search::Elasticsearch 7.x
8

VERSION

10       version 7.30
11

SYNOPSIS

13           my $response = $es->sql->query( body => {...} )
14
15   DESCRIPTION
16       This class extends the Search::Elasticsearch client with an "sql"
17       namespace, to support the SQL APIs
18       <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-
19       rest.html>.
20
21       The full documentation for the SQL feature is available here:
22       <https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html>
23

GENERAL METHODS

25   "query()"
26           $response = $es->sql->query(
27               body    => {...} # required
28           )
29
30       The "query()" method executes an SQL query and returns the results.
31
32       Query string parameters:
33           "error_trace",
34           "filter_path",
35           "format",
36           "human"
37
38       See the query docs
39       <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-
40       rest.html> for more information.
41
42   "translate()"
43           $response = $es->sql->translate(
44               body    => {...} # required
45           )
46
47       The "translate()" method takes an SQL query and returns the query DSL
48       which would be executed.
49
50       Query string parameters:
51           "error_trace",
52           "filter_path",
53           "human"
54
55       See the translate docs
56       <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-
57       translate.html> for more information.
58
59   "clear_cursor()"
60           $response = $es->sql->clear_cursor(
61               body    => {...} # required
62           )
63
64       The "clear_cursor()" method cleans up an ongoing scroll request.
65
66       Query string parameters:
67           "error_trace",
68           "filter_path",
69           "human"
70
71       See the query docs
72       <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-
73       rest.html> for more information.
74

AUTHOR

76       Enrico Zimuel <enrico.zimuel@elastic.co>
77

79       This software is Copyright (c) 2020 by Elasticsearch BV.
80
81       This is free software, licensed under:
82
83         The Apache License, Version 2.0, January 2004
84
85
86
87perl v5.32.1                Search2:0:2E1l-a0s1t-i2c7search::Client::7_0::Direct::SQL(3)
Impressum