Package io.quarkus.hibernate.orm.deployment

Class HibernateOrmConfig

java.lang.Object

io.quarkus.hibernate.orm.deployment.HibernateOrmConfig

@ConfigRoot
public class HibernateOrmConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HibernateOrmConfig.HibernateOrmConfigDatabase
static class	HibernateOrmConfig.HibernateOrmConfigLog
static class	HibernateOrmConfig.HibernateOrmConfigPersistenceXml

Field Summary

Fields

Modifier and Type	Field	Description
HibernateOrmConfig.HibernateOrmConfigDatabase	database	Database related configuration.
HibernateOrmConfigPersistenceUnit	defaultPersistenceUnit	Configuration for the default persistence unit.
boolean	enabled	Whether Hibernate ORM is enabled *during the build*.
HibernateOrmConfig.HibernateOrmConfigLog	log	Logging configuration.
Optional<Boolean>	logSessionMetrics	Whether session metrics should be appended into the server log for each Hibernate session.
boolean	metricsEnabled	Whether metrics are published if a metrics extension is enabled.
Map<String,HibernateOrmConfigPersistenceUnit>	persistenceUnits	Additional named persistence units.
HibernateOrmConfig.HibernateOrmConfigPersistenceXml	persistenceXml	Configuration for the persistence.xml handling.
Optional<Boolean>	statistics	Whether statistics collection is enabled.

Constructor Summary

Constructors

Constructor	Description
HibernateOrmConfig()

Method Summary

Modifier and Type	Method	Description
Map<String,HibernateOrmConfigPersistenceUnit>	getAllPersistenceUnitConfigsAsMap()
boolean	isAnyNonPersistenceXmlPropertySet()

Methods inherited from class java.lang.Object

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

Field Detail

enabled

@ConfigItem(defaultValue="true")
public 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

@ConfigItem
@ConfigDocSection
public HibernateOrmConfig.HibernateOrmConfigDatabase database

Database related configuration.

defaultPersistenceUnit

@ConfigItem(name="<<parent>>")
public HibernateOrmConfigPersistenceUnit defaultPersistenceUnit

Configuration for the default persistence unit.

persistenceUnits

@ConfigDocSection
@ConfigDocMapKey("persistence-unit-name")
@ConfigItem(name="<<parent>>")
public Map<String,HibernateOrmConfigPersistenceUnit> persistenceUnits

Additional named persistence units.

persistenceXml

@ConfigItem
public HibernateOrmConfig.HibernateOrmConfigPersistenceXml persistenceXml

Configuration for the persistence.xml handling.

log

@ConfigItem
@ConfigDocSection
public HibernateOrmConfig.HibernateOrmConfigLog log

Logging configuration.

statistics

@ConfigItem
public 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

@ConfigItem
public 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).

metricsEnabled

@ConfigItem(name="metrics.enabled")
public boolean metricsEnabled

Whether metrics are published if a metrics extension is enabled.

Constructor Detail

HibernateOrmConfig

public HibernateOrmConfig()

Method Detail

isAnyNonPersistenceXmlPropertySet

public boolean isAnyNonPersistenceXmlPropertySet()

getAllPersistenceUnitConfigsAsMap

public Map<String,HibernateOrmConfigPersistenceUnit> getAllPersistenceUnitConfigsAsMap()