NAME

OpenSearch::Client::Core::3_0::Direct::Query

VERSION

version 3.007004

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Metric analytics

Configure metric analytics datasources

See OpenSearch documentation for query.

METHODS

query->datasource_delete

Deletes a specific data source by name.

Paths served by this method:

DELETE /_plugins/_query/_datasources/{datasource_name}
$resp = $client->query->datasource_delete(
    
     # path parameters
    
    'datasource_name'  =>  $datasource_name,  # required
    
     # Common API query string parameters
    
    'error_trace'      =>  $qval1,     # boolean
    'filter_path'      =>  $qval2,     # list
    'human'            =>  $qval3,     # boolean
    'pretty'           =>  $qval4,     # boolean
    'source'           =>  $qval5,     # string
);

OpenSearch documentation for query.datasource_delete

query->datasource_retrieve

Retrieves a specific data source by name.

Paths served by this method:

GET /_plugins/_query/_datasources/{datasource_name}
$resp = $client->query->datasource_retrieve(
    
     # path parameters
    
    'datasource_name'  =>  $datasource_name,  # required
    
     # Common API query string parameters
    
    'error_trace'      =>  $qval1,     # boolean
    'filter_path'      =>  $qval2,     # list
    'human'            =>  $qval3,     # boolean
    'pretty'           =>  $qval4,     # boolean
    'source'           =>  $qval5,     # string
);

OpenSearch documentation for query.datasource_retrieve

query->datasources_create

Creates a new query data source.

Paths served by this method:

POST /_plugins/_query/_datasources
$resp = $client->query->datasources_create(
    
    'body'         =>  $body,      # optional
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for query.datasources_create

query->datasources_list

Retrieves a list of all available data sources.

Paths served by this method:

GET /_plugins/_query/_datasources
$resp = $client->query->datasources_list(
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for query.datasources_list

query->datasources_update

Updates an existing query data source.

Paths served by this method:

PUT /_plugins/_query/_datasources
$resp = $client->query->datasources_update(
    
    'body'         =>  $body,      # optional
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for query.datasources_update

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