org.apache.ambari.server.orm

Interface DBAccessor

All Known Implementing Classes:

DBAccessorImpl

public interface DBAccessor

Interface for schema manipulation Note: IF NOT EXISTS is default for all supported DDL statements

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DBAccessor.DBColumnInfo Capture column type
static class	DBAccessor.DbType

Method Summary

Modifier and Type	Method and Description
void	addColumn(String tableName, DBAccessor.DBColumnInfo columnInfo) Adds a column to an existing table.
void	addDefaultConstraint(String tableName, DBAccessor.DBColumnInfo column) Adds a default constraint to an existing column.
void	addFKConstraint(String tableName, String constraintName, String[] keyColumns, String referenceTableName, String[] referenceColumns, boolean ignoreFailure) Add foreign key for a relation
void	addFKConstraint(String tableName, String constraintName, String[] keyColumns, String referenceTableName, String[] referenceColumns, boolean shouldCascadeOnDelete, boolean ignoreFailure) Add foreign key for a relation
void	addFKConstraint(String tableName, String constraintName, String keyColumn, String referenceTableName, String referenceColumn, boolean ignoreFailure) Add foreign key for a relation
void	addFKConstraint(String tableName, String constraintName, String keyColumn, String referenceTableName, String referenceColumn, boolean shouldCascadeOnDelete, boolean ignoreFailure)
void	addPKConstraint(String tableName, String constraintName, boolean ignoreErrors, String... columnName)
void	addPKConstraint(String tableName, String constraintName, String... columnName)
void	addUniqueConstraint(String tableName, String constraintName, String... columnNames) Add unique table constraint
void	alterColumn(String tableName, DBAccessor.DBColumnInfo columnInfo) Alter column from existing table, only supports varchar extension Use following sequence for more complex stuff: addColumn(String, org.apache.ambari.server.orm.DBAccessor.DBColumnInfo) updateTable(String, String, Object, String) dropColumn(String, String) renameColumn(String, String, org.apache.ambari.server.orm.DBAccessor.DBColumnInfo)
void	changeColumnType(String tableName, String columnName, Class fromType, Class toType) Alter column wrapper, which handle DB specific type conversion
void	clearTable(String tableName) Remove all rows from the table
void	clearTableColumn(String tableName, String columnName, Object value) Reset all rows with value for columnName column
void	copyColumnToAnotherTable(String sourceTableName, DBAccessor.DBColumnInfo sourceColumn, String sourceIDFieldName1, String sourceIDFieldName2, String sourceIDFieldName3, String targetTableName, DBAccessor.DBColumnInfo targetColumn, String targetIDFieldName1, String targetIDFieldName2, String targetIDFieldName3, String sourceConditionFieldName, String condition, Object initialValue) Copy column from targetTable by matching table keys sourceIDColumnName and targetIDColumnName and condition sourceConditionFieldName = condition
void	createIndex(String indexName, String tableName, boolean isUnique, String... columnNames) Create new index
void	createIndex(String indexName, String tableName, String... columnNames) Create new index
void	createTable(String tableName, List<DBAccessor.DBColumnInfo> columnInfo, String... primaryKeyColumns) Create new table
void	dropColumn(String tableName, String columnName) Drop a column from table
void	dropFKConstraint(String tableName, String constraintName) Drops a FK constraint from a table.
void	dropFKConstraint(String tableName, String constraintName, boolean ignoreFailure) Drop a FK constraint from table
void	dropPKConstraint(String tableName, String defaultConstraintName) Attempts to drop the discovered PRIMARY KEY constraint on the specified table, defaulting to the specified default if not found.
void	dropPKConstraint(String tableName, String constraintName, boolean cascade) Drop a PK constraint from table
void	dropPKConstraint(String tableName, String constraintName, boolean ignoreFailure, boolean cascade) Drop a PK constraint from table
void	dropPKConstraint(String tableName, String constraintName, String columnName, boolean cascade) Drop a PK constraint from table
void	dropSequence(String sequenceName) Drop sequence
void	dropTable(String tableName) Drop table from schema
void	dropUniqueConstraint(String tableName, String constraintName) Drop a unique constraint from table
void	dropUniqueConstraint(String tableName, String constraintName, boolean ignoreFailure) Drop a unique constraint from table
void	executePreparedQuery(String query, boolean ignoreFailure, Object... arguments) Execute prepared update statements
void	executePreparedQuery(String query, Object... arguments) Execute prepared statements
void	executePreparedUpdate(String query, boolean ignoreFailure, Object... arguments) Execute prepared statements which will not ignore failures
void	executePreparedUpdate(String query, Object... arguments) Execute prepared update statements
void	executeQuery(String query) Execute ad-hoc query on DB.
void	executeQuery(String query, boolean ignoreFailure) Execute query on DB
void	executeQuery(String query, String tableName, String hasColumnName) Conditional ad-hoc query on DB
void	executeScript(String filePath) Helper method to run third party scripts like Quartz DDL
int	executeUpdate(String query)
int	executeUpdate(String query, boolean ignoreErrors)
Class	getColumnClass(String tableName, String columnName) Get type class of the column
DBAccessor.DBColumnInfo	getColumnInfo(String tableName, String columnName) Obtain column metadata information by given table and column name
int	getColumnType(String tableName, String columnName) Gets the column's SQL type
Connection	getConnection()
String	getDbSchema() Get database schema name
DBAccessor.DbType	getDbType() Get type of database platform
List<String>	getIndexesList(String tableName, boolean unique) Gets list of index names from database metadata
List<Integer>	getIntColumnValues(String tableName, String columnName, String[] conditionColumnNames, String[] conditionValues, boolean ignoreFailure) Execute select columnName from tableName where columnNames values = values
Map<Long,String>	getKeyToStringColumnMap(String tableName, String keyColumnName, String valueColumnName, String[] conditionColumnNames, String[] conditionValues, boolean ignoreFailure) Execute select keyColumnName, valueColumnName from tableName where columnNames values = values
Connection	getNewConnection()
org.eclipse.persistence.sessions.DatabaseSession	getNewDatabaseSession() Get a new DB session
String	getPrimaryKeyConstraintName(String tableName) Queries the database to determine the name of the primary key constraint on the specified table.
boolean	insertRow(String tableName, String[] columnNames, String[] values, boolean ignoreFailure) Insert row into table
boolean	insertRowIfMissing(String tableName, String[] columnNames, String[] values, boolean ignoreFailure) Conditionally insert row into table if it does not already exist
boolean	isColumnNullable(String tableName, String columnName) Check if column could be nullable
void	moveColumnToAnotherTable(String sourceTableName, DBAccessor.DBColumnInfo sourceColumn, String sourceIDFieldName, String targetTableName, DBAccessor.DBColumnInfo targetColumn, String targetIDFieldName, Object initialValue) Move column data from sourceTableName to targetTableName using sourceIDFieldName and targetIDFieldName keys to match right rows
String	quoteObjectName(String name) Wraps object name with dbms-specific quotes
void	renameColumn(String tableName, String oldColumnName, DBAccessor.DBColumnInfo columnInfo) Rename existing column
void	setColumnNullable(String tableName, DBAccessor.DBColumnInfo columnInfo, boolean nullable) Sets the specified column to either allow or prohibit NULL.
void	setColumnNullable(String tableName, String columnName, boolean nullable)
boolean	tableExists(String tableName) Verify if table exists by looking at metadata.
boolean	tableHasColumn(String tableName, String... columnName) Verify if table already has a column defined.
boolean	tableHasColumn(String tableName, String columnName) Verify if table already has a column defined.
boolean	tableHasData(String tableName) Verify if table has any data
boolean	tableHasForeignKey(String tableName, String fkName) Verify if table has a FK constraint.
boolean	tableHasForeignKey(String tableName, String referenceTableName, String[] keyColumns, String[] referenceColumns) Verify if table already has a FK constraint.
boolean	tableHasForeignKey(String tableName, String refTableName, String columnName, String refColumnName) Verify if table already has a FK constraint.
boolean	tableHasIndex(String tableName, boolean unique, String indexName) Check if index is already in scheme
boolean	tableHasPrimaryKey(String tableName, String columnName) Table has primary key
void	truncateTable(String tableName) Delete all table data
void	updateTable(String tableName, DBAccessor.DBColumnInfo columnNameSrc, DBAccessor.DBColumnInfo columnNameTgt) Simple update operation on table
int	updateTable(String tableName, String columnName, Object value, String whereClause) Simple update operation on table
void	updateUniqueConstraint(String tableName, String constraintName, String... columnNames) Add unique table constraint

