Package io.jmix.searchopensearch.index.impl

Class OpenSearchIndexManager

java.lang.Object

io.jmix.search.index.impl.BaseIndexManager<org.opensearch.client.opensearch.indices.IndexState,org.opensearch.client.opensearch.indices.IndexSettings,org.opensearch.client.json.JsonpSerializable>

io.jmix.searchopensearch.index.impl.OpenSearchIndexManager

All Implemented Interfaces:

IndexManager

public class OpenSearchIndexManager
extends BaseIndexManager<org.opensearch.client.opensearch.indices.IndexState,org.opensearch.client.opensearch.indices.IndexSettings,org.opensearch.client.json.JsonpSerializable>

Implementation for OpenSearch

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.opensearch.client.opensearch.OpenSearchClient	client
protected final OpenSearchIndexSettingsProvider	indexSettingsProcessor
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final OpenSearchPutMappingRequestBuilder	putMappingRequestBuilder

Fields inherited from class io.jmix.search.index.impl.BaseIndexManager

indexConfigurationComparator, indexConfigurationManager, indexStateRegistry, indexStateResolver, searchProperties

Constructor Summary

Constructors

Constructor

Description

OpenSearchIndexManager(org.opensearch.client.opensearch.OpenSearchClient client, IndexStateRegistry indexStateRegistry, IndexConfigurationManager indexConfigurationManager, SearchProperties searchProperties, OpenSearchIndexSettingsProvider indexSettingsProcessor, OpenSearchIndexConfigurationComparator configurationComparator, OpenSearchIndexStateResolver metadataResolver, OpenSearchPutMappingRequestBuilder putMappingRequestBuilder)

Method Summary

Modifier and Type	Method	Description
protected org.opensearch.client.opensearch._types.mapping.TypeMapping	buildMapping(IndexConfiguration indexConfiguration)
protected org.opensearch.client.opensearch.indices.IndexSettings	buildSettings(IndexConfiguration indexConfiguration)
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	putMapping(String indexName, IndexMappingConfiguration mappingConfiguration)	Saves mapping to index on the search server or servers cluster.

Methods inherited from class io.jmix.search.index.impl.BaseIndexManager

handleMissingIndex, recreateIndex, recreateIndexes, recreateIndexes, recreateIrrelevantIndex, synchronizeIndexSchema, synchronizeIndexSchema, synchronizeIndexSchemas, synchronizeIndexSchemas, updateIndexConfiguration, validateIndex, validateIndexes, validateIndexes

Methods inherited from class java.lang.Object

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

Field Details

client

protected final org.opensearch.client.opensearch.OpenSearchClient client

indexSettingsProcessor

protected final OpenSearchIndexSettingsProvider indexSettingsProcessor

putMappingRequestBuilder

protected final OpenSearchPutMappingRequestBuilder putMappingRequestBuilder

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

OpenSearchIndexManager

public OpenSearchIndexManager(org.opensearch.client.opensearch.OpenSearchClient client,
 IndexStateRegistry indexStateRegistry,
 IndexConfigurationManager indexConfigurationManager,
 SearchProperties searchProperties,
 OpenSearchIndexSettingsProvider indexSettingsProcessor,
 OpenSearchIndexConfigurationComparator configurationComparator,
 OpenSearchIndexStateResolver metadataResolver,
 OpenSearchPutMappingRequestBuilder putMappingRequestBuilder)

Method Details

createIndex

public boolean createIndex(IndexConfiguration indexConfiguration)

Description copied from interface: IndexManager

Creates index if not exists using provided IndexConfiguration.

Parameters:

indexConfiguration - index configuration

Returns:

true if index was successfully created, false otherwise

dropIndex

public boolean dropIndex(String indexName)

Description copied from interface: IndexManager

Drops index by name.

Parameters:

indexName - index name

Returns:

true if index was successfully dropped, false otherwise

isIndexExist

public boolean isIndexExist(String indexName)

Description copied from interface: IndexManager

Checks if index exists.

Parameters:

indexName - index name

Returns:

true if index exists, false otherwise

getIndexMetadata

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

Description copied from interface: IndexManager

Requests info about index from server.

Parameters:

indexName - index name

Returns:

response as Json

putMapping

public boolean putMapping(String indexName,
 IndexMappingConfiguration mappingConfiguration)

Description copied from interface: IndexManager

Saves mapping to index on the search server or servers cluster.

Parameters:

indexName - name of the index for saving mapping

mappingConfiguration - mapping for saving to configuration of the specified index

Returns:

true if saving process was performed successfully.

buildMapping

protected org.opensearch.client.opensearch._types.mapping.TypeMapping buildMapping(IndexConfiguration indexConfiguration)

buildSettings

protected org.opensearch.client.opensearch.indices.IndexSettings buildSettings(IndexConfiguration indexConfiguration)