Package ca.uhn.fhir.jpa.migrate

Class SchemaMigrator

java.lang.Object

ca.uhn.fhir.jpa.migrate.SchemaMigrator

public class SchemaMigrator
extends Object

The SchemaMigrator class is responsible for managing and executing database schema migrations during standard bootup. It provides methods to validate the schema version and migrate the schema if necessary. This supports all the configuation needed to run via the CLI or via a bootup migrator. Specifically 1. Dry Run 2. Enable Heavyweight Tasks 3. Task Skipping

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HAPI_FHIR_MIGRATION_TABLENAME

Constructor Summary

Constructors

Constructor	Description
SchemaMigrator(String theSchemaName, String theMigrationTableName, DataSource theDataSource, boolean theEnableHeavyweighTtasks, String theMigrationTasksToSkip, boolean theDryRun, Properties jpaProperties, MigrationTaskList theMigrationTasks, HapiMigrationStorageSvc theHapiMigrationStorageSvc)	Constructor
SchemaMigrator(String theSchemaName, String theMigrationTableName, DataSource theDataSource, Properties jpaProperties, MigrationTaskList theMigrationTasks, HapiMigrationStorageSvc theHapiMigrationStorageSvc)	Temporary Dummy Constructor to remove once CDR side merges.

Method Summary

Modifier and Type	Method	Description
boolean	createMigrationTableIfRequired()
MigrationResult	migrate()
void	setCallbacks(List<IHapiMigrationCallback> theCallbacks)
void	setDriverType(DriverTypeEnum theDriverType)
void	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HAPI_FHIR_MIGRATION_TABLENAME

public static final String HAPI_FHIR_MIGRATION_TABLENAME

See Also:

• Constant Field Values

Constructor Details

SchemaMigrator

public SchemaMigrator(String theSchemaName,
 String theMigrationTableName,
 DataSource theDataSource,
 boolean theEnableHeavyweighTtasks,
 String theMigrationTasksToSkip,
 boolean theDryRun,
 Properties jpaProperties,
 MigrationTaskList theMigrationTasks,
 HapiMigrationStorageSvc theHapiMigrationStorageSvc)

Constructor

SchemaMigrator

public SchemaMigrator(String theSchemaName,
 String theMigrationTableName,
 DataSource theDataSource,
 Properties jpaProperties,
 MigrationTaskList theMigrationTasks,
 HapiMigrationStorageSvc theHapiMigrationStorageSvc)

Temporary Dummy Constructor to remove once CDR side merges.

Method Details

validate

public void validate()

migrate

public MigrationResult migrate()

setDriverType

public void setDriverType(DriverTypeEnum theDriverType)

setCallbacks

public void setCallbacks(List<IHapiMigrationCallback> theCallbacks)

createMigrationTableIfRequired

public boolean createMigrationTableIfRequired()