Package org.hibernate.search.backend.elasticsearch.cfg

Class ElasticsearchIndexSettings

java.lang.Object

org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchIndexSettings

public final class ElasticsearchIndexSettings
extends Object

Configuration properties for Elasticsearch indexes.

Constants in this class are to be appended to a prefix to form a property key; see IndexSettings for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ElasticsearchIndexSettings.Defaults	Default values for the different settings if no values are given.
static final class	ElasticsearchIndexSettings.IndexingRadicals	Configuration property keys for indexing, without the prefix.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANALYSIS_CONFIGURER	The analysis configurer applied to this index.
static final String	DYNAMIC_MAPPING	The default for the dynamic_mapping attribute in the Elasticsearch mapping.
static final String	INDEXING_MAX_BULK_SIZE	The maximum size of bulk requests created when processing indexing queues.
static final String	INDEXING_PREFIX	The prefix for indexing-related property keys.
static final String	INDEXING_QUEUE_COUNT	The number of indexing queues assigned to each index.
static final String	INDEXING_QUEUE_SIZE	The size of indexing queues.
static final String	SCHEMA_MANAGEMENT_MAPPING_FILE	The path to a mappings file, allowing custom mappings for indexes created by Hibernate Search as part of schema management.
static final String	SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS	The minimal required status of an index on startup, before Hibernate Search can start using it.
static final String	SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT	The timeout when waiting for the required status.
static final String	SCHEMA_MANAGEMENT_SETTINGS_FILE	The path to a settings file, allowing custom settings for indexes created by Hibernate Search as part of schema management.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

ANALYSIS_CONFIGURER

public static final String ANALYSIS_CONFIGURER

The analysis configurer applied to this index.

Expects a single-valued or multi-valued reference to beans of type ElasticsearchAnalysisConfigurer.

Defaults to no value.

See Also:

• The core documentation of configuration properties, which includes a description of the "multi-valued bean reference" properties and accepted values.
• Constant Field Values

SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS

public static final String SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS

The minimal required status of an index on startup, before Hibernate Search can start using it.

Expects an IndexStatus value, or a String representation of such value.

Defaults to yellow when targeting an Elasticsearch distribution that supports index status checking, and to no value (no requirement) when targeting an Elasticsearch distribution that does not support index status checking (like Amazon OpenSearch Serverless).

See Also:

• Constant Field Values

SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT

public static final String SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT

The timeout when waiting for the required status.

Expects a positive Integer value in milliseconds, such as 60000, or a String that can be parsed into such Integer value.

Defaults to ElasticsearchIndexSettings.Defaults.SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT.

See Also:

• Constant Field Values

SCHEMA_MANAGEMENT_SETTINGS_FILE

public static final String SCHEMA_MANAGEMENT_SETTINGS_FILE

The path to a settings file, allowing custom settings for indexes created by Hibernate Search as part of schema management.

Expects a string representing the path to a UTF-8-encoded file in the classpath. The file must contain index settings expressed in JSON format, with the exact same syntax as expected by the Elasticsearch server under the "settings" property when creating an index. For example, if the file content is {"index.codec": "best_compression"}, it will set index.codec to best_compression.

Note that the settings generated by Hibernate Search will be overridden in case of conflict of some definitions. For instance, if an analyzer "myAnalyzer" is defined by the ANALYSIS_CONFIGURER and this settings file, the definition from the settings file will take precedence. If it is only defined in either the analysis configurer or the settings file, but not both, it will be preserved as-is.

Defaults to no value, meaning only index settings generated by Hibernate Search will be used.

See Also:

• Constant Field Values

SCHEMA_MANAGEMENT_MAPPING_FILE

public static final String SCHEMA_MANAGEMENT_MAPPING_FILE

The path to a mappings file, allowing custom mappings for indexes created by Hibernate Search as part of schema management.

Expects a string representing the path to a UTF-8-encoded file in the classpath. The file must contain index settings expressed in JSON format, with the exact same syntax as expected by the Elasticsearch server under the "mappings" property when defining the mapping for an index.

The file does not need to contain the full mapping: Hibernate Search will automatically inject missing properties (index fields) in the given mapping.

Conflicts between the given mapping and the mapping generated by Hibernate Search will be handled as follows:

• Mapping parameters other than properties at the mapping root will be those from the given mapping; those generated by Hibernate Search will be ignored.
• properties will be merged, using properties defined in both the given mapping and the mapping generated by Hibernate Search. If a property is defined on both sides, mapping parameters from the given mapping will be used, except for properties, which will be merged recursively in the same way.

Defaults to no value, meaning only index mappings generated by Hibernate Search will be used.

See Also:

• Constant Field Values

DYNAMIC_MAPPING

public static final String DYNAMIC_MAPPING

The default for the dynamic_mapping attribute in the Elasticsearch mapping.

In case of dynamic fields with field templates, this setting will be ignored, since field templates force dynamic_mapping to DynamicMapping.TRUE.

Defaults to ElasticsearchIndexSettings.Defaults.DYNAMIC_MAPPING.

See Also:

• DynamicMapping
• Constant Field Values

INDEXING_PREFIX

public static final String INDEXING_PREFIX

The prefix for indexing-related property keys.

See Also:

• Constant Field Values

INDEXING_QUEUE_COUNT

public static final String INDEXING_QUEUE_COUNT

The number of indexing queues assigned to each index.

Expects a strictly positive integer value, or a string that can be parsed into an integer value.

Defaults to ElasticsearchIndexSettings.Defaults.INDEXING_QUEUE_COUNT.

See the reference documentation, section "Elasticsearch backend - Indexing", for more information about this setting and its implications.

See Also:

• Constant Field Values

INDEXING_QUEUE_SIZE

public static final String INDEXING_QUEUE_SIZE

The size of indexing queues.

Expects a strictly positive integer value, or a string that can be parsed into an integer value.

See the reference documentation, section "Elasticsearch backend - Indexing", for more information about this setting and its implications.

Defaults to ElasticsearchIndexSettings.Defaults.INDEXING_QUEUE_SIZE.

See Also:

• Constant Field Values

INDEXING_MAX_BULK_SIZE

public static final String INDEXING_MAX_BULK_SIZE

The maximum size of bulk requests created when processing indexing queues.

Expects a strictly positive integer value, or a string that can be parsed into an integer value.

See the reference documentation, section "Elasticsearch backend - Indexing", for more information about this setting and its implications.

Defaults to ElasticsearchIndexSettings.Defaults.INDEXING_MAX_BULK_SIZE.

See Also:

• Constant Field Values