Package org.hibernate.tool.schema.spi

An SPI for tooling related to DDL generation, export, migration, and validation. Schema management actions may be requested programmatically by calling SchemaManagementToolCoordinator.process(org.hibernate.boot.Metadata, org.hibernate.service.ServiceRegistry, java.util.Map<java.lang.String, java.lang.Object>, org.hibernate.tool.schema.spi.DelayedDropRegistry).

See Also:

SchemaManagementTool, SchemaManagementToolCoordinator

Interface Summary

Interface	Description
Cleaner	An object that produces the SQL required to truncate the tables in a schema.
ContributableMatcher	Matcher for whether tables and sequences should be included based on its Contributable.getContributor()
DelayedDropAction	Memento representing the dropping of a schema as part of create-drop hbm2ddl.auto handling.
DelayedDropRegistry	Callback to allow the built DelayedDropAction, if indicated, to be registered back with the SessionFactory (or the thing that will manage its later execution).
ExceptionHandler	Contract for how CommandAcceptanceException errors should be handled (logged, ignored, etc).
ExecutionOptions	Parameter object representing options for schema management tool execution
Exporter<T extends Exportable>	Defines a contract for exporting of database objects (tables, sequences, etc) for use in SQL CREATE and DROP scripts.
ExtractionTool	Encapsulates the functionality for extracting database metadata used by SchemaManagementTool.
JpaTargetAndSourceDescriptor	JPA ties the notion of SourceDescriptor and TargetDescriptor together: meaning that a SourceDescriptor is specific to a given TargetDescriptor.
SchemaCreator	Service delegate for handling schema creation.
SchemaDropper	Service delegate for handling schema dropping.
SchemaFilter	Defines a filter for Hibernate's schema tooling.
SchemaFilterProvider	Used to specify the SchemaFilters to be used by create, drop, migrate and validate operations on the database schema.
SchemaManagementTool	Contract for schema management tool integration.
SchemaMigrator	Service delegate for handling schema migration.
SchemaTruncator	Service delegate for handling schema truncation.
SchemaValidator	Service delegate for handling schema validations
ScriptSourceInput	Contract for hiding the differences between a passed Reader, File or URL in terms of how we read input scripts.
ScriptTargetOutput	Contract for hiding the differences between a passed Writer, File or URL in terms of how we write output scripts.
SourceDescriptor	Describes a source for schema create, drop and migrate actions.
SqlScriptCommandExtractor	Contract for extracting statements from source/import/init scripts.
TargetDescriptor	Describes the target(s) of schema create, drop and migrate actions.

Class Summary

Class	Description
DelayedDropRegistryNotAvailableImpl	Implementation of DelayedDropRegistry for cases when the delayed-drop portion of "create-drop" is not valid.
SchemaManagementToolCoordinator	Responsible for coordinating SchemaManagementTool execution whether from "hibernate.hbm2ddl.auto", JPA-standard "jakarta.persistence.schema-generation.database.action", or SchemaManager.
SchemaManagementToolCoordinator.ActionGrouping	For JPA-style schema-gen, database and script target handing are configured individually - this tuple allows interpreting the action for both targets simultaneously

Exception Summary

Exception	Description
CommandAcceptanceException	Indicates a problem accepting/executing a schema management command.
SchemaManagementException	Indicates a problem in performing schema management.
SqlScriptException	Indicates a problem