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

Interface HibernateSearchElasticsearchRuntimeConfigPersistenceUnit

public interface HibernateSearchElasticsearchRuntimeConfigPersistenceUnit

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.AutomaticIndexingConfig	Deprecated.
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.AutomaticIndexingSynchronizationConfig	Deprecated.
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.IndexingConfig
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.IndexingPlanConfig
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.IndexingPlanSynchronizationConfig
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.MultiTenancyConfig
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SchemaManagementConfig
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SearchQueryLoadingCacheLookupConfig
static interface	HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SearchQueryLoadingConfig

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	active()	Whether Hibernate Search should be active for this persistence unit at runtime.
HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.AutomaticIndexingConfig	automaticIndexing()	Deprecated. Use indexing() instead.
@WithUnnamedKey Map<String,io.quarkus.hibernate.search.backend.elasticsearch.common.runtime.HibernateSearchBackendElasticsearchRuntimeConfig>	backends()	Configuration for Elasticsearch/OpenSearch backends.
HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.IndexingConfig	indexing()	Configuration for indexing.
HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.MultiTenancyConfig	multiTenancy()	Configuration for multi-tenancy.
HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SearchQueryLoadingConfig	queryLoading()	Configuration for how entities are loaded by a search query.
HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SchemaManagementConfig	schemaManagement()	Configuration for automatic creation and validation of the Elasticsearch schema: indexes, their mapping, their settings.

Method Details

active

@ConfigDocDefault("\'true\' if Hibernate Search is enabled and the persistence unit is active; \'false\' otherwise")
Optional<Boolean> active()

Whether Hibernate Search should be active for this persistence unit at runtime. If Hibernate Search is not active, it won't index Hibernate ORM entities, and accessing the SearchMapping/SearchSession of the relevant persistence unit for search or other operation will not be possible. Note that if Hibernate Search is disabled (i.e. `quarkus.hibernate-search-orm.enabled` is set to `false`), it won't be active for any persistence unit, and setting this property to `true` will fail.

backends

@ConfigDocSection
@WithName("elasticsearch")
@WithUnnamedKey
@ConfigDocMapKey("backend-name")
@WithUnnamedKey Map<String,io.quarkus.hibernate.search.backend.elasticsearch.common.runtime.HibernateSearchBackendElasticsearchRuntimeConfig> backends()

Configuration for Elasticsearch/OpenSearch backends.

schemaManagement

HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SchemaManagementConfig schemaManagement()

Configuration for automatic creation and validation of the Elasticsearch schema: indexes, their mapping, their settings.

queryLoading

@WithName("query.loading")
HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.SearchQueryLoadingConfig queryLoading()

Configuration for how entities are loaded by a search query.

indexing

HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.IndexingConfig indexing()

Configuration for indexing.

automaticIndexing

@Deprecated
HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.AutomaticIndexingConfig automaticIndexing()

Deprecated.

Use indexing() instead.

Configuration for automatic indexing.

multiTenancy

HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.MultiTenancyConfig multiTenancy()

Configuration for multi-tenancy.