Field Summary

Field Details

• DEFAULT_CATALOG

  static final String DEFAULT_CATALOG

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

  See Also:

  • MetadataBuilder.applyImplicitCatalogName(java.lang.String)
  • Constant Field Values

• DEFAULT_SCHEMA

  static final String DEFAULT_SCHEMA

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

  See Also:

  • MetadataBuilder.applyImplicitSchemaName(java.lang.String)
  • Constant Field Values

• JPA_METAMODEL_POPULATION

  static final String JPA_METAMODEL_POPULATION

  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.

  See Also:

  • Constant Field Values

  Default Value:

  ignoreUnsupported

• STATIC_METAMODEL_POPULATION

  static final String STATIC_METAMODEL_POPULATION

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

  • enabled — do populate the static metamodel,
  • disabled — do not populate the static metamodel, or
  • skipUnsupported — do populate the static metamodel, but ignore any non-JPA features that would otherwise result in the process failing.

  See Also:

  • Constant Field Values

  Default Value:

  skipUnsupported

• GLOBALLY_QUOTED_IDENTIFIERS

  static final String GLOBALLY_QUOTED_IDENTIFIERS

  When enabled, all database identifiers are quoted.

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

  See Also:

  • Constant Field Values

  Default Value:

  false

• GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS

  static final String GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS

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

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

  See Also:

  • Constant Field Values

  Default Value:

  false to avoid the potential problems quoting non-trivial column-definitions.

• KEYWORD_AUTO_QUOTING_ENABLED

  static final String KEYWORD_AUTO_QUOTING_ENABLED

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

  Since:

  5.0

  See Also:

  • Constant Field Values

  Default Value:

  false - auto-quoting of SQL keywords is disabled by default.

• PREFERRED_POOLED_OPTIMIZER

  static final String PREFERRED_POOLED_OPTIMIZER

  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 implementsOptimizer.

  See Also:

  • Constant Field Values

  Default Value:

  StandardOptimizerDescriptor.POOLED

• TABLE_GENERATOR_STORE_LAST_USED

  static final String TABLE_GENERATOR_STORE_LAST_USED

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

  Since:

  5.3

  See Also:

  • Constant Field Values

  Default Value:

  The value stored in the database table is the last generated value

• SEQUENCE_INCREMENT_SIZE_MISMATCH_STRATEGY

  static final String SEQUENCE_INCREMENT_SIZE_MISMATCH_STRATEGY

  This setting defines theSequenceMismatchStrategy used when Hibernate detects a mismatch between a sequence configuration in an entity mapping and its database sequence object counterpart.

  Possible values areSequenceMismatchStrategy.EXCEPTION,SequenceMismatchStrategy.LOG,SequenceMismatchStrategy.FIX andSequenceMismatchStrategy.NONE.

  Since:

  5.4

  See Also:

  • Constant Field Values

  Default Value:

  SequenceMismatchStrategy.EXCEPTION, meaning that an exception is thrown when such a conflict is detected.

• PREFERRED_BOOLEAN_JDBC_TYPE

  @Incubatingstatic final String PREFERRED_BOOLEAN_JDBC_TYPE

  Specifies the preferred JDBC type for storing boolean values.

  Can be overridden locally usingJdbcType,JdbcTypeCode, and friends.

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

  Since:

  6.0

  See Also:

  • Constant Field Values

  Default Value:

  dialect-specific type code

• PREFERRED_UUID_JDBC_TYPE

  @Incubatingstatic final String PREFERRED_UUID_JDBC_TYPE

  The preferred JDBC type to use for storingUUID values.

  Can be overridden locally usingJdbcType,JdbcTypeCode, and friends.

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

  Since:

  6.0

  See Also:

  • Constant Field Values

  Default Value:

  SqlTypes.UUID.

• PREFERRED_DURATION_JDBC_TYPE

  @Incubatingstatic final String PREFERRED_DURATION_JDBC_TYPE

  The preferred JDBC type to use for storingDuration values.

  Can be overridden locally usingJdbcType,JdbcTypeCode, and friends.

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

  Since:

  6.0

  See Also:

  • Constant Field Values

  Default Value:

  SqlTypes.NUMERIC