Method Detail

getConnection

Connection getConnection()

Returns:

database connection

getNewConnection

Connection getNewConnection()

Returns:

new database connection

quoteObjectName

String quoteObjectName(String name)

Wraps object name with dbms-specific quotes

Parameters:

name - object name without quotes

Returns:

quoted name

createTable

void createTable(String tableName,
                 List<DBAccessor.DBColumnInfo> columnInfo,
                 String... primaryKeyColumns)
          throws SQLException

Create new table

Parameters:

tableName -

columnInfo -

primaryKeyColumns -

Throws:

SQLException

createIndex

void createIndex(String indexName,
                 String tableName,
                 String... columnNames)
          throws SQLException

Create new index

Parameters:

indexName -

tableName -

columnNames -

Throws:

SQLException

createIndex

void createIndex(String indexName,
                 String tableName,
                 boolean isUnique,
                 String... columnNames)
          throws SQLException

Create new index

Parameters:

indexName - The name of the index to be created

tableName - The database table the index to be created on

columnNames - The columns included into the index

isUnique - Specifies whether unique index is to be created.

Throws:

SQLException - Exception in case the index creation fails.

addFKConstraint

void addFKConstraint(String tableName,
                     String constraintName,
                     String keyColumn,
                     String referenceTableName,
                     String referenceColumn,
                     boolean ignoreFailure)
              throws SQLException

