public Interface MappingSettings

Specifies the order in which metadata sources should be processed, is a delimited list of values defined by MetadataSourceType.

Used to specify the org.hibernate.boot.model.relational.ColumnOrderingStrategy class to use. The following shortcut names are defined for this setting:

• "default" is an abbreviations for org.hibernate.boot.model.relational.ColumnOrderingStrategyStandard
• "legacy" is an abbreviation for org.hibernate.boot.model.relational.ColumnOrderingStrategyLegacy

Since

6.2

See Also

org.hibernate.boot.MetadataBuilder#applyColumnOrderingStrategy

Enable instantiation of composite/embedded objects when all attribute values are null. The default (and historical) behavior is that a null reference will be used to represent the composite value when all of its attributes are null.

A default database catalog name to use for unqualified database object (table, sequence, ...) names

See Also

org.hibernate.boot.MetadataBuilder#applyImplicitCatalogName

Specifies the CollectionClassification to use for a plural attribute typed as java.util.List with no explicit list index details (OrderColumn, ListIndexBase, etc.).

Accepts any of:

• an instance of CollectionClassification
• the (case insensitive) name of a CollectionClassification (list e.g.)
• a Class representing either java.util.List or java.util.Collection

Since

6.0

See Also

org.hibernate.annotations.Bag

A default database schema (owner) name to use for unqualified database object (table, sequence, ...) names

See Also

org.hibernate.boot.MetadataBuilder#applyImplicitSchemaName

See Also

org.hibernate.boot.MetadataBuilder#enableImplicitForcingOfDiscriminatorsInSelect

When enabled, all database identifiers are quoted.

Corollary to the JPA <delimited-identifiers/> element within the orm.xml <persistence-unit-defaults/> element, but offered as a global flag.