• PREFERRED_INSTANT_JDBC_TYPE

  @Incubatingstatic final String PREFERRED_INSTANT_JDBC_TYPE

  Specifies the preferred JDBC type for storingInstant values.

  Can be overridden locally usingJdbcType,JdbcTypeCode, and friends.

  Can also specify the name of theSqlTypes constant field, for example,hibernate.type.preferred_instant_jdbc_type=TIMESTAMP orhibernate.type.preferred_instant_jdbc_type=INSTANT.

  Since:

  6.0

  See Also:

  • Constant Field Values

  Default Value:

  SqlTypes.TIMESTAMP_UTC.

• JAVA_TIME_USE_DIRECT_JDBC

  @Incubatingstatic final String JAVA_TIME_USE_DIRECT_JDBC

  Indicates whether to useJava Time references at the JDBC boundary for binding and extracting temporal values to/from the database using the support added in JDBC 4.2 viaPreparedStatement.setObject(int, Object, int) andResultSet.getObject(int, Class).

  Used to set the value across the entire system as opposed to scattered, individualJdbcTypeCode andJdbcType naming specificJavaTimeJdbcType implementations.

  Since:

  6.5

  See Also:

  • Constant Field Values

  Implementation Note:

  JDBC 4.2 does not define support forInstant, soInstant is not included in this. Some drivers do implement support for this even though not explicitly part of the JDBC specification. To use direct binding and extracting ofInstant references, usehibernate.type.preferred_instant_jdbc_type=INSTANT. SeePREFERRED_INSTANT_JDBC_TYPE,SqlTypes.INSTANT andInstantJdbcType.

  Default Value:

  false

• PREFER_NATIVE_ENUM_TYPES

  @Incubatingstatic final String PREFER_NATIVE_ENUM_TYPES

  Indicates that named SQLenum types should be used by default instead ofvarchar on databases which support named enum types.

  A named enum type is declared in DDL usingcreate type ... as enum orcreate type ... as domain.

  This configuration property is used to specify a global preference, as an alternative to the use of@JdbcTypeCode(SqlTypes.NAMED_ENUM) at the field or property level.

  Since:

  6.5

  See Also:

  • SqlTypes.NAMED_ENUM
  • PostgreSQLEnumJdbcType
  • OracleEnumJdbcType
  • Constant Field Values

  Default Value:

  false

• PREFERRED_ARRAY_JDBC_TYPE

  @Incubatingstatic final String PREFERRED_ARRAY_JDBC_TYPE

  Specifies the preferred JDBC type for storing plural i.e. array/collection values.

  Can be overridden locally usingJdbcType,JdbcTypeCode, and friends.

  Can also specify the name of theSqlTypes constant field, for example,hibernate.type.preferred_array_jdbc_type=ARRAY orhibernate.type.preferred_array_jdbc_type=TABLE.

  Since:

  6.6

  See Also:

  • SqlTypes.ARRAY
  • SqlTypes.TABLE
  • Constant Field Values

  Default Value:

  Dialect.getPreferredSqlTypeCodeForArray().

• JSON_FORMAT_MAPPER

  @Incubatingstatic final String JSON_FORMAT_MAPPER

  Specifies aFormatMapper used for JSON serialization and deserialization, either:

  • an instance ofFormatMapper,
  • aClass representing a class that implementsFormatMapper,
  • the name of a class that implementsFormatMapper, or
  • one of the shorthand constantsjackson orjsonb.

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

  Since:

  6.0

  See Also:

  • SessionFactoryBuilder.applyJsonFormatMapper(FormatMapper)
  • Constant Field Values

• XML_FORMAT_MAPPER

  @Incubatingstatic final String XML_FORMAT_MAPPER

  Specifies aFormatMapper used for XML serialization and deserialization, either:

  • an instance ofFormatMapper,
  • aClass representing a class that implementsFormatMapper,
  • the name of a class that implementsFormatMapper, or
  • one of the shorthand constantsjackson orjaxb.

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

  Since:

  6.0.1

  See Also:

  • SessionFactoryBuilder.applyXmlFormatMapper(FormatMapper)
  • Constant Field Values

