1. Manuals
  2. Tumbleweed
  3. perl-Search-Elasticsearch
  4. Search::Elasticsearch::CxnPool::Static(3pm)

Scroll to navigation

Search::Elasticsearch::CxnPool::Static(3) User Contributed Perl Documentation Search::Elasticsearch::CxnPool::Static(3)

NAME

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

VERSION

version 8.12

SYNOPSIS

    $e = Search::Elasticsearch->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 Elasticsearch 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 Search::Elasticsearch::Role::CxnPool::Static and Search::Elasticsearch::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 Search::Elasticsearch::Role::Cxn for details of the node specification.

See also

  • "request_timeout" in Search::Elasticsearch::Role::Cxn
  • "ping_timeout" in Search::Elasticsearch::Role::Cxn
  • "dead_timeout" in Search::Elasticsearch::Role::Cxn
  • "max_dead_timeout" in Search::Elasticsearch::Role::Cxn

Inherited configuration

From Search::Elasticsearch::Role::CxnPool

•
randomize_cxns

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 Search::Elasticsearch::Role::CxnPool::Static

•
schedule_check()

From Search::Elasticsearch::Role::CxnPool

  • cxn_factory()
  • logger()
  • serializer()
  • current_cxn_num()
  • cxns()
  • seed_nodes()
  • next_cxn_num()
  • set_cxns()
  • request_ok()
  • request_failed()
  • should_retry()
  • should_mark_dead()
  • cxns_str()
  • cxns_seeds_str()
  • retries()
  • reset_retries()

AUTHOR

Enrico Zimuel <enrico.zimuel@elastic.co>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2024 by Elasticsearch BV.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2024-03-08 perl v5.38.2