Add foreign key for a relation

Parameters:

tableName -

constraintName -

keyColumn -

referenceColumn -

Throws:

SQLException

addFKConstraint

void addFKConstraint(String tableName,
                     String constraintName,
                     String keyColumn,
                     String referenceTableName,
                     String referenceColumn,
                     boolean shouldCascadeOnDelete,
                     boolean ignoreFailure)
              throws SQLException

Parameters:

tableName -

constraintName -

keyColumn -

referenceTableName -

referenceColumn -

shouldCascadeOnDelete -

ignoreFailure -

Throws:

SQLException

addFKConstraint

void addFKConstraint(String tableName,
                     String constraintName,
                     String[] keyColumns,
                     String referenceTableName,
                     String[] referenceColumns,
                     boolean shouldCascadeOnDelete,
                     boolean ignoreFailure)
              throws SQLException

Add foreign key for a relation

Parameters:

tableName -

constraintName -

keyColumns -

referenceTableName -

referenceColumns -

shouldCascadeOnDelete -

ignoreFailure -

Throws:

SQLException

addFKConstraint

void addFKConstraint(String tableName,
                     String constraintName,
                     String[] keyColumns,
                     String referenceTableName,
                     String[] referenceColumns,
                     boolean ignoreFailure)
              throws SQLException

Add foreign key for a relation

Parameters:

tableName -

constraintName -

keyColumns -

referenceTableName -

referenceColumns -

ignoreFailure -

Throws:

SQLException

addColumn

void addColumn(String tableName,
               DBAccessor.DBColumnInfo columnInfo)
        throws SQLException

Adds a column to an existing table. This method will honor the DBAccessor.DBColumnInfo.isNullable and DBAccessor.DBColumnInfo.getDefaultValue() methods and create a new column that has a DEFAULT constraint.

Oracle is, of course, the exception here since their syntax doesn't conform to widely accepted SQL standards. Because they switch the order of the NULL constraint and the DEFAULT constraint, we need to create the table in a non-atomic fashion. This is because the EclipseLink FieldDeclaration class hard codes the order of the constraints. In the case of Oracle, we alter the nullability of the table after its creation.

No work is performed if the column already exists.

Parameters:

tableName -

columnInfo -

Throws:

SQLException

addUniqueConstraint

void addUniqueConstraint(String tableName,
                         String constraintName,
                         String... columnNames)
                  throws SQLException

Add unique table constraint

Parameters:

constraintName - name of the constraint

tableName - name of the table

columnNames - list of columns

Throws:

SQLException

updateUniqueConstraint

void updateUniqueConstraint(String tableName,
                            String constraintName,
                            String... columnNames)
                     throws SQLException

Add unique table constraint

Parameters:

constraintName - name of the constraint

tableName - name of the table

columnNames - list of columns

Throws:

SQLException

addPKConstraint

void addPKConstraint(String tableName,
                     String constraintName,
                     boolean ignoreErrors,
                     String... columnName)
              throws SQLException

Parameters:

tableName - name of the table

constraintName - name of the constraint

columnName - name of the column

ignoreErrors - true to ignore database errors

Throws:

SQLException

addPKConstraint

void addPKConstraint(String tableName,
                     String constraintName,
                     String... columnName)
              throws SQLException

Parameters:

tableName - name of the table

constraintName - name of the constraint

columnName - name of the column

Throws:

SQLException

renameColumn

void renameColumn(String tableName,
                  String oldColumnName,
                  DBAccessor.DBColumnInfo columnInfo)
           throws SQLException

Rename existing column

Parameters:

tableName -

oldColumnName -

columnInfo -

Throws:

SQLException

alterColumn

void alterColumn(String tableName,
                 DBAccessor.DBColumnInfo columnInfo)
          throws SQLException

Alter column from existing table, only supports varchar extension
Use following sequence for more complex stuff:

addColumn(String, org.apache.ambari.server.orm.DBAccessor.DBColumnInfo) updateTable(String, String, Object, String) dropColumn(String, String) renameColumn(String, String, org.apache.ambari.server.orm.DBAccessor.DBColumnInfo)

Parameters:

tableName -

columnInfo -

Throws:

SQLException

insertRow

boolean insertRow(String tableName,
                  String[] columnNames,
                  String[] values,
                  boolean ignoreFailure)
           throws SQLException

Insert row into table

Parameters:

tableName -

columnNames -

values -

ignoreFailure -

Returns:

Throws:

SQLException

insertRowIfMissing

boolean insertRowIfMissing(String tableName,
                           String[] columnNames,
                           String[] values,
                           boolean ignoreFailure)
                    throws SQLException

Conditionally insert row into table if it does not already exist

Parameters:

tableName -

columnNames -

values -

ignoreFailure -

Returns:

Throws:

SQLException

updateTable

int updateTable(String tableName,
                String columnName,
                Object value,
                String whereClause)
         throws SQLException

Simple update operation on table

Parameters:

tableName -

columnName -

value -

whereClause -

Returns:

Throws:

SQLException

updateTable

void updateTable(String tableName,
                 DBAccessor.DBColumnInfo columnNameSrc,
                 DBAccessor.DBColumnInfo columnNameTgt)
          throws SQLException

Simple update operation on table

Parameters:

tableName -

columnNameSrc -

columnNameTgt -

Throws:

SQLException

executeScript

void executeScript(String filePath)
            throws SQLException,
                   IOException

Helper method to run third party scripts like Quartz DDL

Parameters:

filePath -

Throws:

SQLException

IOException

executeUpdate

int executeUpdate(String query)
           throws SQLException

Parameters:

query - update query

Returns:

same like java.sql.Statement

Throws:

SQLException

executeUpdate

int executeUpdate(String query,
                  boolean ignoreErrors)
           throws SQLException

Parameters:

query - update query

ignoreErrors - true to ignore errors

Returns:

same like java.sql.Statement

Throws:

SQLException

executeQuery

void executeQuery(String query,
                  String tableName,
                  String hasColumnName)
           throws SQLException

Conditional ad-hoc query on DB

Parameters:

query -

tableName -

hasColumnName -

Throws:

SQLException

executeQuery

void executeQuery(String query)
           throws SQLException

Execute ad-hoc query on DB.

Parameters:

query -

Throws:

SQLException

executeQuery

void executeQuery(String query,
                  boolean ignoreFailure)
           throws SQLException

Execute query on DB

Parameters:

query -

ignoreFailure -

Throws:

SQLException

executePreparedQuery

void executePreparedQuery(String query,
                          Object... arguments)
                   throws SQLException

Execute prepared statements

Parameters:

query - query to execute

arguments - list of arguments for prepared statement

Throws:

SQLException

executePreparedQuery

void executePreparedQuery(String query,
                          boolean ignoreFailure,
                          Object... arguments)
                   throws SQLException

Execute prepared update statements

Parameters:

query - query to execute

ignoreFailure - determines if exceptions during query execution should be ignored

arguments - list of arguments for prepared statement

Throws:

SQLException

executePreparedUpdate

void executePreparedUpdate(String query,
                           Object... arguments)
                    throws SQLException

Execute prepared update statements

Parameters:

query - query to execute

arguments - list of arguments for prepared statement

Throws:

SQLException

executePreparedUpdate

void executePreparedUpdate(String query,
                           boolean ignoreFailure,
                           Object... arguments)
                    throws SQLException

Execute prepared statements which will not ignore failures

Parameters:

query -

ignoreFailure -

arguments -

Throws:

SQLException

getIntColumnValues

List<Integer> getIntColumnValues(String tableName,
                                 String columnName,
                                 String[] conditionColumnNames,
                                 String[] conditionValues,
                                 boolean ignoreFailure)
                          throws SQLException

Execute select columnName from tableName where columnNames values = values

Parameters:

tableName - the table name

columnName - the name of the column with the data to select

conditionColumnNames - an array of column names to use in the where clause

conditionValues - an array of value to pair with the column names in conditionColumnNames

ignoreFailure - true to ignore failures executing the query; false otherwise (errors building the query will be thrown, however)

Returns:

a list of integers

Throws:

SQLException

getKeyToStringColumnMap

Map<Long,String> getKeyToStringColumnMap(String tableName,
                                         String keyColumnName,
                                         String valueColumnName,
                                         String[] conditionColumnNames,
                                         String[] conditionValues,
                                         boolean ignoreFailure)
                                  throws SQLException

Execute select keyColumnName, valueColumnName from tableName where columnNames values = values

Parameters:

tableName - the table name

keyColumnName - the name of the column with the key data to select

valueColumnName - the name of the column with the value data to select

conditionColumnNames - an array of column names to use in the where clause

conditionValues - an array of value to pair with the column names in conditionColumnNames

ignoreFailure - true to ignore failures executing the query; false otherwise (errors building the query will be thrown, however)

Returns:

a map of key to values

Throws:

SQLException

dropTable

void dropTable(String tableName)
        throws SQLException

Drop table from schema

Parameters:

tableName -

Throws:

SQLException

truncateTable

void truncateTable(String tableName)
            throws SQLException

Delete all table data

Parameters:

tableName -

Throws:

SQLException

dropColumn

void dropColumn(String tableName,
                String columnName)
         throws SQLException

Drop a column from table

Parameters:

tableName -

columnName -

Throws:

SQLException

dropSequence

void dropSequence(String sequenceName)
           throws SQLException

Drop sequence

Parameters:

sequenceName -

Throws:

SQLException

dropFKConstraint

void dropFKConstraint(String tableName,
                      String constraintName)
               throws SQLException

Drops a FK constraint from a table. In the case of Configuration.DatabaseType.MYSQL, this will also ensure that any associated indexes are also dropped.

Parameters:

tableName - name of the table

constraintName - name of the constraint

Throws:

SQLException

dropPKConstraint

void dropPKConstraint(String tableName,
                      String constraintName,
                      boolean ignoreFailure,
                      boolean cascade)
               throws SQLException

Drop a PK constraint from table

Parameters:

tableName -

constraintName - name of the constraint

ignoreFailure -

cascade - cascade delete

Throws:

SQLException

dropPKConstraint

void dropPKConstraint(String tableName,
                      String constraintName,
                      boolean cascade)
               throws SQLException

Drop a PK constraint from table

Parameters:

tableName - name of the table

constraintName - name of the constraint

cascade - cascade delete

Throws:

SQLException

dropPKConstraint

void dropPKConstraint(String tableName,
                      String constraintName,
                      String columnName,
                      boolean cascade)
               throws SQLException

Drop a PK constraint from table

Parameters:

tableName - name of the table

constraintName - name of the constraint

columnName - name of the column from the pk constraint

cascade - cascade delete

Throws:

SQLException

dropFKConstraint

void dropFKConstraint(String tableName,
                      String constraintName,
                      boolean ignoreFailure)
               throws SQLException

Drop a FK constraint from table

Parameters:

tableName - name of the table

constraintName - name of the constraint

Throws:

SQLException

dropUniqueConstraint

void dropUniqueConstraint(String tableName,
                          String constraintName,
                          boolean ignoreFailure)
                   throws SQLException

Drop a unique constraint from table

Parameters:

tableName - name of the table

constraintName - name of the constraint

ignoreFailure -

Throws:

SQLException

dropUniqueConstraint

void dropUniqueConstraint(String tableName,
                          String constraintName)
                   throws SQLException

Drop a unique constraint from table

Parameters:

tableName - name of the table

constraintName - name of the constraint

Throws:

SQLException

tableExists

boolean tableExists(String tableName)
             throws SQLException

Verify if table exists by looking at metadata.

Parameters:

tableName - name of the table

Returns:

Throws:

SQLException

tableHasData

boolean tableHasData(String tableName)
              throws SQLException

Verify if table has any data

Parameters:

tableName -

Returns:

Throws:

SQLException

tableHasColumn

boolean tableHasColumn(String tableName,
                       String columnName)
                throws SQLException

Verify if table already has a column defined.

Parameters:

tableName -

columnName -

Returns:

Throws:

SQLException

tableHasColumn

boolean tableHasColumn(String tableName,
                       String... columnName)
                throws SQLException

Verify if table already has a column defined.

Parameters:

tableName - name of the table

columnName - name of the column to check

Returns:

false if one from passed column names not exists

Throws:

SQLException

tableHasForeignKey

boolean tableHasForeignKey(String tableName,
                           String fkName)
                    throws SQLException

Verify if table has a FK constraint.

Parameters:

tableName -

fkName -

Returns:

true if FK with such name exists

Throws:

SQLException

tableHasForeignKey

boolean tableHasForeignKey(String tableName,
                           String refTableName,
                           String columnName,
                           String refColumnName)
                    throws SQLException

Verify if table already has a FK constraint.

Parameters:

tableName -

refTableName -

columnName -

refColumnName -

Returns:

true if described relation exists

Throws:

SQLException

tableHasForeignKey

boolean tableHasForeignKey(String tableName,
                           String referenceTableName,
                           String[] keyColumns,
                           String[] referenceColumns)
                    throws SQLException

Verify if table already has a FK constraint.

Parameters:

tableName -

referenceTableName -

keyColumns -

referenceColumns -

Returns:

true if described relation exists

Throws:

SQLException

getNewDatabaseSession

org.eclipse.persistence.sessions.DatabaseSession getNewDatabaseSession()

Get a new DB session

Returns:

tableHasPrimaryKey

boolean tableHasPrimaryKey(String tableName,
                           String columnName)
                    throws SQLException

Table has primary key

Parameters:

tableName - name of the table

columnName - name of the constraint, could be null

Returns:

true if constraint exists

Throws:

SQLException

getIndexesList

List<String> getIndexesList(String tableName,
                            boolean unique)
                     throws SQLException

Gets list of index names from database metadata

Parameters:

tableName - the name of the table (not null).

unique - list only unique indexes (not null).

Returns:

the string list of index names

Throws:

SQLException

tableHasIndex

boolean tableHasIndex(String tableName,
                      boolean unique,
                      String indexName)
               throws SQLException

Check if index is already in scheme

Parameters:

tableName - the name of the table (not null).

unique - list only unique indexes (not null).

indexName - name of the index to check

Returns:

true if index present in the schema

Throws:

SQLException

getColumnType

int getColumnType(String tableName,
                  String columnName)
           throws SQLException

Gets the column's SQL type

Parameters:

tableName - the name of the table (not null).

columnName - the name of the column to retrieve type for (not null).

Returns:

the integer representation of the column type

Throws:

SQLException

getColumnClass

Class getColumnClass(String tableName,
                     String columnName)
              throws SQLException,
                     ClassNotFoundException

Get type class of the column

Parameters:

tableName - name of the table

columnName - name of the column

Returns:

type class of the column

Throws:

SQLException

ClassNotFoundException

isColumnNullable

boolean isColumnNullable(String tableName,
                         String columnName)
                  throws SQLException

Check if column could be nullable

Parameters:

tableName - name of the table

columnName - name of the column

Returns:

true if column could be nullable

Throws:

SQLException

setColumnNullable

void setColumnNullable(String tableName,
                       DBAccessor.DBColumnInfo columnInfo,
                       boolean nullable)
                throws SQLException

Sets the specified column to either allow or prohibit NULL.

Parameters:

tableName - the name of the table (not null).

columnInfo - the column object to get name and type of column (not null).

nullable - true to indicate that the column allows NULL values, false otherwise.

Throws:

SQLException

setColumnNullable

void setColumnNullable(String tableName,
                       String columnName,
                       boolean nullable)
                throws SQLException

Throws:

SQLException

changeColumnType

void changeColumnType(String tableName,
                      String columnName,
                      Class fromType,
                      Class toType)
               throws SQLException

Alter column wrapper, which handle DB specific type conversion

Parameters:

tableName - name of the table

columnName - name of the column

fromType - previous type

toType - new desired type

Throws:

SQLException

getColumnInfo

DBAccessor.DBColumnInfo getColumnInfo(String tableName,
                                      String columnName)
                               throws SQLException

Obtain column metadata information by given table and column name

Parameters:

tableName - name of the table

columnName - name of the column

Returns:

column information

Throws:

SQLException

getPrimaryKeyConstraintName

String getPrimaryKeyConstraintName(String tableName)
                            throws SQLException

Queries the database to determine the name of the primary key constraint on the specified table. Currently, this is only implemented for Configuration.DatabaseType.POSTGRES, Configuration.DatabaseType.ORACLE and Configuration.DatabaseType.SQL_SERVER. Configuration.DatabaseType.MYSQL does not need this since PKs can be dropped without referencing their name.

Parameters:

tableName - the name of the table to lookup the PK constraint.

Returns:

the name of the PK, or null if none.

Throws:

SQLException

dropPKConstraint

void dropPKConstraint(String tableName,
                      String defaultConstraintName)
               throws SQLException

Attempts to drop the discovered PRIMARY KEY constraint on the specified table, defaulting to the specified default if not found.

Parameters:

tableName - the table to drop the PK from (not null).

defaultConstraintName - the default name of the PK constraint if none is found.

Throws:

SQLException

addDefaultConstraint

void addDefaultConstraint(String tableName,
                          DBAccessor.DBColumnInfo column)
                   throws SQLException

Adds a default constraint to an existing column.

Parameters:

tableName - the table where the column is defined (not null).

column - the column information which contains the default value (not null).

Throws:

SQLException

moveColumnToAnotherTable

void moveColumnToAnotherTable(String sourceTableName,
                              DBAccessor.DBColumnInfo sourceColumn,
                              String sourceIDFieldName,
                              String targetTableName,
                              DBAccessor.DBColumnInfo targetColumn,
                              String targetIDFieldName,
                              Object initialValue)
                       throws SQLException

Move column data from sourceTableName to targetTableName using sourceIDFieldName and targetIDFieldName keys to match right rows

Parameters:

sourceTableName - the source table name

sourceColumn - the source column name

sourceIDFieldName - the source id key filed name matched with targetIDFieldName

targetTableName - the target table name

targetColumn - the target column name

targetIDFieldName - the target id key name matched with sourceIDFieldName

initialValue - initial value for null-contained cells

Throws:

SQLException

copyColumnToAnotherTable

void copyColumnToAnotherTable(String sourceTableName,
                              DBAccessor.DBColumnInfo sourceColumn,
                              String sourceIDFieldName1,
                              String sourceIDFieldName2,
                              String sourceIDFieldName3,
                              String targetTableName,
                              DBAccessor.DBColumnInfo targetColumn,
                              String targetIDFieldName1,
                              String targetIDFieldName2,
                              String targetIDFieldName3,
                              String sourceConditionFieldName,
                              String condition,
                              Object initialValue)
                       throws SQLException

Copy column from targetTable by matching table keys sourceIDColumnName and targetIDColumnName and condition sourceConditionFieldName = condition

Parameters:

sourceTableName - the source table name

sourceColumn - the source column name

sourceIDFieldName1 - the source id key filed name matched with targetIDFieldName1

sourceIDFieldName2 - the source id key filed name matched with targetIDFieldName2

sourceIDFieldName3 - the source id key filed name matched with targetIDFieldName3

targetTableName - the target table name

targetColumn - the target column name

targetIDFieldName1 - the target id key name matched with sourceIDFieldName1

targetIDFieldName2 - the target id key name matched with sourceIDFieldName2

targetIDFieldName3 - the target id key name matched with sourceIDFieldName3

sourceConditionFieldName - source key column name which should match condition

condition - value which should match sourceConditionFieldName

initialValue - initial value for null-contained cells

Throws:

SQLException

clearTable

void clearTable(String tableName)
         throws SQLException

Remove all rows from the table

Parameters:

tableName - name of the table

Throws:

SQLException

clearTableColumn

void clearTableColumn(String tableName,
                      String columnName,
                      Object value)
               throws SQLException

Reset all rows with value for columnName column

Parameters:

tableName - name of the table

columnName - name of the column name to be update

value - data to use for update

Throws:

SQLException

getDbType

DBAccessor.DbType getDbType()

Get type of database platform

Returns:

@DbType

getDbSchema

String getDbSchema()

Get database schema name

Returns:

@dbSchema