org.apache.ambari.server.orm.helpers.dbms

Interface DbmsHelper

All Known Implementing Classes:

DerbyHelper, GenericDbmsHelper, H2Helper, MySqlHelper, OracleHelper, PostgresHelper

public interface DbmsHelper

Method Summary

Modifier and Type	Method and Description
String	getAddColumnStatement(String tableName, DBAccessor.DBColumnInfo columnInfo)
String	getAddForeignKeyStatement(String tableName, String constraintName, List<String> keyColumns, String referenceTableName, List<String> referenceColumns, boolean shouldCascadeOnDelete)
String	getAddPrimaryKeyConstraintStatement(String tableName, String constraintName, String... columnName) Generate alter table statement to add primary key index
String	getAddUniqueConstraintStatement(String tableName, String constraintName, String... columnNames) Generate alter table statement to add unique constraint
String	getAlterColumnStatement(String tableName, DBAccessor.DBColumnInfo columnInfo) Generate alter column statement
String	getColumnUpdateStatementWhereColumnIsNull(String tableName, String setColumnName, String conditionColumnName) Generating update SQL statement for DBAccessor.executePreparedUpdate(java.lang.String, java.lang.Object...)
String	getCopyColumnToAnotherTableStatement(String sourceTable, String sourceColumnName, String sourceIDColumnName, String targetTable, String targetColumnName, String targetIDColumnName) Get's the UPDATE statement for sourceTable for copy column from targetTable by matching table keys sourceIDColumnName and targetIDColumnName
String	getCopyColumnToAnotherTableStatement(String sourceTable, String sourceColumnName, String sourceIDColumnName1, String sourceIDColumnName2, String sourceIDColumnName3, String targetTable, String targetColumnName, String targetIDColumnName1, String targetIDColumnName2, String targetIDColumnName3, String sourceConditionFieldName, String condition) Get's the UPDATE statement for sourceTable for copy column from targetTable by matching table keys sourceIDColumnName and targetIDColumnName and condition sourceConditionFieldName = condition
String	getCreateIndexStatement(String indexName, String tableName, boolean isUnique, String... columnNames)
String	getCreateIndexStatement(String indexName, String tableName, String... columnNames)
String	getCreateTableStatement(String tableName, List<DBAccessor.DBColumnInfo> columns, List<String> primaryKeyColumns)
String	getDropFKConstraintStatement(String tableName, String constraintName)
String	getDropIndexStatement(String indexName, String tableName) Gets DROP INDEX statement
String	getDropPrimaryKeyStatement(String tableName, String constraintName, boolean cascade)
String	getDropSequenceStatement(String sequenceName)
String	getDropTableColumnStatement(String tableName, String columnName)
String	getDropTableStatement(String tableName)
String	getDropUniqueConstraintStatement(String tableName, String constraintName)
String	getRenameColumnStatement(String tableName, String oldName, DBAccessor.DBColumnInfo columnInfo) Generate rename column statement
String	getRenameColumnStatement(String tableName, String oldColumnName, String newColumnName)
String	getSetNullableStatement(String tableName, DBAccessor.DBColumnInfo columnInfo, boolean nullable) Gets the SET NULL or SET NOT NULL statement.
String	getTableConstraintsStatement(String databaseName, String tablename)
boolean	isConstraintSupportedAfterNullability() Gets whether the database platform supports adding contraints after the NULL constraint.
String	quoteObjectName(String name)
boolean	supportsColumnTypeChange() Check if column type can be modified directly

Method Detail

supportsColumnTypeChange

boolean supportsColumnTypeChange()

Check if column type can be modified directly

Returns:

quoteObjectName

String quoteObjectName(String name)

getRenameColumnStatement

String getRenameColumnStatement(String tableName,
                                String oldName,
                                DBAccessor.DBColumnInfo columnInfo)

Generate rename column statement

Parameters:

tableName -

oldName -

columnInfo - definition of new column

Returns:

getAlterColumnStatement

String getAlterColumnStatement(String tableName,
                               DBAccessor.DBColumnInfo columnInfo)

Generate alter column statement

Parameters:

tableName -

columnInfo -

Returns:

getCreateTableStatement

String getCreateTableStatement(String tableName,
                               List<DBAccessor.DBColumnInfo> columns,
                               List<String> primaryKeyColumns)

getTableConstraintsStatement

String getTableConstraintsStatement(String databaseName,
                                    String tablename)

getCreateIndexStatement

String getCreateIndexStatement(String indexName,
                               String tableName,
                               String... columnNames)

getCreateIndexStatement

String getCreateIndexStatement(String indexName,
                               String tableName,
                               boolean isUnique,
                               String... columnNames)

getColumnUpdateStatementWhereColumnIsNull

String getColumnUpdateStatementWhereColumnIsNull(String tableName,
                                                 String setColumnName,
                                                 String conditionColumnName)

