Search::Elasticsearch::Client::8_0::Direct::Migration(3)

NAME
Search::Elasticsearch::Client::8_0::Direct::Migration - Plugin providing Migration API for Search::Elasticsearch 8.x

VERSION
version 8.00

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

  DESCRIPTION
This class extends the Search::Elasticsearch client with a "migration" namespace, to support the API Migration APIs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>.

METHODS
The full documentation for the Migration APIs is available here: <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>

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

The deprecations() API is to be used to retrieve information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

See the deprecations docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html> for more information.

Query string parameters:
    "error_trace",
    "human"

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

The get_assistance() API analyzes existing indices in the cluster and returns the information about indices that require some changes before the cluster can be upgraded to the next major version.

See the get_assistance docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html> for more information.

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.

See the upgrade() docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html> for more information.

Query string parameters:
    "error_trace",
    "human",
    "wait_for_completion"

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

COPYRIGHT AND LICENSE
This software is Copyright (c) 2022 by Elasticsearch BV.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004