• XML_FORMAT_MAPPER_LEGACY_FORMAT

  @Incubatingstatic final String XML_FORMAT_MAPPER_LEGACY_FORMAT

  Specifies whether to use the legacy provider specific and non-portable XML format for collections and byte arrays for XML serialization/deserialization.

  false by default. This property only exists for backwards compatibility.

  Since:

  7.0

  See Also:

  • Constant Field Values

• WRAPPER_ARRAY_HANDLING

  @Incubatingstatic final String WRAPPER_ARRAY_HANDLING

  Configurable control over how to handleByte[] andCharacter[] types encountered in the application domain model. Allowable semantics are defined byWrapperArrayHandling. Accepted values include:

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

  Since:

  6.2

  See Also:

  • Constant Field Values

• TIMEZONE_DEFAULT_STORAGE

  static final String TIMEZONE_DEFAULT_STORAGE

  Specifies the default strategy for storage of the timezone information for the zoned datetime typesOffsetDateTime andZonedDateTime. The possible options for this setting are enumerated byTimeZoneStorageType.

  Since:

  6.0

  See Also:

  • TimeZoneStorageType
  • TimeZoneStorage
  • Constant Field Values

  API Note:

  For backward compatibility with older versions of Hibernate, set this property toNORMALIZE.

  Default Value:

  DEFAULT, which guarantees that theinstant represented by a zoned datetime type is preserved by a round trip to the database. It doesnot guarantee that the time zone or offset is preserved.

• IMPLICIT_NAMING_STRATEGY

  static final String IMPLICIT_NAMING_STRATEGY

  Used to specify theImplicitNamingStrategy class to use. The following shortcut names are defined for this setting:

  • "default" and"jpa" are an abbreviations forImplicitNamingStrategyJpaCompliantImpl
  • "legacy-jpa" is an abbreviation forImplicitNamingStrategyLegacyJpaImpl
  • "legacy-hbm" is an abbreviation forImplicitNamingStrategyLegacyHbmImpl
  • "component-path" is an abbreviation forImplicitNamingStrategyComponentPathImpl

  Since:

  5.0

  See Also:

  • MetadataBuilder.applyImplicitNamingStrategy(org.hibernate.boot.model.naming.ImplicitNamingStrategy)
  • Constant Field Values

  Default Value:

  "default"

• PHYSICAL_NAMING_STRATEGY

  static final String PHYSICAL_NAMING_STRATEGY

  Specifies thePhysicalNamingStrategy to use.

  Since:

  5.0

  See Also:

  • MetadataBuilder.applyPhysicalNamingStrategy(org.hibernate.boot.model.naming.PhysicalNamingStrategy)
  • Constant Field Values

  Default Value:

  PhysicalNamingStrategyStandardImpl, in which case physical names are taken to be identical to logical names.

• ID_DB_STRUCTURE_NAMING_STRATEGY

  @Incubatingstatic final String ID_DB_STRUCTURE_NAMING_STRATEGY

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

  Resolution uses theStrategySelector service and accepts any of the forms discussed onStrategySelector.resolveDefaultableStrategy(Class, Object, java.util.concurrent.Callable).

  The recognized short names being:

  • "single"
  • "legacy"
  • "standard"

  Since:

  6

  See Also:

  • ImplicitDatabaseObjectNamingStrategy
  • Constant Field Values

  Default Value:

  StandardNamingStrategy

• COLUMN_ORDERING_STRATEGY

  static final String COLUMN_ORDERING_STRATEGY

  Used to specify theColumnOrderingStrategy class to use. The following shortcut names are defined for this setting:

  • "default" is an abbreviations forColumnOrderingStrategyStandard
  • "legacy" is an abbreviation forColumnOrderingStrategyLegacy

  Since:

  6.2

  See Also:

  • MetadataBuilder.applyColumnOrderingStrategy(org.hibernate.boot.model.relational.ColumnOrderingStrategy)
  • Constant Field Values

  Default Value:

  "default"

