public Interface SchemaToolingSettings

Allows creation of global temporary tables at application startup to be disabled. By default, table creation is enabled.

Allows dropping of global temporary tables at application shutdown to be disabled. By default, table dropping is enabled.

Allows dropping of local temporary tables at transaction commit to be enabled. By default, table dropping is disabled, and the database will drop the temporary tables automatically.

Allows creation of persistent temporary tables at application startup to be disabled. By default, table creation is enabled.

Allows dropping of persistent temporary tables at application shutdown to be disabled. By default, table dropping is enabled.

If enabled, allows schema update and validation to support synonyms. Due to the possibility that this would return duplicate tables (especially in Oracle), this is disabled by default.

Specifies a comma-separated list of extra table types, in addition to the default types "TABLE" and "VIEW", to recognize as physical tables when performing schema update, creation and validation.

Since

5.0

Setting to perform org.hibernate.tool.schema.spi.SchemaManagementTool actions automatically as part of the org.hibernate.SessionFactory lifecycle. Valid options are enumerated by org.hibernate.tool.schema.Action.

Interpreted in combination with JAKARTA_HBM2DDL_DATABASE_ACTION and JAKARTA_HBM2DDL_SCRIPTS_ACTION. If no value is specified, the default is "none".

See Also

org.hibernate.tool.schema.Action

The name of the charset used by the schema generation resource.

By default, the JVM default charset is used.

Since

5.2.3

Specifies whether to automatically create also the database schema/catalog. The default is false.

Used with the jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT strategy for foreign key mapping.

Valid values are jakarta.persistence.ConstraintMode#CONSTRAINT and jakarta.persistence.ConstraintMode#NO_CONSTRAINT.

Since

5.4

Identifies the delimiter to use to separate schema management statements in script outputs.

Used to specify the org.hibernate.tool.schema.spi.SchemaFilterProvider to be used by create, drop, migrate and validate operations on the database schema. A SchemaFilterProvider provides filters that can be used to limit the scope of these operations to specific namespaces, tables and sequences. All objects are included by default.

Since

5.1

When enabled, specifies that the schema migration tool should halt on any error, terminating the bootstrap process.

Since

5.2.4

Specifies a comma-separated list of file names of scripts containing SQL DML statements that should be executed after schema export completes. The order of the scripts is significant, with the first script in the list being executed first.

The scripts are only executed if the schema is created by Hibernate, that is, if hibernate.hbm2ddl.auto is set to create or create-drop.

The default value is /import.sql.

The org.hibernate.tool.schema.spi.SqlScriptCommandExtractor implementation to use for parsing source/import files specified by JAKARTA_HBM2DDL_CREATE_SCRIPT_SOURCE, JAKARTA_HBM2DDL_DROP_SCRIPT_SOURCE or HBM2DDL_IMPORT_FILES. Either:

• an instance of org.hibernate.tool.schema.spi.SqlScriptCommandExtractor,
• a Class object representing a class that implements SqlScriptCommandExtractor, or
• the name of a class that implements SqlScriptCommandExtractor.

The correct extractor to use depends on the format of the SQL script:

• if the script has one complete SQL statement per line, use org.hibernate.tool.schema.internal.script.SingleLineSqlScriptExtractor, or
• if a script contains statements spread over multiple lines, use org.hibernate.tool.schema.internal.script.MultiLineSqlScriptExtractor.

See Also

org.hibernate.tool.schema.internal.script.SingleLineSqlScriptExtractor, org.hibernate.tool.schema.internal.script.MultiLineSqlScriptExtractor

Setting to choose the strategy used to access the JDBC Metadata.

Valid options are defined by org.hibernate.tool.schema.JdbcMetadaAccessStrategy. org.hibernate.tool.schema.JdbcMetadaAccessStrategy#GROUPED is the default.

See Also

org.hibernate.tool.schema.JdbcMetadaAccessStrategy

For cases where the jakarta.persistence.schema-generation.scripts.action value indicates that schema commands should be written to DDL script file, specifies if schema commands should be appended to the end of the file rather than written at the beginning of the file.

Values are: true for appending schema commands to the end of the file, false for writing schema commands at the beginning.

The JPA variant of HBM2DDL_CREATE_NAMESPACES used to specify whether database schemas used in the mapping model should be created on export in addition to creating the tables, sequences, etc.

