/ 
OpenSearch-Client-3.007002
/ OpenSearch::Client::Transport

NAME

OpenSearch::Client::Transport - Provides interface between the client class and the OpenSearch cluster

VERSION

version 3.007002

DESCRIPTION

The Transport class manages the request cycle. It receives parsed requests from the (user-facing) client class, and tries to execute the request on a node in the cluster, retrying a request if necessary.

This class does OpenSearch::Client::Role::Transport and OpenSearch::Client::Role::Is_Sync.

CONFIGURATION

send_get_body_as

$os = OpenSearch::Client->new(
    send_get_body_as => 'POST'
);

Certain endpoints default to using a GET method, even when they include a request body. Some proxy servers do not support GET requests with a body. To work around this, the send_get_body_as parameter accepts the following:

  • GET

    Request bodies are sent as GET requests.

  • POST

    The method is changed to POST when a body is present.

  • source

    The body is encoded as JSON and added to the query string as the source parameter. This has the advantage of still being a GET request (for those filtering on request method) but has the disadvantage of being restricted in size. The limit depends on the proxies between the client and OpenSearch, but usually is around 4kB.

METHODS

perform_request()

Raw requests can be executed using the transport class as follows:

$result = $os->transport->perform_request(
    method => 'POST',
    path   => '/_search',
    qs     => { from => 0, size => 10 },
    body   => {
        query => {
            match => {
                title => "OpenSearch clients"
            }
        }
    }
);

Other than the method, path, qs and body parameters, which should be self-explanatory, it also accepts:

ignore

The HTTP error codes which should be ignored instead of throwing an error, eg 404 NOT FOUND:

$result = $os->transport->perform_request(
    method => 'GET',
    path   => '/index/type/id'
    ignore => [404],
);
serialize

Whether the body should be serialized in the standard way (as plain JSON) or using the special bulk format: "std" or "bulk".

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