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

Class GenericDbmsHelper

java.lang.Object

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

All Implemented Interfaces:

DbmsHelper

Direct Known Subclasses:

DerbyHelper, H2Helper, MySqlHelper, OracleHelper, PostgresHelper

public class GenericDbmsHelper
extends Object
implements DbmsHelper

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.persistence.platform.database.DatabasePlatform	databasePlatform

Constructor Summary

Constructors

Constructor and Description
GenericDbmsHelper(org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)

Method Summary

Modifier and Type	Method and Description
org.eclipse.persistence.tools.schemaframework.FieldDefinition	convertToFieldDefinition(DBAccessor.DBColumnInfo columnInfo)
org.eclipse.persistence.internal.sessions.AbstractSession	createStubAbstractSessionFromPlatform(org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)
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) get create index statement
String	getCreateIndexStatement(String indexName, String tableName, String... columnNames) get create index statement
String	getCreateTableStatement(String tableName, List<DBAccessor.DBColumnInfo> columns, List<String> primaryKeyColumns) get create table statement
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
StringBuilder	writeAddPrimaryKeyString(StringBuilder builder, String constraintName, String... columnName)
StringBuilder	writeAlterTableClause(StringBuilder builder, String tableName)
StringBuilder	writeColumnModifyString(StringBuilder builder, DBAccessor.DBColumnInfo columnInfo)
StringBuilder	writeColumnRenameString(StringBuilder builder, String oldName, DBAccessor.DBColumnInfo newColumnInfo)
StringBuilder	writeColumnType(StringBuilder builder, DBAccessor.DBColumnInfo columnInfo)
Writer	writeCreateTableStatement(Writer writer, String tableName, List<DBAccessor.DBColumnInfo> columns, List<String> primaryKeyColumns) Write create table statement to writer TODO default Value of column not supported
StringBuilder	writeDropPrimaryKeyStatement(StringBuilder builder, String constraintName, boolean cascade)
StringBuilder	writeDropTableColumnStatement(StringBuilder builder, String columnName)
String	writeGetTableConstraints(String databaseName, String tableName)
StringBuilder	writeSetNullableString(StringBuilder builder, String tableName, DBAccessor.DBColumnInfo columnInfo, boolean nullable)

Methods inherited from class java.lang.Object

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

Field Detail

databasePlatform

protected final org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform

Constructor Detail

GenericDbmsHelper

public GenericDbmsHelper(org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)

Method Detail

supportsColumnTypeChange

public boolean supportsColumnTypeChange()

Description copied from interface: DbmsHelper

Check if column type can be modified directly

Specified by:

supportsColumnTypeChange in interface DbmsHelper

Returns:

quoteObjectName

public String quoteObjectName(String name)

Specified by:

quoteObjectName in interface DbmsHelper

getRenameColumnStatement

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

Description copied from interface: DbmsHelper

Generate rename column statement

Specified by:

getRenameColumnStatement in interface DbmsHelper

columnInfo - definition of new column

Returns:

getAlterColumnStatement

public String getAlterColumnStatement(String tableName,
                                      DBAccessor.DBColumnInfo columnInfo)

Description copied from interface: DbmsHelper

Generate alter column statement

Specified by:

getAlterColumnStatement in interface DbmsHelper

Returns:

getSetNullableStatement

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

Description copied from interface: DbmsHelper

Gets the SET NULL or SET NOT NULL statement.

Specified by:

getSetNullableStatement in interface DbmsHelper

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

public 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

Specified by:

getCopyColumnToAnotherTableStatement in interface DbmsHelper

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

public 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

Specified by:

getCopyColumnToAnotherTableStatement in interface DbmsHelper

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:

writeAlterTableClause

public StringBuilder writeAlterTableClause(StringBuilder builder,
                                           String tableName)

writeColumnModifyString

public StringBuilder writeColumnModifyString(StringBuilder builder,
                                             DBAccessor.DBColumnInfo columnInfo)

writeColumnRenameString

public StringBuilder writeColumnRenameString(StringBuilder builder,
                                             String oldName,
                                             DBAccessor.DBColumnInfo newColumnInfo)

writeColumnType

public StringBuilder writeColumnType(StringBuilder builder,
                                     DBAccessor.DBColumnInfo columnInfo)

writeGetTableConstraints

public String writeGetTableConstraints(String databaseName,
                                       String tableName)

writeAddPrimaryKeyString

public StringBuilder writeAddPrimaryKeyString(StringBuilder builder,
                                              String constraintName,
                                              String... columnName)

writeSetNullableString

