org.hibernate.tool.schema.spi.SchemaMigrator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core

The core O/RM functionality as provided by Hibernate

There is a newer version: 7.0.0.Alpha1

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.tool.schema.spi;

import java.util.List;

import org.hibernate.boot.Metadata;
import org.hibernate.tool.schema.extract.spi.DatabaseInformation;

/**
 * Service delegate for handling schema migration.
 *
 * @author Steve Ebersole
 */
public interface SchemaMigrator {
	/**
	 * Perform a migration to the specified targets.
	 *
	 * @param metadata The "compiled" mapping metadata.
	 * @param existingDatabase Access to the information about the existing database.
	 * @param createSchemas Should the schema(s) actually be created as well ({@code CREATE SCHEMA})?
	 * @param targets The migration targets
	 *
	 * @throws SchemaManagementException
	 */
	public void doMigration(
			Metadata metadata,
			DatabaseInformation existingDatabase,
			boolean createSchemas,
			List targets) throws SchemaManagementException;
}