/ 
OpenSearch-Client-3.007002
/ OpenSearch::Client::CxnPool::Static

NAME

OpenSearch::Client::CxnPool::Static - A CxnPool for connecting to a remote cluster with a static list of nodes.

VERSION

version 3.007002

SYNOPSIS

$e = OpenSearch::Client->new(
    cxn_pool => 'Static'     # default
    nodes    => [
        'search1:9200',
        'search2:9200'
    ],
);

DESCRIPTION

The Static connection pool, which is the default, should be used when you don't have direct access to the OpenSearch cluster, eg when you are accessing the cluster through a proxy. It round-robins through the nodes that you specified, and pings each node before it is used for the first time, to ensure that it is responding.

If any node fails, then all nodes are pinged before the next request to ensure that they are still alive and responding. Failed nodes will be pinged regularly to check if they have recovered.

This class does OpenSearch::Client::Role::CxnPool::Static and OpenSearch::Client::Role::Is_Sync.

CONFIGURATION

nodes

The list of nodes to use to serve requests. Can accept a single node, multiple nodes, and defaults to localhost:9200 if no nodes are specified. See "node" in OpenSearch::Client::Role::Cxn for details of the node specification.

See also

Inherited configuration

From OpenSearch::Client::Role::CxnPool

METHODS

next_cxn()

$cxn = $cxn_pool->next_cxn

Returns the next available live node (in round robin fashion), or throws a NoNodes error if no nodes respond to ping requests.

Inherited methods

From OpenSearch::Client::Role::CxnPool::Static

From OpenSearch::Client::Role::CxnPool

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