Search...ct::Cat(3pm)

📦 version 7.715, in ubuntu jammy

okay so bestie, welcome to the manual page for Search::Elasticsearch::Client::7_0::Direct::Cat(3pm) — from the User Contributed Perl Documentation corner of the manual-verse, and this is part 1. It's giving "Perl client for cat debugging requests" and honestly? iconic. 💅✨

✨ NAME ✨

Search::Elasticsearch::Client::7_0::Direct::Cat — a client for running cat debugging requests. That's the whole name, no cap. 🎀

🦋 VERSION 🦋

version 7.715 — locked in. 🔒

💖 DESCRIPTION 💖

The "cat" API in Elasticsearch gives you info about your cluster and indices in a simple, easy to read text format, and it's intended for human consumption. So yeah, it's literally for you, bestie. 🫶

These APIs have a number of parameters in common:

help — returns help about the API, eg:

say $e->cat->allocation(help => 1);

v — includes the column headers in the output:

say $e->cat->allocation(v => 1);

h — accepts a list of column names to be output, eg:

say $e->cat->indices(h => ['health','index']);

bytes — formats byte-based values as bytes ("b"), kilobytes ("k"), megabytes ("m") or gigabytes ("g"). 💾

It does Search::Elasticsearch::Role::Client::Direct.

✨ METHODS ✨

okay bestie, this is where the actual magic happens 💖 these are all the cat APIs you can call on your $e object. each one gives you a different vibe of your Elasticsearch cluster. let's get into it, no cap 🧚

✨ `help()` ✨

say $e->cat->help;

Returns the list of supported "cat" APIs. it's like a little menu of everything you can ask for 🍓

✨ `aliases()` ✨

say $e->cat->aliases(
    name => 'name' | \@names    # optional
);

Returns information about index aliases, optionally limited to the specified index/alias names. so you can be like "just the ones I care about, thanks" 💅

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat aliases docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-aliases.html> for more information.

✨ `allocation()` ✨

say $e->cat->allocation(
    node_id => 'node' | \@nodes    # optional
);

Provides a snapshot of how shards have located around the cluster and the state of disk usage. it's giving cluster geography 🗺️

Query string parameters: "bytes", "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat allocation docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html> for more information.

✨ `count()` ✨

say $e->cat->count(
    index => 'index' | \@indices    # optional
);

Provides quick access to the document count of the entire cluster, or individual indices. how many docs? this tells you 🔢

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat count docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html> for more information.

✨ `fielddata()` ✨

say $e->cat->fielddata(
    fields => 'field' | \@fields    # optional
);

Shows the amount of memory used by each of the specified fields (or all fields) loaded into fielddata. memory check, bestie 🧠

Query string parameters: "bytes", "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat fielddata docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html> for more information.

✨ `health()` ✨

say $e->cat->health();

Provides a snapshot of how shards have located around the cluster and the state of disk usage. same vibe as allocation, but health check ✨

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "ts", "s", "v"

See the cat health docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html> for more information.

✨ `indices()` ✨

say $e->cat->indices(
    index => 'index' | \@indices    # optional
);

Provides a summary of index size and health for the whole cluster or individual indices. the index tea ☕

Query string parameters: "bytes", "error_trace", "format", "h", "health", "help", "human", "local", "master_timeout", "pri", "s", "v"

See the cat indices docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html> for more information.

✨ `master()` ✨

say $e->cat->master();

Displays the master’s node ID, bound IP address, and node name. who's the main character? it's the master 👑

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat master docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html> for more information.

✨ `nodeattrs()` ✨

say $e->cat->nodeattrs();

Returns the node attributes set per node. all the little details about your nodes 🏷️

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat nodeattrs docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html> for more information.

✨ `nodes()` ✨

say $e->cat->nodes();

Provides a snapshot of all of the nodes in your cluster. the whole squad 🌈

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat nodes docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html> for more information.

✨ `pending_tasks()` ✨

say $e->cat->pending_tasks();

Returns any cluster-level tasks which are queued on the master. things waiting in line, lowkey stressful 😭

Query string parameters: "error_trace", "format", "human", "local", "master_timeout", "h", "help", "s", "v"

See the cat pending-tasks docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html> for more information.

✨ `plugins()` ✨

say $e->cat->plugins();

Returns information about plugins installed on each node. plugin check, slay 🔌

Query string parameters: "error_trace", "format", "human", "local", "master_timeout", "h", "help", "s", "v"

