com.groupdocs.annotation.data.connector.db.updater
Class CommonStorageSchemaUpdater

java.lang.Object
  com.groupdocs.annotation.data.connector.db.updater.CommonStorageSchemaUpdater

All Implemented Interfaces:

IStorageSchemaUpdater

Direct Known Subclasses:

MssqlStorageSchemaUpdater, MysqlStorageSchemaUpdater, PostgresqlStorageSchemaUpdater, SqliteStorageSchemaUpdater

public class CommonStorageSchemaUpdater
extends Object
implements IStorageSchemaUpdater

Common storage schema updated for all databases

Author:

Aleksey Permyakov (26.10.2014)

Field Summary

protected Map<Class,String>

javaType2dbType

Constructor Summary

CommonStorageSchemaUpdater(String dbDriver, String dbConnectionString)
Create updater instance

Method Summary

protected void	executeSQL(String sql) Execute SQL
protected Connection	getSchemaUpdateConnection() Create connection for update database schema
int	getStorageSchemaVersion() Getter for property 'storageSchemaVersion'.
boolean	onCreateColumn(String tableName, String fieldName, Class fieldType) Create column in table
boolean	onDeleteColumn(String tableName, String fieldName) Delete column from table
boolean	onDeleteTable(String tableName) Delete table from database
boolean	onRenameColumn(String tableName, String fieldName, String newFieldName) Rename table column
boolean	onRenameTable(String tableName, String newTableName) Rename table
boolean	setStorageSchemaVersion(int storageSchemaVersion) Set database schema version

Methods inherited from class java.lang.Object

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

Field Detail

javaType2dbType

protected Map<Class,String> javaType2dbType

Constructor Detail

CommonStorageSchemaUpdater

public CommonStorageSchemaUpdater(String dbDriver,
                                  String dbConnectionString)

Create updater instance

Parameters:

dbDriver - driver name

dbConnectionString - connection string

Method Detail

getStorageSchemaVersion

public int getStorageSchemaVersion()

Getter for property 'storageSchemaVersion'.

Specified by:

getStorageSchemaVersion in interface IStorageSchemaUpdater

Returns:

Value for property 'storageSchemaVersion'.

getSchemaUpdateConnection

protected Connection getSchemaUpdateConnection()
                                        throws AnnotationException

Create connection for update database schema

Returns:

connection

Throws:

AnnotationException

executeSQL

protected void executeSQL(String sql)
                   throws AnnotationException

Execute SQL

Parameters:

sql - SQL to execute

Throws:

AnnotationException

onDeleteColumn

public boolean onDeleteColumn(String tableName,
                              String fieldName)
                       throws AnnotationException

Delete column from table

Specified by:

onDeleteColumn in interface IStorageSchemaUpdater

Parameters:

tableName - table name

fieldName - column name

Returns:

success or fail

Throws:

AnnotationException

onRenameColumn

public boolean onRenameColumn(String tableName,
                              String fieldName,
                              String newFieldName)
                       throws AnnotationException

Rename table column

Specified by:

onRenameColumn in interface IStorageSchemaUpdater

Parameters:

tableName - table name

fieldName - column name

newFieldName - new column name

Returns:

success or fail

Throws:

AnnotationException

onCreateColumn

public boolean onCreateColumn(String tableName,
                              String fieldName,
                              Class fieldType)
                       throws AnnotationException

Create column in table

Specified by:

onCreateColumn in interface IStorageSchemaUpdater

Parameters:

tableName - table name

fieldName - column name

fieldType - column type

Returns:

success or fail

Throws:

AnnotationException

onDeleteTable

public boolean onDeleteTable(String tableName)
                      throws AnnotationException

Delete table from database

Specified by:

onDeleteTable in interface IStorageSchemaUpdater

Parameters:

tableName - table name for delete

Returns:

success or fail

Throws:

AnnotationException

onRenameTable

public boolean onRenameTable(String tableName,
                             String newTableName)
                      throws AnnotationException

Rename table

Specified by:

onRenameTable in interface IStorageSchemaUpdater

Parameters:

tableName - table name

newTableName - new table name

Returns:

success or fail

Throws:

AnnotationException

setStorageSchemaVersion

public boolean setStorageSchemaVersion(int storageSchemaVersion)
                                throws AnnotationException

Set database schema version

Specified by:

setStorageSchemaVersion in interface IStorageSchemaUpdater

Parameters:

storageSchemaVersion - database schema version

Returns:

success or fail

Throws:

AnnotationException