The default is false, meaning to not create schemas

Specifies the CREATE script file as either a java.io.Reader configured for reading the DDL script file or a string designating a file java.net.URL for the DDL script.

Hibernate historically also accepted HBM2DDL_IMPORT_FILES for a similar purpose. This setting is now preferred.

See Also

JAKARTA_HBM2DDL_CREATE_SOURCE, HBM2DDL_IMPORT_FILES

Specifies whether schema generation commands for schema creation are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two. See org.hibernate.tool.schema.SourceType for the list of legal values.

If no value is specified, a default is inferred as follows:

• if source scripts are specified via jakarta.persistence.schema-generation.create-script-source, then "script" is assumed, or
• otherwise, "metadata" is assumed.

See Also

org.hibernate.tool.schema.SourceType

Specifies what type of schema tooling action should be performed against the database specified using either jakarta.persistence.schema-generation-connection or the configured org.hibernate.engine.jdbc.connections.spi.ConnectionProvider for the org.hibernate.SessionFactory.

Valid options are enumerated by org.hibernate.tool.schema.Action.

This setting takes precedence over hibernate.hbm2ddl.auto.

If no value is specified, the default is "none".

See Also

org.hibernate.tool.schema.Action, JdbcSettings#JAKARTA_HBM2DDL_CONNECTION, JdbcSettings#JAKARTA_JDBC_URL

Specifies the DROP script file as either a java.io.Reader configured for reading the DDL script file or a string designating a file java.net.URL for the DDL script.

See Also

JAKARTA_HBM2DDL_DROP_SOURCE

Specifies whether schema generation commands for schema dropping are to be determined based on object/relational mapping metadata, DDL scripts, or a combination of the two. See org.hibernate.tool.schema.SourceType for the list of legal values.

If no value is specified, a default is inferred as follows:

• if source scripts are specified via jakarta.persistence.schema-generation.drop-script-source, then "script" is assumed, or
• otherwise, "metadata" is assumed.

See Also

org.hibernate.tool.schema.SourceType

JPA-standard variant of HBM2DDL_IMPORT_FILES for specifying a database initialization script to be run as part of schema-export

Specifies a java.io.Reader configured for reading of the SQL load script or a string designating the java.net.URL for the SQL load script.

Specifies what type of schema tooling action should be written to script files.

Valid options are enumerated by org.hibernate.tool.schema.Action.

The script file is identified using jakarta.persistence.schema-generation.scripts.create-target.

If no value is specified, the default is "none".

See Also

org.hibernate.tool.schema.Action, JAKARTA_HBM2DDL_SCRIPTS_CREATE_TARGET, JAKARTA_HBM2DDL_SCRIPTS_DROP_TARGET

For cases where jakarta.persistence.schema-generation.scripts.action indicates that schema creation commands should be written to a script file, this setting specifies either a java.io.Writer configured for output of the DDL script or a string specifying the file URL for the DDL script.

See Also

JAKARTA_HBM2DDL_SCRIPTS_ACTION

For cases where jakarta.persistence.schema-generation.scripts.action indicates that schema drop commands should be written to a script file, this setting specifies either a java.io.Writer configured for output of the DDL script or a string specifying the file URL for the DDL script.

See Also

JAKARTA_HBM2DDL_SCRIPTS_ACTION

Specifies the org.hibernate.tool.schema.spi.SchemaManagementTool to use for performing schema management.

By default, org.hibernate.tool.schema.internal.HibernateSchemaManagementTool is used.

Since

5.0

Specifies the default storage engine for a relational databases that supports multiple storage engines. This property must be set either as an Environment variable or JVM System Property, since the org.hibernate.dialect.Dialect is instantiated before Hibernate property resolution.

Since

5.2.9

Unique columns and unique keys both use unique constraints in most dialects. The schema exporter must create these constraints, but database support for finding existing constraints is extremely inconsistent. Worse, unique constraints without explicit names are assigned names with randomly generated characters.

Therefore, select from these strategies:

• DROP_RECREATE_QUIETLY: Attempt to drop, then (re-)create each unique constraint, ignoring any exceptions thrown. This is the default.
• RECREATE_QUIETLY: Attempt to (re-)create unique constraints, ignoring exceptions thrown if the constraint already existed.
• SKIP: Do not attempt to create unique constraints on a schema update.