Search::Elasticsearch::Client::6_0::Direct::XPack::SQL - Plugin providing SQL for Search::Elasticsearch 6.x
version 6.80
my $response = $es->xpack->sql->query( body => {...} )
This class extends the Search::Elasticsearch client with an sql namespace, to support the SQL APIs.
sql
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->xpack->sql->query( body => {...} # required )
The query() method executes an SQL query and returns the results.
Query string parameters: error_trace, filter_path, format, human
error_trace
filter_path
format
human
See the query docs for more information.
translate()
$response = $es->xpack->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 for more information.
clear_cursor()
$response = $es->xpack->sql->clear_cursor( body => {...} # required )
The clear_cursor() method cleans up an ongoing scroll request.
Enrico Zimuel <enrico.zimuel@elastic.co>
This software is Copyright (c) 2020 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
To install Search::Elasticsearch, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::Elasticsearch
CPAN shell
perl -MCPAN -e shell install Search::Elasticsearch
For more information on module installation, please visit the detailed CPAN module installation guide.