Generating update SQL statement for DBAccessor.executePreparedUpdate(java.lang.String, java.lang.Object...)

Parameters:

tableName - name of the table

setColumnName - column name, value of which need to be set

conditionColumnName - column name for the condition

Returns:

getDropIndexStatement

String getDropIndexStatement(String indexName,
                             String tableName)

Gets DROP INDEX statement

Parameters:

indexName -

tableName -

Returns:

getAddUniqueConstraintStatement

String getAddUniqueConstraintStatement(String tableName,
                                       String constraintName,
                                       String... columnNames)

Generate alter table statement to add unique constraint

Parameters:

tableName - name of the table

constraintName - name of the constraint

columnNames - name of the column

Returns:

alter table statement

getAddPrimaryKeyConstraintStatement

String getAddPrimaryKeyConstraintStatement(String tableName,
                                           String constraintName,
                                           String... columnName)

Generate alter table statement to add primary key index

Parameters:

tableName - name of the table

constraintName - name of the primary key

columnName - name of the column

Returns:

alter table statement

getAddForeignKeyStatement

String getAddForeignKeyStatement(String tableName,
                                 String constraintName,
                                 List<String> keyColumns,
                                 String referenceTableName,
                                 List<String> referenceColumns,
                                 boolean shouldCascadeOnDelete)

getAddColumnStatement

String getAddColumnStatement(String tableName,
                             DBAccessor.DBColumnInfo columnInfo)

getDropTableColumnStatement

String getDropTableColumnStatement(String tableName,
                                   String columnName)

getRenameColumnStatement

String getRenameColumnStatement(String tableName,
                                String oldColumnName,
                                String newColumnName)

getDropTableStatement

String getDropTableStatement(String tableName)

getDropFKConstraintStatement

String getDropFKConstraintStatement(String tableName,
                                    String constraintName)

getDropUniqueConstraintStatement

String getDropUniqueConstraintStatement(String tableName,
                                        String constraintName)

getDropSequenceStatement

String getDropSequenceStatement(String sequenceName)

getDropPrimaryKeyStatement

String getDropPrimaryKeyStatement(String tableName,
                                  String constraintName,
                                  boolean cascade)

getSetNullableStatement

String getSetNullableStatement(String tableName,
                               DBAccessor.DBColumnInfo columnInfo,
                               boolean nullable)

Gets the SET NULL or SET NOT NULL statement.

Parameters:

tableName - 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.

Returns:

the statement (never null).

getCopyColumnToAnotherTableStatement

String getCopyColumnToAnotherTableStatement(String sourceTable,
                                            String sourceColumnName,
                                            String sourceIDColumnName,
                                            String targetTable,
                                            String targetColumnName,
                                            String targetIDColumnName)

Get's the UPDATE statement for sourceTable for copy column from targetTable by matching table keys sourceIDColumnName and targetIDColumnName

Parameters:

sourceTable - the source table name

sourceColumnName - the source column name

sourceIDColumnName - source key id column which would be used to math right rows for targetTable

targetTable - the destination table name

targetColumnName - the destination column name

targetIDColumnName - destination key id column name which should math sourceIDColumnName

Returns:

getCopyColumnToAnotherTableStatement

String getCopyColumnToAnotherTableStatement(String sourceTable,
                                            String sourceColumnName,
                                            String sourceIDColumnName1,
                                            String sourceIDColumnName2,
                                            String sourceIDColumnName3,
                                            String targetTable,
                                            String targetColumnName,
                                            String targetIDColumnName1,
                                            String targetIDColumnName2,
                                            String targetIDColumnName3,
                                            String sourceConditionFieldName,
                                            String condition)

Get's the UPDATE statement for sourceTable for copy column from targetTable by matching table keys sourceIDColumnName and targetIDColumnName and condition sourceConditionFieldName = condition

Parameters:

sourceTable - the source table name

sourceColumnName - the source column name

sourceIDColumnName1 - source key id column which would be used to math right rows for targetTable

sourceIDColumnName2 - source key id column which would be used to math right rows for targetTable

sourceIDColumnName3 - source key id column which would be used to math right rows for targetTable

targetTable - the destination table name

targetColumnName - the destination column name

targetIDColumnName1 - destination key id column name which should match sourceIDColumnName1

targetIDColumnName2 - destination key id column name which should match sourceIDColumnName1

targetIDColumnName3 - destination key id column name which should match sourceIDColumnName1

sourceConditionFieldName - source key column name which should match condition

condition - value which should match sourceConditionFieldName

Returns:

isConstraintSupportedAfterNullability

boolean isConstraintSupportedAfterNullability()

Gets whether the database platform supports adding contraints after the NULL constraint. Some database, such as Oracle, don't allow this. Unfortunately, EclipsLink hard codes the order of constraints.

Returns:

true if contraints can be added after the NULL constraint, false otherwise.