Package io.quarkus.hibernate.search.orm.elasticsearch.runtime

Class HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.ElasticsearchBackendBuildTimeConfig

java.lang.Object

io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.ElasticsearchBackendBuildTimeConfig

Enclosing class:

HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit

public static class HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.ElasticsearchBackendBuildTimeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.ElasticsearchIndexBuildTimeConfig	indexDefaults	The default configuration for the Elasticsearch indexes.
Map<String,HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.ElasticsearchIndexBuildTimeConfig>	indexes	Per-index specific configuration.
HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.LayoutConfig	layout	Configuration for the index layout.
Optional<org.hibernate.search.backend.elasticsearch.ElasticsearchVersion>	version	The version of Elasticsearch used in the cluster.
boolean	versionCheck	Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.

Constructor Summary

Constructors

Constructor	Description
ElasticsearchBackendBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

version

@ConfigItem
public Optional<org.hibernate.search.backend.elasticsearch.ElasticsearchVersion> version

The version of Elasticsearch used in the cluster.

As the schema is generated without a connection to the server, this item is mandatory.

It doesn't have to be the exact version (it can be 7 or 7.1 for instance) but it has to be sufficiently precise to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used to communicate with Elasticsearch).

There's no rule of thumb here as it depends on the schema incompatibilities introduced by Elasticsearch versions. In any case, if there is a problem, you will have an error when Hibernate Search tries to connect to the cluster.

versionCheck

@ConfigItem(name="version-check.enabled",
            defaultValue="true")
public boolean versionCheck

Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.

Set to false if the Elasticsearch cluster may not be available on startup.

layout

@ConfigItem
public HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.LayoutConfig layout

Configuration for the index layout.

indexDefaults

@ConfigItem(name="<<parent>>")
public HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.ElasticsearchIndexBuildTimeConfig indexDefaults

The default configuration for the Elasticsearch indexes.

indexes

@ConfigItem
@ConfigDocMapKey("index-name")
public Map<String,HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.ElasticsearchIndexBuildTimeConfig> indexes

Per-index specific configuration.

Constructor Detail

ElasticsearchBackendBuildTimeConfig

public ElasticsearchBackendBuildTimeConfig()