/ 
OpenSearch-Client-3.007004
/ OpenSearch::Client::Core::3_0::Direct::PPL

NAME

OpenSearch::Client::Core::3_0::Direct::PPL

VERSION

version 3.007004

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->ppl-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Piped Processing Language (PPL)

Use the SQL and PPL API to send queries to the SQL plugin. Use the _sql endpoint to send queries in SQL, and the _ppl endpoint to send queries in PPL. For both of these, you can also use the _explain endpoint to translate your query into OpenSearch domain-specific language (DSL) or to troubleshoot errors.

See OpenSearch documentation for ppl.

METHODS

ppl->explain

Returns the execution plan for a PPL query.

Paths served by this method:

POST /_plugins/_ppl/_explain
$resp = $client->ppl->explain(
    
    'body'         =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'format'       =>  $qval1,     # string
    'sanitize'     =>  $qval2,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval3,     # boolean
    'filter_path'  =>  $qval4,     # list
    'human'        =>  $qval5,     # boolean
    'pretty'       =>  $qval6,     # boolean
    'source'       =>  $qval7,     # string
);

OpenSearch documentation for ppl.explain

ppl->get_stats

Retrieves performance metrics for the PPL plugin.

Paths served by this method:

GET /_plugins/_ppl/stats
$resp = $client->ppl->get_stats(
    
     # Endpoint specific query string parameters
    
    'format'       =>  $qval1,     # string
    'sanitize'     =>  $qval2,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval3,     # boolean
    'filter_path'  =>  $qval4,     # list
    'human'        =>  $qval5,     # boolean
    'pretty'       =>  $qval6,     # boolean
    'source'       =>  $qval7,     # string
);

OpenSearch documentation for ppl.get_stats

ppl->post_stats

Retrieves filtered performance metrics for the PPL plugin.

Paths served by this method:

POST /_plugins/_ppl/stats
$resp = $client->ppl->post_stats(
    
    'body'         =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'format'       =>  $qval1,     # string
    'sanitize'     =>  $qval2,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval3,     # boolean
    'filter_path'  =>  $qval4,     # list
    'human'        =>  $qval5,     # boolean
    'pretty'       =>  $qval6,     # boolean
    'source'       =>  $qval7,     # string
);

OpenSearch documentation for ppl.post_stats

ppl->query

Executes a PPL query against OpenSearch indexes.

Paths served by this method:

POST /_plugins/_ppl
$resp = $client->ppl->query(
    
    'body'         =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'format'       =>  $qval1,     # string
    'sanitize'     =>  $qval2,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval3,     # boolean
    'filter_path'  =>  $qval4,     # list
    'human'        =>  $qval5,     # boolean
    'pretty'       =>  $qval6,     # boolean
    'source'       =>  $qval7,     # string
);

OpenSearch documentation for ppl.query

MANUAL

Documentation index OpenSearch::Client::Manual

HISTORY

This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.

AUTHOR

Mark Dootson <mdootson@cpan.org> ( current maintainer )

CREDITS

OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.

COPYRIGHT AND LICENSE

Copyright (C) 2026 by Mark Dootson ( this distribution )

Copyright (C) 2021 by Elasticsearch BV ( original distribution )

This is free software, licensed under:

The Apache License, Version 2.0, January 2004