Search...gration(3pm)

📦 version 7.715, in ubuntu jammy

💅 Search::Elasticsearch::Client::7_0::Direct::Migration 💅

okay so bestie, this is the Search::Elasticsearch::Client::7_0::Direct::Migration page — a Perl manpage (section 3pm) from the User Contributed Perl Documentation. It's the little plugin that hands you the Migration API for Search::Elasticsearch 7.x. Yes queen, we're migrating. ✨

🌸 NAME 🌸

Search::Elasticsearch::Client::7_0::Direct::Migration — the plugin that provides the Migration API for Search::Elasticsearch 7.x. That's it, that's the whole job, and it does it gorgeously. 🎀

⭐ VERSION ⭐

version 7.715 — noted, memorized, iconic. 👑

🦋 SYNOPSIS 🦋

like, the whole vibe in one line:

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

that's the teaser, the rest is below the cut. 🙈

💖 DESCRIPTION 💖

So basically: this class extends the Search::Elasticsearch client with a migration namespace, so you can hit up the API Migration APIs without leaving your cozy Perl bubble.

The official docs for those live here, no cap: <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>

✨ METHODS ✨

The full documentation for the Migration APIs is right here, bestie, go read it: <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>

🫶 deprecations()

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

The deprecations() API is your little gossip session with the cluster — it retrieves info about all the different cluster, node, and index level settings that are using deprecated features, i.e. the ones that are getting removed or changed in the next major version. It's giving "let me tell you what's about to be a problem." 💀

More tea in the deprecations docs: <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 the cluster and hands back the info about which indices need some changes before the cluster can be upgraded to the next major version. It's the "hey bestie, you might wanna fix these first" of APIs. 🌈

See the get_assistance docs for the full story: <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 so they're compatible with the next major version. Glow up time, periodt. ✨

Heads up: index is required here — not optional, not negotiable, not playing. 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> — we stan. 👑

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

and that's a wrap on the Search::Elasticsearch::Client::7_0::Direct::Migration page, bestie — generated by perl v5.32.1 on 2021-10-23, served fresh from the User Contributed Perl Documentation. go upgrade those indices, you absolute icon 🎀💖✨

📦 where this page comes from