Interface SchemaManager

All Superinterfaces:
SchemaManager
All Known Implementing Classes:
SchemaManagerImpl

@Incubating public interface SchemaManager extends SchemaManager
Allows programmatic schema export, schema validation, data cleanup, and schema cleanup as a convenience for writing tests.
Since:
6.2
See Also:
API Note:
This interface was added to JPA 3.2 as SchemaManager, which it now inherits, with a minor change to the naming of its operations. It is retained for backward compatibility and as a place to define additional functionality in the future.
  • Method Details

    • exportMappedObjects

      void exportMappedObjects(boolean createSchemas)
      Export database objects mapped by Hibernate entities.

      Programmatic way to run SchemaCreator.

      Parameters:
      createSchemas - if true, attempt to create schemas, otherwise, assume the schemas already exist
      API Note:
      This operation is a synonym for SchemaManager.create(boolean).
    • dropMappedObjects

      void dropMappedObjects(boolean dropSchemas)
      Drop database objects mapped by Hibernate entities, undoing the previous export.

      Programmatic way to run SchemaDropper.

      Parameters:
      dropSchemas - if true, drop schemas, otherwise, leave them be
      API Note:
      This operation is a synonym for SchemaManager.drop(boolean).
    • validateMappedObjects

      void validateMappedObjects()
      Validate that the database objects mapped by Hibernate entities have the expected definitions.

      Programmatic way to run SchemaValidator.

      API Note:
      This operation is a synonym for SchemaManager.validate().
    • truncateMappedObjects

      void truncateMappedObjects()
      Truncate the database tables mapped by Hibernate entities, and then re-import initial data from any configured load script.

      Programmatic way to run SchemaTruncator.

      API Note:
      This operation is a synonym for SchemaManager.truncate().