See the cat plugins docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html> for more information.

✨ `recovery()` ✨

say $e->cat->recovery(
    index => 'index' | \@indices    # optional
);

Provides a view of shard replication. It will show information anytime data from at least one shard is copying to a different node. It can also show up on cluster restarts. If your recovery process seems stuck, try it to see if there’s any movement using recovery(). basically the "is it moving?" check 🚦

Query string parameters: "bytes", "error_trace", "format", "h", "help", "human", "master_timeout", "s", "v"

See the cat recovery docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html> for more information.

✨ `repositories()` ✨

say $e->cat->repositories()

Provides a list of registered snapshot repositories. where your snapshots live 🏠

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat repositories docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html> for more information.

✨ `segments()` ✨

say $e->cat->segments(
    index => 'index' | \@indices    # optional
);

Provides low level information about the segments in the shards of an index. deep dive into the shards 🔍

Query string parameters: "bytes", "error_trace", "format", "h", "help", "human", "s", "v"

See the cat shards docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html> for more information.

✨ `shards()` ✨

say $e->cat->shards(
    index => 'index' | \@indices    # optional
);

Provides a detailed view of what nodes contain which shards, the state and size of each shard. shard mapping, periodt 🗺️

Query string parameters: "bytes", "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat shards docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html> for more information.

✨ `snapshots()` ✨

say $e->cat->snapshots(
    repository => 'repository' | \@repositories # optional
)

Provides a list of all snapshots that belong to the specified repositories. all your snapshots in one place 📸

Query string parameters: "error_trace", "format", "h", "help", "human", "ignore_unavailable", "master_timeout", "s", "v"

See the cat snapshots docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html> for more information.

✨ `tasks()` ✨

say $e->cat->tasks()

Provides a list of node-level tasks. what's running right now? 🏃‍♀️

Query string parameters: "actions", "detailed", "error_trace", "format", "h", "help", "human", "node_id", "parent_node", "parent_task", "s", "v"

See the cat tasks docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html> for more information.

✨ `templates()` ✨

say $e->cat->templates(
    name => $name # optional
)

Provides a list of index templates. the blueprint vibes 📐

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v"

See the cat templates docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/templates.html> for more information.

✨ `thread_pool()` ✨

say $e->cat->thread_pool(
    index => 'index' | \@indices    # optional
);

Shows cluster wide thread pool statistics per node. By default the "active", "queue" and "rejected" statistics are returned for the "bulk", "index" and "search" thread pools. thread pool tea ☕

Query string parameters: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "size", "s", "v"

See the cat thread_pool docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html> for more information.

✨ AUTHOR ✨

Enrico Zimuel <enrico.zimuel@elastic.co> 💖

✨ COPYRIGHT AND LICENSE ✨

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

okay bestie, that's the whole page! this was brought to you by perl v5.32.1 on 2021-10-23, all about Search...ct::Cat(3pm) 💅✨

📦 where this page comes from

ubuntu jammy: libsearch-elasticsearch-perl 7.715-1 · Apache-2.0
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

Search...ct::Cat(3pm)

✨ NAME ✨

🦋 VERSION 🦋

💖 DESCRIPTION 💖

✨ METHODS ✨

✨ help() ✨

✨ aliases() ✨

✨ allocation() ✨

✨ count() ✨

✨ fielddata() ✨

✨ health() ✨

✨ indices() ✨

✨ master() ✨

✨ nodeattrs() ✨

✨ nodes() ✨

✨ pending_tasks() ✨

✨ plugins() ✨

✨ recovery() ✨

✨ repositories() ✨

✨ segments() ✨

✨ shards() ✨

✨ snapshots() ✨

✨ tasks() ✨

✨ templates() ✨

✨ thread_pool() ✨

✨ AUTHOR ✨

✨ COPYRIGHT AND LICENSE ✨

✨ `help()` ✨

✨ `aliases()` ✨

✨ `allocation()` ✨

✨ `count()` ✨

✨ `fielddata()` ✨

✨ `health()` ✨

✨ `indices()` ✨

✨ `master()` ✨

✨ `nodeattrs()` ✨

✨ `nodes()` ✨

✨ `pending_tasks()` ✨

✨ `plugins()` ✨

✨ `recovery()` ✨

✨ `repositories()` ✨

✨ `segments()` ✨

✨ `shards()` ✨

✨ `snapshots()` ✨

✨ `tasks()` ✨

✨ `templates()` ✨

✨ `thread_pool()` ✨