org.nuiton.topia.persistence

Interface TopiaMigrationService

All Superinterfaces:

TopiaService

All Known Implementing Classes:

HibernateTopiaMigrationService

public interface TopiaMigrationService
extends TopiaService

When TopiaApplicationContext.initSchema() is called, topia will look for a topia-service that is able to migrate the database. Actually, it will look for any service implementing this contract.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
String	getSchemaVersion()
void	initOnCreateSchema() The schema has been created by ToPIA, the service should init the migration engine and store the schema version somewhere.
void	runSchemaMigration() The schema already exists in an unknown version, service should update the schema if necessary.

Methods inherited from interface org.nuiton.topia.persistence.TopiaService

close, initTopiaService

Method Detail

getSchemaVersion

String getSchemaVersion()
                 throws TopiaMigrationServiceException

Returns:

the schema version according to the meta-data information about the actual current state of the schema in the database.

Throws:

TopiaMigrationServiceException

initOnCreateSchema

void initOnCreateSchema()
                 throws TopiaMigrationServiceException

The schema has been created by ToPIA, the service should init the migration engine and store the schema version somewhere.

Throws:

TopiaMigrationServiceException

runSchemaMigration

void runSchemaMigration()
                 throws TopiaMigrationServiceException

The schema already exists in an unknown version, service should update the schema if necessary.

Throws:

TopiaMigrationServiceException