org.openmrs.util.databasechange

Class GenerateUuid

java.lang.Object

org.openmrs.util.databasechange.GenerateUuid

All Implemented Interfaces:

liquibase.change.custom.CustomChange, liquibase.change.custom.CustomTaskChange

public class GenerateUuid
extends java.lang.Object
implements liquibase.change.custom.CustomTaskChange

Generates UUIDs for all rows in all tables in the tableNames parameter.
If run on MySQL, it generates SQL statements using the in-built uuid() MySQL function, otherwise it uses Java's UUID class, which is less efficient.

Expects parameter: "tableNames" : whitespace delimited list of table names to add
Expects parameter: "columnName" : name of the column to change. Default: "uuid"
Expects parameter: "idExceptions" : list of id columns that don't follow the standard naming convention. Should be a pipe-separated list of key=value, where key is the name an id column would have by convention, and value is the name it actually has. In this example the id of the field_answer table is 'field_id' rather than 'field_answer_id', etc: "field_answer_id=field_id|role_id=role|privilege_id=privilege"

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log
static java.lang.Integer	TRANSACTION_BATCH_SIZE_LIMIT

Constructor Summary

Constructors

Constructor and Description
GenerateUuid()

Method Summary

Modifier and Type	Method and Description
void	execute(liquibase.database.Database database) Adds UUIDs to all rows for the specified tables.
java.lang.String	getConfirmationMessage()
void	setColumnName(java.lang.String columnName) This is called by liquibase to set the parameter "columnName" onto this change.
void	setFileOpener(liquibase.resource.ResourceAccessor fileOpener)
void	setIdExceptions(java.lang.String idExceptions) Way to specify the table id columns that don't follow the table_name.table_name_id pattern
void	setTableNames(java.lang.String tableNames) This is called by liquibase to set the parameter "tableNames" onto this change.
void	setUp() Get the values of the parameters passed in and set them to the local variables on this class.
liquibase.exception.ValidationErrors	validate(liquibase.database.Database database)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

TRANSACTION_BATCH_SIZE_LIMIT

public static final java.lang.Integer TRANSACTION_BATCH_SIZE_LIMIT

Constructor Detail

GenerateUuid

public GenerateUuid()

Method Detail

execute

public void execute(liquibase.database.Database database)
             throws liquibase.exception.CustomChangeException

Adds UUIDs to all rows for the specified tables. It generates UUIDs using Java and updates one row at a time, thus it is not very efficient. When running on the MySQL database, we generate SQL statements using the uuid MySQL function, which is much faster.

Specified by:

execute in interface liquibase.change.custom.CustomTaskChange

Throws:

liquibase.exception.CustomChangeException

See Also:

CustomTaskChange.execute(liquibase.database.Database)

getConfirmationMessage

public java.lang.String getConfirmationMessage()

Specified by:

getConfirmationMessage in interface liquibase.change.custom.CustomChange

See Also:

CustomChange.getConfirmationMessage()

setFileOpener

public void setFileOpener(liquibase.resource.ResourceAccessor fileOpener)

Specified by:

setFileOpener in interface liquibase.change.custom.CustomChange

See Also:

liquibase.change.custom.CustomChange#setFileOpener(liquibase.ResourceAccessor)

setUp

public void setUp()
           throws liquibase.exception.SetupException

Get the values of the parameters passed in and set them to the local variables on this class.

Specified by:

setUp in interface liquibase.change.custom.CustomChange

Throws:

liquibase.exception.SetupException

See Also:

CustomChange.setUp()

validate

public liquibase.exception.ValidationErrors validate(liquibase.database.Database database)

Specified by:

validate in interface liquibase.change.custom.CustomChange

See Also:

CustomChange.validate(liquibase.database.Database)

setTableNames

public void setTableNames(java.lang.String tableNames)

This is called by liquibase to set the parameter "tableNames" onto this change.

Parameters:

tableNames - the tableNames to set

setColumnName

public void setColumnName(java.lang.String columnName)

This is called by liquibase to set the parameter "columnName" onto this change.

Parameters:

columnName - the columnName to set

setIdExceptions

public void setIdExceptions(java.lang.String idExceptions)

Way to specify the table id columns that don't follow the table_name.table_name_id pattern

Parameters:

idExceptions -