public StringBuilder writeSetNullableString(StringBuilder builder,
                                            String tableName,
                                            DBAccessor.DBColumnInfo columnInfo,
                                            boolean nullable)

writeDropTableColumnStatement

public StringBuilder writeDropTableColumnStatement(StringBuilder builder,
                                                   String columnName)

writeDropPrimaryKeyStatement

public StringBuilder writeDropPrimaryKeyStatement(StringBuilder builder,
                                                  String constraintName,
                                                  boolean cascade)

Parameters:

builder - String Builder passed by reference

constraintName - Constraint Name used by Postgres

cascade - In postgres, can perform a CASCADE delete. In the other DB flavors, this is ignored.

Returns:

Return the String Builder

getDropPrimaryKeyStatement

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

Specified by:

getDropPrimaryKeyStatement in interface DbmsHelper

getCreateTableStatement

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

get create table statement

Specified by:

getCreateTableStatement in interface DbmsHelper

Parameters:

tableName -

columns -

primaryKeyColumns -

Returns:

writeCreateTableStatement

public Writer writeCreateTableStatement(Writer writer,
                                        String tableName,
                                        List<DBAccessor.DBColumnInfo> columns,
                                        List<String> primaryKeyColumns)

Write create table statement to writer TODO default Value of column not supported

convertToFieldDefinition

public org.eclipse.persistence.tools.schemaframework.FieldDefinition convertToFieldDefinition(DBAccessor.DBColumnInfo columnInfo)

getDropUniqueConstraintStatement

public String getDropUniqueConstraintStatement(String tableName,
                                               String constraintName)

Specified by:

getDropUniqueConstraintStatement in interface DbmsHelper

getTableConstraintsStatement

public String getTableConstraintsStatement(String databaseName,
                                           String tablename)

Specified by:

getTableConstraintsStatement in interface DbmsHelper

getCreateIndexStatement

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

get create index statement

Specified by:

getCreateIndexStatement in interface DbmsHelper

Parameters:

indexName -

tableName -

columnNames -

Returns:

getCreateIndexStatement

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

get create index statement

Specified by:

getCreateIndexStatement in interface DbmsHelper

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.

Returns:

The sql statement for creating the index

getColumnUpdateStatementWhereColumnIsNull

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

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

Specified by:

getColumnUpdateStatementWhereColumnIsNull in interface DbmsHelper

Parameters:

tableName - name of the table

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

conditionColumnName - column name for the condition

Returns:

getDropIndexStatement

public String getDropIndexStatement(String indexName,
                                    String tableName)

Gets DROP INDEX statement

Specified by:

getDropIndexStatement in interface DbmsHelper

Returns:

getAddUniqueConstraintStatement

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

Description copied from interface: DbmsHelper

Generate alter table statement to add unique constraint

Specified by:

getAddUniqueConstraintStatement in interface DbmsHelper

Parameters:

tableName - name of the table

constraintName - name of the constraint

columnNames - name of the column

Returns:

alter table statement

getAddPrimaryKeyConstraintStatement

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

Description copied from interface: DbmsHelper

Generate alter table statement to add primary key index

Specified by:

getAddPrimaryKeyConstraintStatement in interface DbmsHelper

Parameters:

tableName - name of the table

constraintName - name of the primary key

columnName - name of the column

Returns:

alter table statement

getAddForeignKeyStatement

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

Specified by:

getAddForeignKeyStatement in interface DbmsHelper

getAddColumnStatement

public String getAddColumnStatement(String tableName,
                                    DBAccessor.DBColumnInfo columnInfo)

Specified by:

getAddColumnStatement in interface DbmsHelper

getDropTableColumnStatement

public String getDropTableColumnStatement(String tableName,
                                          String columnName)

Specified by:

getDropTableColumnStatement in interface DbmsHelper

getRenameColumnStatement

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

Specified by:

getRenameColumnStatement in interface DbmsHelper

getDropTableStatement

public String getDropTableStatement(String tableName)

Specified by:

getDropTableStatement in interface DbmsHelper

getDropFKConstraintStatement

public String getDropFKConstraintStatement(String tableName,
                                           String constraintName)

Specified by:

getDropFKConstraintStatement in interface DbmsHelper

getDropSequenceStatement

public String getDropSequenceStatement(String sequenceName)

Specified by:

getDropSequenceStatement in interface DbmsHelper

createStubAbstractSessionFromPlatform

public org.eclipse.persistence.internal.sessions.AbstractSession createStubAbstractSessionFromPlatform(org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)

isConstraintSupportedAfterNullability

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

Specified by:

isConstraintSupportedAfterNullability in interface DbmsHelper

Returns:

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