.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Search::Elasticsearch::Client::8_0::Direct::Migration 3pm"
.TH Search::Elasticsearch::Client::8_0::Direct::Migration 3pm 2024-02-04 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Search::Elasticsearch::Client::8_0::Direct::Migration \- Plugin providing Migration API for Search::Elasticsearch 8.x
.SH VERSION
.IX Header "VERSION"
version 8.12
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my $response = $es\->migration\->deprecations();
.Ve
.SS DESCRIPTION
.IX Subsection "DESCRIPTION"
This class extends the Search::Elasticsearch client with a \f(CW\*(C`migration\*(C'\fR
namespace, to support the API
Migration APIs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>.
.SH METHODS
.IX Header "METHODS"
The full documentation for the Migration APIs is available here:
<https://www.elastic.co/guide/en/elasticsearch/reference/current/migration\-api.html>
.ie n .SS deprecations()
.el .SS \f(CWdeprecations()\fP
.IX Subsection "deprecations()"
.Vb 3
\&    $response = $es\->migration\->deprecations(
\&        index => $index      # optional
\&    )
.Ve
.PP
The \f(CWdeprecations()\fR 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.
.PP
See the deprecations docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html>
for more information.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR
.ie n .SS get_assistance()
.el .SS \f(CWget_assistance()\fP
.IX Subsection "get_assistance()"
.Vb 3
\&    $response = $es\->migration\->get_assistance(
\&        index => $index | \e@indices      # optional
\&    )
.Ve
.PP
The \f(CWget_assistance()\fR 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.
.PP
See the get_assistance docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html>
for more information.
.PP
Query string parameters:
    \f(CW\*(C`allow_no_indices\*(C'\fR,
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`expand_wildcards\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`ignore_unavailable\*(C'\fR
.ie n .SS upgrade()
.el .SS \f(CWupgrade()\fP
.IX Subsection "upgrade()"
.Vb 3
\&    $response = $es\->migration\->upgrade(
\&        index => $index       # required
\&    )
.Ve
.PP
The \f(CWupgrade()\fR API performs the upgrade of internal indices to make them compatible with the
next major version.
.PP
See the \fBupgrade()\fR docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html>
for more information.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`wait_for_completion\*(C'\fR
.SH AUTHOR
.IX Header "AUTHOR"
Enrico Zimuel <enrico.zimuel@elastic.co>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2024 by Elasticsearch BV.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve