org.dbmaintain.database.impl
Class DerbyDatabase

java.lang.Object
  org.dbmaintain.database.Database
      org.dbmaintain.database.impl.DerbyDatabase

public class DerbyDatabase
extends Database

Implementation of Database for a Derby database.

Special thanks to Scott Prater who donated the initial version of the Derby support code.

Author:

Scott Prater, Tim Ducheyne, Filip Neven

Field Summary

Fields inherited from class org.dbmaintain.database.Database

databaseConnection, identifierProcessor, schemaNames

Constructor Summary

DerbyDatabase(DatabaseConnection databaseConnection, IdentifierProcessor identifierProcessor)

Method Summary

void	disableReferentialConstraints(String schemaName) Disables all referential constraints (e.g. foreign keys) on all table in the schema
protected void	disableReferentialConstraints(String schemaName, String tableName)
void	disableValueConstraints(String schemaName) Disables all value constraints (e.g. not null) on all tables in the schema
protected void	disableValueConstraints(String schemaName, String tableName)
Set<String>	getColumnNames(String schemaName, String tableName) Gets the names of all columns of the given table.
Set<String>	getIdentityColumnNames(String schemaName, String tableName) Gets the names of all identity columns of the given table.
protected Set<String>	getNotNullColummnNames(String schemaName, String tableName) Returns the names of all columns that have a 'not-null' constraint on them.
protected Set<String>	getPrimaryKeyColumnNames(String schemaName, String tableName) Gets the names of all primary columns of the given table.
String	getSupportedDatabaseDialect()
Set<String>	getSynonymNames(String schemaName) Retrieves the names of all the synonyms in the database schema.
Set<String>	getTableNames(String schemaName) Returns the names of all tables in the database.
Set<String>	getTriggerNames(String schemaName) Retrieves the names of all the triggers in the database schema.
Set<String>	getViewNames(String schemaName) Retrieves the names of all the views in the database schema.
void	incrementIdentityColumnToValue(String schemaName, String tableName, String identityColumnName, long identityValue) Increments the identity value for the specified identity column on the specified table to the given value.
void	setDatabaseDefaultSchema() Sets the current schema of the database.
void	setSettingIdentityColumnValueEnabled(String schemaName, String tableName, boolean enabled) Enables or disables the setting of identity value in insert and update statements.
boolean	supportsIdentityColumns() Identity columns are supported.
boolean	supportsSetDatabaseDefaultSchema() Setting the default schema is supported.
boolean	supportsSynonyms() Synonyms are supported.
boolean	supportsTriggers() Triggers are supported.

Methods inherited from class org.dbmaintain.database.Database

disableReferentialConstraints, disableValueConstraints, dropMaterializedView, dropMaterializedView, dropRule, dropSequence, dropSequence, dropStoredProcedure, dropStoredProcedure, dropSynonym, dropSynonym, dropTable, dropTable, dropTrigger, dropTrigger, dropType, dropType, dropView, dropView, getColumnNames, getDatabaseInfo, getDatabaseName, getDataSource, getDefaultSchemaName, getIdentifierQuoteString, getIdentityColumnNames, getLongDataType, getMaterializedViewNames, getMaterializedViewNames, getRuleNames, getSchemaNames, getSequenceNames, getSequenceNames, getSequenceValue, getSequenceValue, getSQLHandler, getStoredIdentifierCase, getStoredProcedureNames, getStoredProcedureNames, getSynonymNames, getTableNames, getTextDataType, getTriggerNames, getTypeNames, getTypeNames, getViewNames, incrementIdentityColumnToValue, incrementSequenceToValue, incrementSequenceToValue, isQuoted, qualified, qualified, quoted, removeIdentifierQuotes, setSettingIdentityColumnValueEnabled, supportsCascade, supportsMaterializedViews, supportsRules, supportsSequences, supportsStoredProcedures, supportsTypes, toCorrectCaseIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

DerbyDatabase

public DerbyDatabase(DatabaseConnection databaseConnection,
                     IdentifierProcessor identifierProcessor)

Method Detail

getSupportedDatabaseDialect

public String getSupportedDatabaseDialect()

Specified by:

getSupportedDatabaseDialect in class Database

Returns:

the database dialect supported by this db support class, not null

getTableNames

public Set<String> getTableNames(String schemaName)

Returns the names of all tables in the database.

Specified by:

getTableNames in class Database

Parameters:

schemaName - The schema, not null

Returns:

The names of all tables in the database

getColumnNames

public Set<String> getColumnNames(String schemaName,
                                  String tableName)

Gets the names of all columns of the given table.

Specified by:

getColumnNames in class Database

Parameters:

tableName - The table, not null

schemaName - The schema, not null

Returns:

The names of the columns of the table with the given name

getViewNames

public Set<String> getViewNames(String schemaName)

Retrieves the names of all the views in the database schema.

Specified by:

getViewNames in class Database

Parameters:

schemaName - The schema, not null

Returns:

The names of all views in the database

getSynonymNames

public Set<String> getSynonymNames(String schemaName)

Retrieves the names of all the synonyms in the database schema.

Overrides:

getSynonymNames in class Database

Parameters:

schemaName - The schema, not null

Returns:

The names of all synonyms in the database

getTriggerNames

public Set<String> getTriggerNames(String schemaName)

Retrieves the names of all the triggers in the database schema.

Overrides:

getTriggerNames in class Database

Parameters:

schemaName - The schema, not null

Returns:

The names of all triggers in the database

getIdentityColumnNames

public Set<String> getIdentityColumnNames(String schemaName,
                                          String tableName)

Gets the names of all identity columns of the given table.

todo check, at this moment the PK columns are returned

Overrides:

getIdentityColumnNames in class Database

Parameters:

tableName - The table, not null

schemaName - The schema, not null

Returns:

The names of the identity columns of the table with the given name

incrementIdentityColumnToValue

public void incrementIdentityColumnToValue(String schemaName,
                                           String tableName,
                                           String identityColumnName,
                                           long identityValue)

Increments the identity value for the specified identity column on the specified table to the given value.

Overrides:

incrementIdentityColumnToValue in class Database

Parameters:

tableName - The table with the identity column, not null

identityColumnName - The column, not null

identityValue - The new value

schemaName - The schema, not null

disableReferentialConstraints

public void disableReferentialConstraints(String schemaName)

Disables all referential constraints (e.g. foreign keys) on all table in the schema

Specified by:

disableReferentialConstraints in class Database

Parameters:

schemaName - The schema, not null

disableReferentialConstraints

protected void disableReferentialConstraints(String schemaName,
                                             String tableName)

disableValueConstraints

public void disableValueConstraints(String schemaName)

Disables all value constraints (e.g. not null) on all tables in the schema

Specified by:

disableValueConstraints in class Database

Parameters:

schemaName - The schema, not null

disableValueConstraints

protected void disableValueConstraints(String schemaName,
                                       String tableName)

setDatabaseDefaultSchema

public void setDatabaseDefaultSchema()

Sets the current schema of the database. If a current schema is set, it does not need to be specified explicitly in the scripts.

Overrides:

setDatabaseDefaultSchema in class Database

setSettingIdentityColumnValueEnabled

public void setSettingIdentityColumnValueEnabled(String schemaName,
                                                 String tableName,
                                                 boolean enabled)

Enables or disables the setting of identity value in insert and update statements. By default some databases do not allow to set values of identity columns directly from insert/update statements. If supported, this method will enable/disable this behavior.

Overrides:

setSettingIdentityColumnValueEnabled in class Database

Parameters:

schemaName - The schema name, not null

tableName - The table with the identity column, not null

enabled - True to enable, false to disable

supportsSynonyms

public boolean supportsSynonyms()

Synonyms are supported.

Overrides:

supportsSynonyms in class Database

Returns:

True

supportsTriggers

public boolean supportsTriggers()

Triggers are supported.

Overrides:

supportsTriggers in class Database

Returns:

True

supportsIdentityColumns

public boolean supportsIdentityColumns()

Identity columns are supported.

Overrides:

supportsIdentityColumns in class Database

Returns:

True

supportsSetDatabaseDefaultSchema

public boolean supportsSetDatabaseDefaultSchema()

Setting the default schema is supported.

Overrides:

supportsSetDatabaseDefaultSchema in class Database

Returns:

True

getPrimaryKeyColumnNames

protected Set<String> getPrimaryKeyColumnNames(String schemaName,
                                               String tableName)

Gets the names of all primary columns of the given table.

This info is not available in the Derby sys tables. The database meta data is used instead to retrieve it.

Parameters:

schemaName - The schema, not null

tableName - The table, not null

Returns:

The names of the primary key columns of the table with the given name

getNotNullColummnNames

protected Set<String> getNotNullColummnNames(String schemaName,
                                             String tableName)

Returns the names of all columns that have a 'not-null' constraint on them.

This info is not available in the Derby sys tables. The database meta data is used instead to retrieve it.

Parameters:

schemaName - The schema, not null

tableName - The table, not null

Returns:

The set of column names, not null