Top Description Interfaces Classes
[default module]

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 org.hibernate.tool.schema.spi.SchemaManagementToolCoordinator#process.
See Also
org.hibernate.tool.schema.spi.SchemaManagementTool, org.hibernate.tool.schema.spi.SchemaManagementToolCoordinator

Interface Summary

Modifier and TypeInterface and Description
public interface
Cleaner

An object that produces the SQL required to truncate the tables in a schema.

public interface
ContributableMatcher

Matcher for whether tables and sequences should be included based on its ContributableDatabaseObject#getContributor()

public interface
DelayedDropAction

Memento representing the dropping of a schema as part of create-drop hbm2ddl.auto handling.

public interface
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).

public interface
ExceptionHandler

Contract for how CommandAcceptanceException errors should be handled (logged, ignored, etc).

public interface
ExecutionOptions

Parameter object representing options for schema management tool execution

public interface
Exporter<T extends Exportable>

Defines a contract for exporting of database objects (tables, sequences, etc) for use in SQL CREATE and DROP scripts.

public interface
ExtractionTool

Encapsulates the functionality for extracting database metadata used by SchemaManagementTool.

public interface
JpaTargetAndSourceDescriptor

JPA ties the notion of SourceDescriptor and TargetDescriptor together: meaning that a SourceDescriptor is specific to a given TargetDescriptor.

public interface
SchemaCreator

Service delegate for handling schema creation.

public interface
SchemaDropper

Service delegate for handling schema dropping.

public interface
SchemaFilter

Defines a filter for Hibernate's schema tooling.

public interface
SchemaFilterProvider

Used to specify the SchemaFilters to be used by create, drop, migrate and validate operations on the database schema.

public interface
SchemaManagementTool

Contract for schema management tool integration.

public interface
SchemaMigrator

Service delegate for handling schema migration.

public interface
SchemaTruncator

Service delegate for handling schema truncation.

public interface
SchemaValidator

Service delegate for handling schema validations

public interface
ScriptSourceInput

Contract for hiding the differences between a passed Reader, File or URL in terms of how we read input scripts.

public interface
ScriptTargetOutput

Contract for hiding the differences between a passed Writer, File or URL in terms of how we write output scripts.

public interface
SourceDescriptor

Describes a source for schema create, drop and migrate actions.

public interface
SqlScriptCommandExtractor

Contract for extracting statements from source/import/init scripts.

public interface
TargetDescriptor

Describes the target(s) of schema create, drop and migrate actions.

Class Summary

Modifier and TypeClass and Description
public class
CommandAcceptanceException

Indicates a problem accepting/executing a schema management command.

public class
DelayedDropRegistryNotAvailableImpl

Implementation of DelayedDropRegistry for cases when the delayed-drop portion of "create-drop" is not valid.

public class
SchemaManagementException

Indicates a problem in performing schema management.

public class
SchemaManagementToolCoordinator

Responsible for coordinating SchemaManagementTool execution whether from hibernate.hbm2ddl.auto, JPA-standard jakarta.persistence.schema-generation.database.action, or org.hibernate.relational.SchemaManager.

public class
SqlScriptException

Indicates a problem