Search...gration(3pm)

💖 NAME 💖

Search::Elasticsearch::Client::8_0::Direct::Migration — bestie, this is the plugin that hands you the Migration API for Search::Elasticsearch 8.x. And yeah, the manual page it lives on is Search...gration(3pm) (the middle got munched, we don't talk about it 💀), sitting in the perl section 3pm.

---

✨ VERSION ✨

version 8.12 — that's the one, no cap.

---

🎀 SYNOPSIS 🎀

my $response = $es->migration->deprecations();

Look at her. One line. Main character energy fr fr. 🫶

---

🌸 DESCRIPTION 🌸

Okay so here's the tea: this class extends the Search::Elasticsearch client with a whole migration namespace, so you can call the API Migration APIs right from your Perl code.

The official docs for those APIs live here, and yes you're gonna want them open in another tab:

https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html

---

💅 METHODS 💅

The full documentation for the Migration APIs is available here, and it's giving very much required-reading:

https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html

---

🦋 deprecations()

$response = $es->migration->deprecations(
    index => $index      # optional
)

The deprecations() API is literally the vibe check for your cluster 💀 — you use it to retrieve info about all the different cluster, node, and index level settings that are using deprecated features. And why do we care? Because those features are getting removed or changed in the next major version. So like, they're on the way out, bestie. 👋

See the deprecations docs for more:

https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html

Query string parameters:

• "error_trace"
• "human"

---

🧚 get_assistance()

$response = $es->migration->get_assistance(
    index => $index | \@indices      # optional
)

The get_assistance() API analyzes the existing indices in your cluster and returns the info about which indices need some changes before the cluster can be upgraded to the next major version. It's giving "let me hold your hand through this glow-up" 🫶✨

See the get_assistance docs for more:

https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html

Query string parameters:

• "allow_no_indices"
• "error_trace"
• "expand_wildcards"
• "human"
• "ignore_unavailable"

---

👑 upgrade()

$response = $es->migration->upgrade(
    index => $index       # required
)

The upgrade() API performs the upgrade of internal indices to make them compatible with the next major version. Notice that index is required here — not optional, not vibes-based, required. Don't skip it. 🙈

See the upgrade() docs for more:

https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html

Query string parameters:

• "error_trace"
• "human"
• "wait_for_completion"

---

🌈 AUTHOR 🌈

Enrico Zimuel <enrico.zimuel@elastic.co> — icon, legend, the moment. 👑

---

💜 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

---

And that's the whole page, bestie! 🎀 This little beauty was brought to you by perl v5.38.2, dated 2024-02-04, and it goes by Search...gration(3pm) — slay, mwah 💅✨