• XML_MAPPING_ENABLED

  static final String XML_MAPPING_ENABLED

  Whether XML mappings should be processed.

  Since:

  5.4.1

  See Also:

  • Constant Field Values

  API Note:

  This is a performance optimization appropriate when mapping details are defined exclusively using annotations.

  Default Value:

  true - XML mappings are processed

• DEFAULT_LIST_SEMANTICS

  static final String DEFAULT_LIST_SEMANTICS

  Specifies theCollectionClassification to use for a plural attribute typed asList with no explicit list index details (OrderColumn,ListIndexBase, etc.).

  Accepts any of:

  • an instance ofCollectionClassification
  • the (case insensitive) name of aCollectionClassification (list e.g.)
  • aClass representing eitherList orCollection

  Since:

  6.0

  See Also:

  • Bag
  • Constant Field Values

  Default Value:

  CollectionClassification.BAG

• VALIDATE_XML

  static final String VALIDATE_XML

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

  Since:

  6.1

  See Also:

  • Constant Field Values

  Default Value:

  true

• TRANSFORM_HBM_XML

  static final String TRANSFORM_HBM_XML

  Enables processinghbm.xml mappings by transforming them tomapping.xml and using that processor.

  Since:

  6.1

  See Also:

  • Constant Field Values

  Default Value:

  false (opt-in).

• TRANSFORM_HBM_XML_FEATURE_HANDLING

  static final String TRANSFORM_HBM_XML_FEATURE_HANDLING

  How features in ahbm.xml file which are not supported for transformation should be handled. Valid values are defined byUnsupportedFeatureHandling

  Since:

  6.1

  See Also:

  • Constant Field Values

  Default Value:

  UnsupportedFeatureHandling.ERROR

• FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT

  static final String FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT

  Specifies that Hibernate should always restrict by discriminator values in SQLselect statements, even when querying the root entity of an entity inheritance hierarchy.

  By default, Hibernate only restricts by discriminator values when querying a subtype, or when the root entity is explicitly annotatedDiscriminatorOptions(force=true).

  See Also:

  • MetadataBuilder.enableImplicitForcingOfDiscriminatorsInSelect(boolean)
  • DiscriminatorOptions.force()
  • Constant Field Values

  Default Value:

  false

• IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

  static final String 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:

  • MetadataBuilder.enableImplicitDiscriminatorsForJoinedSubclassSupport(boolean)
  • IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
  • Constant Field Values

  Implementation Note:

  See Hibernate Jira issue HHH-6911 for additional background info.

  Default Value:

  false

• IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

  static final String IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

  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:

  • MetadataBuilder.enableExplicitDiscriminatorsForJoinedSubclassSupport(boolean)
  • IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
  • Constant Field Values

  Implementation Note:

  See Hibernate Jira issue HHH-6911 for additional background info.

  Default Value:

  false

• USE_NATIONALIZED_CHARACTER_DATA

  static final String USE_NATIONALIZED_CHARACTER_DATA

  By default, Hibernate maps character data represented byStrings andClobs to the JDBC typesTypes.VARCHAR andTypes.CLOB. This setting, when enabled, turns on the use of explicit nationalized character support for mappings involving character data, specifying that the JDBC typesTypes.NVARCHAR andTypes.NCLOB should be used instead.

  This setting is relevant for use with databases withexplicit nationalization support, and it is not needed for databases whose nativevarchar andclob types support Unicode data. (If you're not sure how your database handles Unicode, check out the implementation ofDialect.getNationalizationSupport() for its SQL dialect.)

  Enabling this setting has two effects:

  1. when interacting with JDBC, Hibernate uses operations likePreparedStatement.setNString(int, String)PreparedStatement.setNClob(int, java.sql.NClob) to pass character data, and
  2. when generating DDL, the schema export tool usesnchar,nvarchar, ornclob as the generated column type when no column type is explicitly specified usingColumn.columnDefinition().

  See Also:

  • MetadataBuilder.enableGlobalNationalizedCharacterDataSupport(boolean)
  • Dialect.getNationalizationSupport()
  • Nationalized
  • Constant Field Values

  API Note:

  This is a global setting applying to all mappings associated with a givenSessionFactory. TheNationalized annotation may be used to selectively enable nationalized character support for specific columns.

  Default Value:

  false (disabled)