Package org.hibernate.search.backend.elasticsearch.index.layout.impl

Class SimpleIndexLayoutStrategy

java.lang.Object

org.hibernate.search.backend.elasticsearch.index.layout.impl.SimpleIndexLayoutStrategy

All Implemented Interfaces:

IndexLayoutStrategy

public final class SimpleIndexLayoutStrategy
extends Object
implements IndexLayoutStrategy

A simple layout strategy for indexes:

• Elasticsearch index names follow the format used by Elasticsearch's Rollover API: <hsearchname>-<6 digits>. See <target-index> here: https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-rollover-index.html#rollover-index-api-path-params
• The write alias is <hsearchname>-write.
• The read alias is <hsearchname>-read.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME
static Pattern	UNIQUE_KEY_EXTRACTION_PATTERN

Constructor Summary

Constructors

Constructor	Description
SimpleIndexLayoutStrategy()

Method Summary

Modifier and Type	Method	Description
String	createInitialElasticsearchIndexName(String hibernateSearchIndexName)	Generates an initial non-alias Elasticsearch name for an index.
String	createReadAlias(String hibernateSearchIndexName)	Generates the read alias for an index.
String	createWriteAlias(String hibernateSearchIndexName)	Generates the write alias for an index.
String	extractUniqueKeyFromElasticsearchIndexName(String elasticsearchIndexName)	Extracts a unique key from a (non-alias) Elasticsearch index name.
String	extractUniqueKeyFromHibernateSearchIndexName(String hibernateSearchIndexName)	Extracts a unique key from a Hibernate Search index name.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

UNIQUE_KEY_EXTRACTION_PATTERN

public static final Pattern UNIQUE_KEY_EXTRACTION_PATTERN

Constructor Detail

SimpleIndexLayoutStrategy

public SimpleIndexLayoutStrategy()

Method Detail

createInitialElasticsearchIndexName

public String createInitialElasticsearchIndexName(String hibernateSearchIndexName)

Description copied from interface: IndexLayoutStrategy

Generates an initial non-alias Elasticsearch name for an index.

When IndexLayoutStrategy.createReadAlias(String) or IndexLayoutStrategy.createWriteAlias(String) returns null, this must consistently return the same value for each index, even across multiple executions of the application. Otherwise, the only requirement is that returned names are unique.

Specified by:

createInitialElasticsearchIndexName in interface IndexLayoutStrategy

Parameters:

hibernateSearchIndexName - The Hibernate Search name of an index.

Returns:

The non-alias Elasticsearch name for this index.

createWriteAlias

public String createWriteAlias(String hibernateSearchIndexName)

Description copied from interface: IndexLayoutStrategy

Generates the write alias for an index.

This alias will be used when indexing documents, purging the index, ...

This must consistently return the same value for each index, even across multiple executions of the application.

If you do not want to use aliases for write operations, return null: the non-alias name returned by IndexLayoutStrategy.createInitialElasticsearchIndexName(String) will be used instead.

Specified by:

createWriteAlias in interface IndexLayoutStrategy

Parameters:

hibernateSearchIndexName - The Hibernate Search name of an index.

Returns:

The write alias for this index.

createReadAlias

public String createReadAlias(String hibernateSearchIndexName)

Description copied from interface: IndexLayoutStrategy

Generates the read alias for an index.

This alias will be used when executing search queries.

This must consistently return the same value for each index, even across multiple executions of the application.

If you do not want to use aliases for read operations, return null: the non-alias name returned by IndexLayoutStrategy.createInitialElasticsearchIndexName(String) will be used instead.

Specified by:

createReadAlias in interface IndexLayoutStrategy

Parameters:

hibernateSearchIndexName - The Hibernate Search name of an index.

Returns:

The read alias for this index.

extractUniqueKeyFromHibernateSearchIndexName

public String extractUniqueKeyFromHibernateSearchIndexName(String hibernateSearchIndexName)

Description copied from interface: IndexLayoutStrategy

Extracts a unique key from a Hibernate Search index name.

Optional operation: this method only has to be implemented when using the index-name type-name mapping strategy.

This method will be called once per index on bootstrap.

The returned key must be consistent with the key returned by IndexLayoutStrategy.extractUniqueKeyFromElasticsearchIndexName(String).

Specified by:

extractUniqueKeyFromHibernateSearchIndexName in interface IndexLayoutStrategy

Parameters:

hibernateSearchIndexName - The Hibernate Search name of an index.

Returns:

The unique key assigned to that index.

extractUniqueKeyFromElasticsearchIndexName

public String extractUniqueKeyFromElasticsearchIndexName(String elasticsearchIndexName)

Description copied from interface: IndexLayoutStrategy

Extracts a unique key from a (non-alias) Elasticsearch index name.

Optional operation: this method only has to be implemented when using the index-name type-name mapping strategy.

This method will be called once per index on bootstrap.

The returned key must be consistent with the key returned by IndexLayoutStrategy.extractUniqueKeyFromHibernateSearchIndexName(String).

Specified by:

extractUniqueKeyFromElasticsearchIndexName in interface IndexLayoutStrategy

Parameters:

elasticsearchIndexName - A primary index name extracted from an Elasticsearch response.

Returns:

The unique key assigned to that index.