Package io.jmix.search.index

Interface IndexManager

All Known Implementing Classes:

BaseIndexManager, ElasticsearchIndexManager, NoopIndexManager, OpenSearchIndexManager

@NullMarked
public interface IndexManager

Provides functionality for index management.

Method Summary

Modifier and Type	Method	Description
boolean	createIndex(IndexConfiguration indexConfiguration)	Creates index if not exists using provided IndexConfiguration.
boolean	dropIndex(String indexName)	Drops index by name.
com.fasterxml.jackson.databind.node.ObjectNode	getIndexMetadata(String indexName)	Requests info about index from server.
boolean	isIndexExist(String indexName)	Checks if index exists.
boolean	recreateIndex(IndexConfiguration indexConfiguration)	Drops and creates search index using provided IndexConfiguration.
Map<IndexConfiguration,Boolean>	recreateIndexes()	Drops and creates all search indexes.
Map<IndexConfiguration,Boolean>	recreateIndexes(Collection<IndexConfiguration> indexConfigurations)	Drops and creates search indexes using provided collection of IndexConfiguration.
IndexSynchronizationStatus	synchronizeIndexSchema(IndexConfiguration indexConfiguration)	Synchronizes schema of search index for provided IndexConfiguration.
Map<IndexConfiguration,IndexSynchronizationStatus>	synchronizeIndexSchemas()	Synchronizes schemas of all search indexes defined in application.
Map<IndexConfiguration,IndexSynchronizationStatus>	synchronizeIndexSchemas(Collection<IndexConfiguration> indexConfigurations)	Synchronizes schemas of search indexes for provided collection of IndexConfiguration.
IndexValidationStatus	validateIndex(IndexConfiguration indexConfiguration)	Validates current state of index schema.
Map<IndexConfiguration,IndexValidationStatus>	validateIndexes()	Validates current state of schema of all search indexes defined in application.
Map<IndexConfiguration,IndexValidationStatus>	validateIndexes(Collection<IndexConfiguration> indexConfigurations)	Validates current state of index schema related to provided collection of IndexConfiguration.

Method Details

createIndex

boolean createIndex(IndexConfiguration indexConfiguration)

Creates index if not exists using provided IndexConfiguration.

Parameters:

indexConfiguration - index configuration

Returns:

true if index was successfully created, false otherwise

dropIndex

boolean dropIndex(String indexName)

Drops index by name.

Parameters:

indexName - index name

Returns:

true if index was successfully dropped, false otherwise

recreateIndexes

Map<IndexConfiguration,Boolean> recreateIndexes()

Drops and creates all search indexes.

Returns:

Map with operation result per every index configuration

recreateIndexes

Map<IndexConfiguration,Boolean> recreateIndexes(Collection<IndexConfiguration> indexConfigurations)

Drops and creates search indexes using provided collection of IndexConfiguration.

Parameters:

indexConfigurations - index configurations

Returns:

Map with operation result per every index configuration

recreateIndex

boolean recreateIndex(IndexConfiguration indexConfiguration)

Drops and creates search index using provided IndexConfiguration.

Parameters:

indexConfiguration - index configuration

Returns:

true if index was successfully recreated, false otherwise

isIndexExist

boolean isIndexExist(String indexName)

Checks if index exists.

Parameters:

indexName - index name

Returns:

true if index exists, false otherwise

validateIndexes

Map<IndexConfiguration,IndexValidationStatus> validateIndexes()

Validates current state of schema of all search indexes defined in application.

Returns:

IndexValidationStatus per each IndexConfiguration

validateIndexes

Map<IndexConfiguration,IndexValidationStatus> validateIndexes(Collection<IndexConfiguration> indexConfigurations)

Validates current state of index schema related to provided collection of IndexConfiguration.

Parameters:

indexConfigurations - actual configurations

Returns:

IndexValidationStatus per each IndexConfiguration

validateIndex

IndexValidationStatus validateIndex(IndexConfiguration indexConfiguration)

Validates current state of index schema.

Parameters:

indexConfiguration - actual configuration

Returns:

IndexValidationStatus

getIndexMetadata

com.fasterxml.jackson.databind.node.ObjectNode getIndexMetadata(String indexName)

Requests info about index from server.

Parameters:

indexName - index name

Returns:

response as Json

synchronizeIndexSchemas

Map<IndexConfiguration,IndexSynchronizationStatus> synchronizeIndexSchemas()

Synchronizes schemas of all search indexes defined in application.

See synchronizeIndexSchemas(Collection)

See synchronizeIndexSchema(IndexConfiguration)

Returns:

IndexSynchronizationStatus per each IndexConfiguration

synchronizeIndexSchemas

Map<IndexConfiguration,IndexSynchronizationStatus> synchronizeIndexSchemas(Collection<IndexConfiguration> indexConfigurations)

Synchronizes schemas of search indexes for provided collection of IndexConfiguration.

See synchronizeIndexSchema(IndexConfiguration)

Parameters:

indexConfigurations - actual index configurations

Returns:

IndexSynchronizationStatus per each IndexConfiguration

synchronizeIndexSchema

IndexSynchronizationStatus synchronizeIndexSchema(IndexConfiguration indexConfiguration)

Synchronizes schema of search index for provided IndexConfiguration.

It tries to update schema to the actual state according to IndexSchemaManagementStrategy defined by 'jmix.search.indexSchemaManagementStrategy' application property.

Parameters:

indexConfiguration - actual index configuration

Returns:

IndexSynchronizationStatus