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

📦 version 7.715, in ubuntu jammy

💖 Search::Elasticsearch::Client::7_0::Direct::CCR 💖

okay bestie, so this is the cross-cluster replication plugin for Search::Elasticsearch 7.x — aka the Search::Elasticsearch::Client::7_0::Direct::CCR module, and it's giving "your data, but in two places at once" energy. ✨

It's version 7.715. 🎀

✨ DESCRIPTION ✨

This module hands you the methods you need to use the cross-cluster replication feature. That's it, that's the vibe. 🦋

The full documentation for CCR lives right here, go look:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html

🌈 FOLLOW METHODS 🌈

🫶 follow()

$response = $es->ccr->follow(
    index   => $index,  # required
    body    => {...}    # required
)

The follow() method creates a brand new follower index that's configured to follow the referenced leader index. It's literally setting up the parasocial relationship between your indices. 👑

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"
  • "wait_for_active_shards"

See the CCR follow docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html

⏸️ pause_follow()

$response = $es->ccr->pause_follow(
    index   => $index,  # required
)

The pause_follow() method pauses following of an index. Taking a lil nap, no big deal. 😴

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR pause follow docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html

▶️ resume_follow()

$response = $es->ccr->resume_follow(
    index   => $index,  # required
)

The resume_follow() method resumes following of an index. Nap's over, back to work bestie. 💅

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR resume follow docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html

💔 unfollow()

$response = $es->ccr->unfollow(
    index   => $index,  # required
)

The unfollow() method converts a follower index into a normal index. It's the "we need to break up, I'm my own person now" of index operations. 🦋

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR unfollow docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html

🧹 forget_follower()

$response = $es->ccr->forget_follower(
    index   => $index,  # required
)

The forget_follower() method removes the follower retention leases from the leader. Cleaning up the receipts, as one does. 🙈

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR forget_follower docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html

📊 STATS METHODS 📊

🍓 stats()

$response = $es->ccr->stats()

The stats() method returns all the stats related to cross-cluster replication. All of them. Every last one. 🔥

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR stats docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html

🔍 follow_stats()

$response = $es->ccr->follow_stats(
    index   => $index | \@indices,  # optional
)

The follow_stats() method returns shard-level stats about follower indices. Deep dive energy, lowkey obsessed. 💜

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR follow stats docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html

🎀 follow_info()

$response = $es->ccr->follow_info(
    index   => $index | \@indices,  # optional
)

The follow_info() method returns the parameters and the status for each follower index. The whole situation. The full lore. ✨

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR follow info docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html

🦋 AUTO-FOLLOW METHODS 🦋

🌸 put_auto_follow_pattern()

$response = $es->ccr->put_auto_follow_pattern(
    name    => $name    # required
)

The put_auto_follow_pattern() method creates a new named collection of auto-follow patterns against the remote cluster specified in the request body. Setting up the automation so you don't have to lift a finger. Iconic behaviour. 👑

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR put auto follow pattern docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html

🔎 get_auto_follow_pattern()

$response = $es->ccr->get_auto_follow_pattern(
    name    => $name    # optional
)

The get_auto_follow_pattern() method retrieves a named collection of auto-follow patterns, or — plot twist — all patterns if you don't specify one. 😭

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR get auto follow pattern docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html

🗑️ delete_auto_follow_pattern()

$response = $es->ccr->delete_auto_follow_pattern(
    name    => $name    # required
)

The delete_auto_follow_pattern() method deletes a named collection of auto-follow patterns. Gone. Deleted. Not me crying over it. 💀

Query string parameters:

  • "error_trace"
  • "filter_path"
  • "human"

See the CCR delete auto follow pattern docs for more info:

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html

👑 AUTHOR 👑

Enrico Zimuel <enrico.zimuel@elastic.co> — the actual legend who wrote this. 🫶

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004
no cap, that's the whole page. this one's perl v5.32.1, dated 2021-10-23, and it's a Search::Elasticsearch::Client::7_0::Direct::CCR 3pm manual page. go forth and replicate, bestie 💖✨🎀🦋🌸💅🫶
📦 where this page comes from