org.hibernate.search.elasticsearch.schema.impl

Interface ElasticsearchSchemaMigrator

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultElasticsearchSchemaMigrator

public interface ElasticsearchSchemaMigrator
extends Service

An object responsible for merging an existing index with provided metadata.

Author:

Yoann Rodiere

Method Summary

Modifier and Type	Method and Description
void	merge(IndexMetadata indexMetadata, ExecutionOptions executionOptions) Merge metadata with the existing schema: for each mapping, merge the existing mapping with the expected one, throwing SearchException if an incompatible attribute is detected.

Method Detail

merge

void merge(IndexMetadata indexMetadata,
           ExecutionOptions executionOptions)

Merge metadata with the existing schema: for each mapping, merge the existing mapping with the expected one, throwing SearchException if an incompatible attribute is detected.

The index is expected to already exist.

Parameters:

indexMetadata - The expected index metadata.

executionOptions - The execution options, giving more context information.

Throws:

SearchException - If an error occurs.