Package io.quarkus.hibernate.orm.deployment

Interface HibernateOrmConfig

@ConfigMapping(prefix="quarkus.hibernate-orm")
@ConfigRoot
public interface HibernateOrmConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HibernateOrmConfig.HibernateOrmConfigDatabase
static interface	HibernateOrmConfig.HibernateOrmConfigLog
static interface	HibernateOrmConfig.HibernateOrmConfigMetric
static interface	HibernateOrmConfig.HibernateOrmConfigPersistenceXml

Method Summary

Modifier and Type	Method	Description
HibernateOrmConfig.HibernateOrmConfigDatabase	database()	Database related configuration.
default HibernateOrmConfigPersistenceUnit	defaultPersistenceUnit()
boolean	enabled()	Whether Hibernate ORM is enabled *during the build*.
default boolean	isAnyNonPersistenceXmlPropertySet()
HibernateOrmConfig.HibernateOrmConfigLog	log()	Logging configuration.
Optional<Boolean>	logSessionMetrics()	Whether session metrics should be appended into the server log for each Hibernate session.
HibernateOrmConfig.HibernateOrmConfigMetric	metrics()	Configuration related to metrics.
default Map<String,HibernateOrmConfigPersistenceUnit>	namedPersistenceUnits()
@WithUnnamedKey("<default>") Map<String,HibernateOrmConfigPersistenceUnit>	persistenceUnits()	Configuration for persistence units.
HibernateOrmConfig.HibernateOrmConfigPersistenceXml	persistenceXml()	Configuration for the persistence.xml handling.
Optional<Boolean>	statistics()	Whether statistics collection is enabled.

Method Details

enabled

@WithDefault("true")
boolean enabled()

Whether Hibernate ORM is enabled *during the build*. If Hibernate ORM is disabled during the build, all processing related to Hibernate ORM will be skipped, but it will not be possible to activate Hibernate ORM at runtime: `quarkus.hibernate-orm.active` will default to `false` and setting it to `true` will lead to an error.

database

@ConfigDocSection
HibernateOrmConfig.HibernateOrmConfigDatabase database()

Database related configuration.

persistenceUnits

@WithParentName
@WithUnnamedKey("<default>")
@WithDefaults
@ConfigDocMapKey("persistence-unit-name")
@WithUnnamedKey("<default>") Map<String,HibernateOrmConfigPersistenceUnit> persistenceUnits()

Configuration for persistence units.

defaultPersistenceUnit

default HibernateOrmConfigPersistenceUnit defaultPersistenceUnit()

namedPersistenceUnits

default Map<String,HibernateOrmConfigPersistenceUnit> namedPersistenceUnits()

persistenceXml

HibernateOrmConfig.HibernateOrmConfigPersistenceXml persistenceXml()

Configuration for the persistence.xml handling.

log

@ConfigDocSection
HibernateOrmConfig.HibernateOrmConfigLog log()

Logging configuration.

statistics

Optional<Boolean> statistics()

Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false.

logSessionMetrics

Optional<Boolean> logSessionMetrics()

Whether session metrics should be appended into the server log for each Hibernate session. This only has effect if statistics are enabled (`quarkus.hibernate-orm.statistics`). The default is false (which means both `statistics` and `log-session-metrics` need to be enabled for the session metrics to appear in the log).

metrics

HibernateOrmConfig.HibernateOrmConfigMetric metrics()

Configuration related to metrics.

isAnyNonPersistenceXmlPropertySet

default boolean isAnyNonPersistenceXmlPropertySet()