org.hibernate.search.elasticsearch.schema.impl

Interface ElasticsearchSchemaMigrator

All Known Implementing Classes:

DefaultElasticsearchSchemaMigrator

public interface ElasticsearchSchemaMigrator

An object responsible for updating an existing index to match provided metadata.

Author:

Yoann Rodiere

Method Summary

Modifier and Type	Method and Description
void	migrate(IndexMetadata indexMetadata, ExecutionOptions executionOptions) Update the existing schema to match the given metadata: for each mapping, update the existing mappings and analyzer definitions to match the expected ones, throwing SearchException if an incompatible attribute is detected.

Method Detail

migrate

void migrate(IndexMetadata indexMetadata,
             ExecutionOptions executionOptions)

Update the existing schema to match the given metadata: for each mapping, update the existing mappings and analyzer definitions to match the expected ones, 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.