Controls whether column-definitions (Column#columnDefinition, JoinColumn#columnDefinition, etc.) should be auto-quoted as part of global quoting.

When global quoting is enabled, JPA states that column-definitions are subject to quoting. However, this can lead to problems with definitions such as @Column(..., columnDefinition="INTEGER DEFAULT 20").

An implicit naming strategy for database structures (tables, sequences) related to identifier generators.

Resolution uses the org.hibernate.boot.registry.selector.spi.StrategySelector service and accepts any of the forms discussed on StrategySelector#resolveDefaultableStrategy(Class, Object, java.util.concurrent.Callable).

The recognized short names being:

• single
• legacy
• standard

Controls whether Hibernate should ignore explicit discriminator metadata with joined inheritance.

Hibernate does not need a discriminator with joined inheritance. Historically it simply ignored discriminator metadata. When enabled (true), any discriminator metadata (DiscriminatorColumn, e.g.) is ignored allowing for backwards compatibility.

See Also

org.hibernate.boot.MetadataBuilder#enableExplicitDiscriminatorsForJoinedSubclassSupport, IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

Controls whether Hibernate should infer a discriminator for entity hierarchies defined with joined inheritance.

Hibernate does not need a discriminator with joined inheritance. Therefore, its legacy behavior is to not infer a discriminator. However, some JPA providers do require discriminators with joined inheritance, so in the interest of portability this option has been added to Hibernate. When enabled (true), Hibernate will treat the absence of discriminator metadata as an indication to use the JPA defined defaults for discriminators.

See Also

org.hibernate.boot.MetadataBuilder#enableImplicitDiscriminatorsForJoinedSubclassSupport, IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

Used to specify the org.hibernate.boot.model.naming.ImplicitNamingStrategy class to use. The following shortcut names are defined for this setting:

• "default" and "jpa" are an abbreviations for org.hibernate.boot.model.naming.ImplicitNamingStrategyJpaCompliantImpl
• "legacy-jpa" is an abbreviation for org.hibernate.boot.model.naming.ImplicitNamingStrategyLegacyJpaImpl
• "legacy-hbm" is an abbreviation for org.hibernate.boot.model.naming.ImplicitNamingStrategyLegacyHbmImpl
• "component-path" is an abbreviation for org.hibernate.boot.model.naming.ImplicitNamingStrategyComponentPathImpl

Since

5.0

See Also

org.hibernate.boot.MetadataBuilder#applyImplicitNamingStrategy

Setting that indicates whether to build the JPA types, either:

• enabled - Do the build
• disabled - Do not do the build
• ignoreUnsupported - Do the build, but ignore any non-JPA features that would otherwise result in a failure.

Specifies a org.hibernate.type.format.FormatMapper used for JSON serialization and deserialization, either:

• an instance of FormatMapper,
• a Class representing a class that implements FormatMapper,
• the name of a class that implements FormatMapper, or
• one of the shorthand constants jackson or jsonb.

By default, the first of the possible providers that is available at runtime is used, according to the listing order.

Specifies whether to automatically quote any names that are deemed keywords on the underlying database.

Since

5.0

Specifies the org.hibernate.boot.model.naming.PhysicalNamingStrategy to use.

Since

5.0

See Also

org.hibernate.boot.MetadataBuilder#applyPhysicalNamingStrategy

Specifies the preferred JDBC type for storing boolean values.

Can be overridden locally using org.hibernate.annotations.JdbcType, org.hibernate.annotations.JdbcTypeCode, and friends.

Can also specify the name of the org.hibernate.type.SqlTypes constant field, for example, hibernate.type.preferred_boolean_jdbc_type=BIT.

The preferred JDBC type to use for storing java.time.Duration values.

Can be overridden locally using org.hibernate.annotations.JdbcType, org.hibernate.annotations.JdbcTypeCode, and friends.

Can also specify the name of the org.hibernate.type.SqlTypes constant field, for example, hibernate.type.preferred_duration_jdbc_type=INTERVAL_SECOND.

Specifies the preferred JDBC type for storing java.time.Instant values.

Can be overridden locally using org.hibernate.annotations.JdbcType, org.hibernate.annotations.JdbcTypeCode, and friends.

Can also specify the name of the org.hibernate.type.SqlTypes constant field, for example, hibernate.type.preferred_instant_jdbc_type=TIMESTAMP.

When a generator specifies an increment-size and an optimizer was not explicitly specified, which of the "pooled" optimizers should be preferred? Can specify an optimizer short name or the name of a class which implements org.hibernate.id.enhanced.Optimizer.

The preferred JDBC type to use for storing java.util.UUID values.

Can be overridden locally using org.hibernate.annotations.JdbcType, org.hibernate.annotations.JdbcTypeCode, and friends.

Can also specify the name of the org.hibernate.type.SqlTypes constant field, for example, hibernate.type.preferred_uuid_jdbc_type=CHAR.

This setting defines the org.hibernate.id.SequenceMismatchStrategy used when Hibernate detects a mismatch between a sequence configuration in an entity mapping and its database sequence object counterpart.

Possible values are org.hibernate.id.SequenceMismatchStrategy#EXCEPTION, org.hibernate.id.SequenceMismatchStrategy#LOG, org.hibernate.id.SequenceMismatchStrategy#FIX and org.hibernate.id.SequenceMismatchStrategy#NONE.

Since

5.4

Setting that controls whether we seek out JPA "static metamodel" classes and populate them, either:

• enabled - Do the population
• disabled - Do not do the population
• skipUnsupported - Do the population, but ignore any non-JPA features that would otherwise result in the population failing.

Determines if the identifier value stored in the database table backing a table generator is the last value returned by the identifier generator, or the next value to be returned.

Since

5.3

Specifies the default strategy for storage of the timezone information for the zoned datetime types java.time.OffsetDateTime and java.time.ZonedDateTime. The possible options for this setting are enumerated by org.hibernate.annotations.TimeZoneStorageType.

Since

6.0

See Also

org.hibernate.annotations.TimeZoneStorageType, org.hibernate.annotations.TimeZoneStorage

Enables processing hbm.xml mappings by transforming them to mapping.xml and using that processor.

Since

6.1

How features in a hbm.xml file which are not supported for transformation should be handled. Valid values are defined by UnsupportedFeatureHandling

Since

6.1

The @Where annotation specifies a restriction on the table rows which are visible as entity class instances or collection elements.

This setting controls whether the restriction applied to an entity should be applied to association fetches (for one-to-one, many-to-one, one-to-many, and many-to-many associations) which target the entity.

By default, Hibernate maps character data represented by Strings and java.sql.Clobs to the JDBC types java.sql.Types#VARCHAR and java.sql.Types#CLOB. This setting, when enabled, turns on the use of explicit nationalized character support for mappings involving character data, specifying that the JDBC types java.sql.Types#NVARCHAR and java.sql.Types#NCLOB should be used instead.

This setting is relevant for use with databases with explicit nationalization support, and it is not needed for databases whose native varchar and clob types support Unicode data. (If you're not sure how your database handles Unicode, check out the implementation of Dialect#getNationalizationSupport() for its SQL dialect.)

Enabling this setting has two effects:

1. when interacting with JDBC, Hibernate uses operations like java.sql.PreparedStatement#setNString(int, String) java.sql.PreparedStatement#setNClob(int, java.sql.NClob) to pass character data, and
2. when generating DDL, the schema export tool uses nchar, nvarchar, or nclob as the generated column type when no column type is explicitly specified using jakarta.persistence.Column#columnDefinition().

See Also

org.hibernate.boot.MetadataBuilder#enableGlobalNationalizedCharacterDataSupport(boolean), Dialect#getNationalizationSupport, Nationalized

Whether XML should be validated against their schema as Hibernate reads them.

Since

6.1

Configurable control over how to handle Byte[] and Character[] types encountered in the application domain model. Allowable semantics are defined by WrapperArrayHandling. Accepted values include:

1. WrapperArrayHandling instance
2. case-insensitive name of a WrapperArrayHandling instance (e.g. allow)

Specifies a org.hibernate.type.format.FormatMapper used for XML serialization and deserialization, either:

• an instance of FormatMapper,
• a Class representing a class that implements FormatMapper,
• the name of a class that implements FormatMapper, or
• one of the shorthand constants jackson or jaxb.

By default, the first of the possible providers that is available at runtime is used, according to the listing order.

Whether XML mappings should be processed.

Since

5.4.1