io.quarkus.hibernate.orm.deployment

Class HibernateOrmConfigPersistenceUnit

java.lang.Object

io.quarkus.hibernate.orm.deployment.HibernateOrmConfigPersistenceUnit

public class HibernateOrmConfigPersistenceUnit
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCache
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCacheExpiration
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCacheMemory
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDialect
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitFetch
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitJdbc
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitLog
static class	HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery

Field Summary

Fields

Modifier and Type	Field and Description
int	batchFetchSize Deprecated. fetch should be used to configure fetching properties.
Map<String,HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCache>	cache Caching configuration
HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase	database Database related configuration.
Optional<String>	datasource The name of the datasource which this persistence unit uses.
HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDialect	dialect Dialect related configuration.
HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitFetch	fetch Fetching logic configuration.
Optional<String>	implicitNamingStrategy Pluggable strategy for applying implicit naming rules when an explicit name is not given.
HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitJdbc	jdbc JDBC related configuration.
OptionalInt	maxFetchDepth Deprecated. fetch should be used to configure fetching properties.
Optional<String>	multitenant Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA).
Optional<String>	multitenantSchemaDatasource Defines the name of the datasource to use in case of SCHEMA approach.
Optional<Set<String>>	packages The packages in which the entities affected to this persistence unit are located.
Optional<String>	physicalNamingStrategy Pluggable strategy contract for applying physical naming rules for database object names.
HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery	query Query related configuration.
boolean	secondLevelCachingEnabled The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you.
Optional<String>	sqlLoadScript Name of the file containing the SQL statements to execute when Hibernate ORM starts.

Constructor Summary

Constructors

Constructor and Description
HibernateOrmConfigPersistenceUnit()

Method Summary

Modifier and Type	Method and Description
boolean	isAnyPropertySet()

Methods inherited from class java.lang.Object

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

Field Detail

datasource

public Optional<String> datasource

The name of the datasource which this persistence unit uses.

If undefined, it will use the default datasource.

packages

public Optional<Set<String>> packages

The packages in which the entities affected to this persistence unit are located.

dialect

@ConfigItem
 @ConfigDocSection
public HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDialect dialect

Dialect related configuration.

sqlLoadScript

@ConfigItem(defaultValueDocumentation="import.sql in DEV, TEST ; no-file otherwise")
public Optional<String> sqlLoadScript

Name of the file containing the SQL statements to execute when Hibernate ORM starts. Its default value differs depending on the Quarkus launch mode: * In dev and test modes, it defaults to `import.sql`. Simply add an `import.sql` file in the root of your resources directory and it will be picked up without having to set this property. Pass `no-file` to force Hibernate ORM to ignore the SQL import file. * In production mode, it defaults to `no-file`. It means Hibernate ORM won't try to execute any SQL import file by default. Pass an explicit value to force Hibernate ORM to execute the SQL import file. If you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus https://quarkus.io/guides/config#configuration-profiles[configuration profiles facility]. [source,property] .application.properties ---- %dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql %test.quarkus.hibernate-orm.sql-load-script = import-test.sql %prod.quarkus.hibernate-orm.sql-load-script = no-file ---- [NOTE] ==== Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines. Each SQL statement must be terminated by a semicolon. ====

batchFetchSize

@ConfigItem(defaultValue="-1")
 @Deprecated
public int batchFetchSize

Deprecated. fetch should be used to configure fetching properties.

The size of the batches used when loading entities and collections. `-1` means batch loading is disabled. This is the default.

maxFetchDepth

@ConfigItem
 @Deprecated
public OptionalInt maxFetchDepth

Deprecated. fetch should be used to configure fetching properties.

The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). A `0` disables default outer join fetching.

physicalNamingStrategy

@ConfigItem
public Optional<String> physicalNamingStrategy

Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation

implicitNamingStrategy

@ConfigItem
public Optional<String> implicitNamingStrategy

Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation

query

@ConfigItem
 @ConfigDocSection
public HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitQuery query

Query related configuration.

database

@ConfigItem
 @ConfigDocSection
public HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase database

Database related configuration.

jdbc

@ConfigItem
 @ConfigDocSection
public HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitJdbc jdbc

JDBC related configuration.

fetch

@ConfigItem
 @ConfigDocSection
public HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitFetch fetch

Fetching logic configuration.

cache

@ConfigDocSection
public Map<String,HibernateOrmConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitCache> cache

Caching configuration

secondLevelCachingEnabled

@ConfigItem(defaultValue="true")
public boolean secondLevelCachingEnabled

The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you.

Just cherry-pick which entities should be using the cache.

Set this to false to disable all 2nd level caches.

multitenant

@ConfigItem
public Optional<String> multitenant

Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the https://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/MultiTenancyStrategy.html[Hibernate ORM JavaDoc]. The type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy).

multitenantSchemaDatasource

@ConfigItem
public Optional<String> multitenantSchemaDatasource

Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set.

Constructor Detail

HibernateOrmConfigPersistenceUnit

public HibernateOrmConfigPersistenceUnit()

Method Detail

isAnyPropertySet

public boolean isAnyPropertySet()