Package org.elasticsearch.cluster.metadata

Class MetadataIndexUpgradeService

java.lang.Object
org.elasticsearch.cluster.metadata.MetadataIndexUpgradeService
public class MetadataIndexUpgradeService
extends java.lang.Object
This service is responsible for upgrading legacy index metadata to the current version

Every time an existing index is introduced into cluster this service should be used to upgrade the existing index metadata to the latest version of the cluster. It typically occurs during cluster upgrade, when dangling indices are imported into the cluster or indices are restored from a repository.

  • Constructor Summary

    Constructors 
    Constructor Description
    MetadataIndexUpgradeService​(Settings settings, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, MapperRegistry mapperRegistry, IndexScopedSettings indexScopedSettings)  

  • Method Summary

    Modifier and Type Method Description
    IndexMetadata upgradeIndexMetadata​(IndexMetadata indexMetadata, Version minimumIndexCompatibilityVersion)
    Checks that the index can be upgraded to the current version of the master node.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • upgradeIndexMetadata

      public IndexMetadata upgradeIndexMetadata​(IndexMetadata indexMetadata, Version minimumIndexCompatibilityVersion)
      Checks that the index can be upgraded to the current version of the master node.

      If the index does not need upgrade it returns the index metadata unchanged, otherwise it returns a modified index metadata. If index cannot be updated the method throws an exception.