DBAccessorImpl (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.orm.DBAccessorImpl

All Implemented Interfaces:: DBAccessor

public class DBAccessorImpl
extends Object
implements DBAccessor

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.ambari.server.orm.DBAccessor
  DBAccessor.DBColumnInfo, DBAccessor.DbType

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`NULL_CATALOG_MEANS_CURRENT`
`static String`	`PASSWORD`
`static int`	`SUPPORT_CONNECTOR_VERSION`
`static String`	`TRUE`
`static String`	`USER`

Constructor Summary

Constructors
Constructor and Description

DBAccessorImpl(Configuration configuration)

Constructors
Constructor and Description
`DBAccessorImpl(Configuration configuration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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: `DBAccessor.addColumn(String, org.apache.ambari.server.orm.DBAccessor.DBColumnInfo)` `DBAccessor.updateTable(String, String, Object, String)` `DBAccessor.dropColumn(String, String)` `DBAccessor.renameColumn(String, String, org.apache.ambari.server.orm.DBAccessor.DBColumnInfo)`
`protected String`	`buildQuery(String tableName, String[] requestedColumnNames, String[] conditionColumnNames, String[] conditionValues)` Build a SELECT statement using the supplied table name, request columns and conditional column/value pairs.
`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
`static String`	`escapeParameter(Object value, org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)`
`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
`protected <T> T`	`executeQuery(String tableName, String[] requestedColumnNames, String[] conditionColumnNames, String[] conditionValues, boolean ignoreFailure, org.apache.ambari.server.orm.DBAccessorImpl.ResultGetter<T> resultGetter)` Executes a query returning data as specified by the `ResultGetter` implementation.
`void`	`executeQuery(String query, String tableName, String hasColumnName)` Conditional ad-hoc query on DB
`void`	`executeScript(String filePath)` Execute script with autocommit and error tolerance, like psql and sqlplus do by default
`int`	`executeUpdate(String query)`
`int`	`executeUpdate(String query, boolean ignoreErrors)`
`String`	`getCheckedForeignKey(String rawTableName, String rawForeignKeyName)`
`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()`
`protected DatabaseMetaData`	`getDatabaseMetaData()`
`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[] values, boolean ignoreFailure)` Execute select `columnName` from `tableName` where `columnNames` values = `values`
`Map<Long,String>`	`getKeyToStringColumnMap(String tableName, String keyColumnName, String valueColumnName, String[] conditionColumnNames, String[] values, 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
`protected DbmsHelper`	`loadHelper(org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)`
`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`	`tableHasConstraint(String tableName, String constraintName)`
`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 columnNameFrom, DBAccessor.DBColumnInfo columnNameTo)` 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- USER
```
public static final String USER
```
  See Also:
  
  Constant Field Values
- PASSWORD
```
public static final String PASSWORD
```
  See Also:
  
  Constant Field Values
- NULL_CATALOG_MEANS_CURRENT
```
public static final String NULL_CATALOG_MEANS_CURRENT
```
  See Also:
  
  Constant Field Values
- TRUE
```
public static final String TRUE
```
  See Also:
  
  Constant Field Values
- SUPPORT_CONNECTOR_VERSION
```
public static final int SUPPORT_CONNECTOR_VERSION
```
  See Also:
  
  Constant Field Values

Constructor Detail

DBAccessorImpl

@Inject
public DBAccessorImpl(Configuration configuration)

Method Detail

loadHelper

protected DbmsHelper loadHelper(org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)

getConnection
```
public Connection getConnection()
```
Specified by:

getConnection in interface DBAccessor

Returns:

database connection

getNewConnection
```
public Connection getNewConnection()
```
Specified by:

getNewConnection in interface DBAccessor

Returns:

new database connection

quoteObjectName
```
public String quoteObjectName(String name)
```
Description copied from interface: DBAccessor

Wraps object name with dbms-specific quotes

Specified by:

quoteObjectName in interface DBAccessor

Parameters:

name - object name without quotes

Returns:

quoted name

createTable

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

Description copied from interface: DBAccessor

Create new table

Specified by:: createTable in interface DBAccessor
Throws:: SQLException

getDatabaseMetaData

protected DatabaseMetaData getDatabaseMetaData()
                                        throws SQLException

Throws:: SQLException

tableExists
```
public boolean tableExists(String tableName)
                    throws SQLException
```
Description copied from interface: DBAccessor

Verify if table exists by looking at metadata.

Specified by:

tableExists in interface DBAccessor

Parameters:

tableName - name of the table

Returns:

Throws:

SQLException

getDbType
```
public DBAccessor.DbType getDbType()
```
Description copied from interface: DBAccessor

Get type of database platform

Specified by:

getDbType in interface DBAccessor

Returns:

@DbType

getDbSchema
```
public String getDbSchema()
```
Description copied from interface: DBAccessor

Get database schema name

Specified by:

getDbSchema in interface DBAccessor

Returns:

@dbSchema

tableHasData
```
public boolean tableHasData(String tableName)
                     throws SQLException
```
Description copied from interface: DBAccessor

Verify if table has any data

Specified by:

tableHasData in interface DBAccessor

Returns:

Throws:

SQLException

tableHasColumn

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

Description copied from interface: DBAccessor

Verify if table already has a column defined.

Specified by:: tableHasColumn in interface DBAccessor
Returns:
Throws:: SQLException

tableHasColumn
```
public boolean tableHasColumn(String tableName,
                              String... columnName)
                       throws SQLException
```
Description copied from interface: DBAccessor

Verify if table already has a column defined.

Specified by:

tableHasColumn in interface DBAccessor

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
```
public boolean tableHasForeignKey(String tableName,
                                  String fkName)
                           throws SQLException
```
Description copied from interface: DBAccessor

Verify if table has a FK constraint.

Specified by:

tableHasForeignKey in interface DBAccessor

Returns:

true if FK with such name exists

Throws:

SQLException

getCheckedForeignKey

public String getCheckedForeignKey(String rawTableName,
                                   String rawForeignKeyName)
                            throws SQLException

Throws:: SQLException

tableHasForeignKey

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

Description copied from interface: DBAccessor

Verify if table already has a FK constraint.

Specified by:: tableHasForeignKey in interface DBAccessor
Returns:: true if described relation exists
Throws:: SQLException

tableHasForeignKey

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

Description copied from interface: DBAccessor

Verify if table already has a FK constraint.

Specified by:: tableHasForeignKey in interface DBAccessor
Returns:: true if described relation exists
Throws:: SQLException

tableHasIndex
```
public boolean tableHasIndex(String tableName,
                             boolean unique,
                             String indexName)
                      throws SQLException
```
Description copied from interface: DBAccessor

Check if index is already in scheme

Specified by:

tableHasIndex in interface DBAccessor

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

createIndex

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

Description copied from interface: DBAccessor

Create new index

Specified by:: createIndex in interface DBAccessor
Throws:: SQLException

createIndex
```
public void createIndex(String indexName,
                        String tableName,
                        boolean isUnique,
                        String... columnNames)
                 throws SQLException
```
Description copied from interface: DBAccessor

Create new index

Specified by:

createIndex in interface DBAccessor

Parameters:

indexName - The name of the index to be created

tableName - The database table the index to be created on

isUnique - Specifies whether unique index is to be created.

columnNames - The columns included into the index

Throws:

SQLException - Exception in case the index creation fails.

addFKConstraint

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

Description copied from interface: DBAccessor

Add foreign key for a relation

Specified by:: addFKConstraint in interface DBAccessor
Throws:: SQLException

addFKConstraint

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

Specified by:: addFKConstraint in interface DBAccessor
Throws:: SQLException

addFKConstraint

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

Description copied from interface: DBAccessor

Add foreign key for a relation

Specified by:: addFKConstraint in interface DBAccessor
Throws:: SQLException

addFKConstraint

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

Description copied from interface: DBAccessor

Add foreign key for a relation

Specified by:: addFKConstraint in interface DBAccessor
Throws:: SQLException

tableHasConstraint

public boolean tableHasConstraint(String tableName,
                                  String constraintName)
                           throws SQLException

Throws:: SQLException

addUniqueConstraint

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

Description copied from interface: DBAccessor

Add unique table constraint

Specified by:: addUniqueConstraint in interface DBAccessor
Parameters:: tableName - name of the table; constraintName - name of the constraint; columnNames - list of columns
Throws:: SQLException

updateUniqueConstraint

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

Description copied from interface: DBAccessor

Add unique table constraint

Specified by:: updateUniqueConstraint in interface DBAccessor
Parameters:: tableName - name of the table; constraintName - name of the constraint; columnNames - list of columns
Throws:: SQLException

addPKConstraint

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

Specified by:: addPKConstraint in interface DBAccessor
Parameters:: tableName - name of the table; constraintName - name of the constraint; ignoreErrors - true to ignore database errors; columnName - name of the column
Throws:: SQLException

addPKConstraint

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

Specified by:: addPKConstraint in interface DBAccessor
Parameters:: tableName - name of the table; constraintName - name of the constraint; columnName - name of the column
Throws:: SQLException

renameColumn

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

Description copied from interface: DBAccessor

Rename existing column

Specified by:: renameColumn in interface DBAccessor
Throws:: SQLException

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

Specified by:

addColumn in interface DBAccessor

Throws:

SQLException

alterColumn

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

Description copied from interface: DBAccessor

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

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

Specified by:: alterColumn in interface DBAccessor
Throws:: SQLException

updateTable

public void updateTable(String tableName,
                        DBAccessor.DBColumnInfo columnNameFrom,
                        DBAccessor.DBColumnInfo columnNameTo)
                 throws SQLException

Description copied from interface: DBAccessor

Simple update operation on table

Specified by:: updateTable in interface DBAccessor
Throws:: SQLException

insertRow

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

Description copied from interface: DBAccessor

Insert row into table

Specified by:: insertRow in interface DBAccessor
Returns:
Throws:: SQLException

insertRowIfMissing

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

Description copied from interface: DBAccessor

Conditionally insert row into table if it does not already exist

Specified by:: insertRowIfMissing in interface DBAccessor
Returns:
Throws:: SQLException

updateTable

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

Description copied from interface: DBAccessor

Simple update operation on table

Specified by:: updateTable in interface DBAccessor
Returns:
Throws:: SQLException

executeUpdate
```
public int executeUpdate(String query)
                  throws SQLException
```
Specified by:

executeUpdate in interface DBAccessor

Parameters:

query - update query

Returns:

same like java.sql.Statement

Throws:

SQLException

executeUpdate
```
public int executeUpdate(String query,
                         boolean ignoreErrors)
                  throws SQLException
```
Specified by:

executeUpdate in interface DBAccessor

Parameters:

query - update query

ignoreErrors - true to ignore errors

Returns:

same like java.sql.Statement

Throws:

SQLException

executeQuery

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

Description copied from interface: DBAccessor

Conditional ad-hoc query on DB

Specified by:: executeQuery in interface DBAccessor
Throws:: SQLException

executeQuery
```
public void executeQuery(String query)
                  throws SQLException
```
Description copied from interface: DBAccessor

Execute ad-hoc query on DB.

Specified by:

executeQuery in interface DBAccessor

Throws:

SQLException

executeQuery
```
public void executeQuery(String query,
                         boolean ignoreFailure)
                  throws SQLException
```
Description copied from interface: DBAccessor

Execute query on DB

Specified by:

executeQuery in interface DBAccessor

Throws:

SQLException

executePreparedQuery
```
public void executePreparedQuery(String query,
                                 Object... arguments)
                          throws SQLException
```
Execute prepared statements

Specified by:

executePreparedQuery in interface DBAccessor

Parameters:

query - query to execute

arguments - list of arguments for prepared statement

Throws:

SQLException

executePreparedQuery
```
public void executePreparedQuery(String query,
                                 boolean ignoreFailure,
                                 Object... arguments)
                          throws SQLException
```
Execute prepared update statements

Specified by:

executePreparedQuery in interface DBAccessor

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
```
public void executePreparedUpdate(String query,
                                  Object... arguments)
                           throws SQLException
```
Execute prepared update statements

Specified by:

executePreparedUpdate in interface DBAccessor

Parameters:

query - query to execute

arguments - list of arguments for prepared statement

Throws:

SQLException

executePreparedUpdate

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

Execute prepared statements which will not ignore failures

Specified by:: executePreparedUpdate in interface DBAccessor
Throws:: SQLException

dropTable
```
public void dropTable(String tableName)
               throws SQLException
```
Description copied from interface: DBAccessor

Drop table from schema

Specified by:

dropTable in interface DBAccessor

Throws:

SQLException

truncateTable
```
public void truncateTable(String tableName)
                   throws SQLException
```
Description copied from interface: DBAccessor

Delete all table data

Specified by:

truncateTable in interface DBAccessor

Throws:

SQLException

dropColumn

public void dropColumn(String tableName,
                       String columnName)
                throws SQLException

Description copied from interface: DBAccessor

Drop a column from table

Specified by:: dropColumn in interface DBAccessor
Throws:: SQLException

dropSequence
```
public void dropSequence(String sequenceName)
                  throws SQLException
```
Description copied from interface: DBAccessor

Drop sequence

Specified by:

dropSequence in interface DBAccessor

Throws:

SQLException

dropFKConstraint
```
public void dropFKConstraint(String tableName,
                             String constraintName)
                      throws SQLException
```
Description copied from interface: DBAccessor

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.

Specified by:

dropFKConstraint in interface DBAccessor

Parameters:

tableName - name of the table

constraintName - name of the constraint

Throws:

SQLException

dropFKConstraint

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

Drop a FK constraint from table

Specified by:: dropFKConstraint in interface DBAccessor
Parameters:: tableName - name of the table; constraintName - name of the constraint
Throws:: SQLException

dropUniqueConstraint

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

Description copied from interface: DBAccessor

Drop a unique constraint from table

Specified by:: dropUniqueConstraint in interface DBAccessor
Parameters:: tableName - name of the table; constraintName - name of the constraint
Throws:: SQLException

dropUniqueConstraint
```
public void dropUniqueConstraint(String tableName,
                                 String constraintName)
                          throws SQLException
```
Description copied from interface: DBAccessor

Drop a unique constraint from table

Specified by:

dropUniqueConstraint in interface DBAccessor

Parameters:

tableName - name of the table

constraintName - name of the constraint

Throws:

SQLException

dropPKConstraint
```
public void dropPKConstraint(String tableName,
                             String constraintName,
                             String columnName,
                             boolean cascade)
                      throws SQLException
```
Description copied from interface: DBAccessor

Drop a PK constraint from table

Specified by:

dropPKConstraint in interface DBAccessor

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

dropPKConstraint

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

Description copied from interface: DBAccessor

Drop a PK constraint from table

Specified by:: dropPKConstraint in interface DBAccessor; constraintName - name of the constraint; cascade - cascade delete
Throws:: SQLException

dropPKConstraint
```
public void dropPKConstraint(String tableName,
                             String constraintName,
                             boolean cascade)
                      throws SQLException
```
Description copied from interface: DBAccessor

Drop a PK constraint from table

Specified by:

dropPKConstraint in interface DBAccessor

Parameters:

tableName - name of the table

constraintName - name of the constraint

cascade - cascade delete

Throws:

SQLException

executeScript
```
public void executeScript(String filePath)
                   throws SQLException,
                          IOException
```
Execute script with autocommit and error tolerance, like psql and sqlplus do by default

Specified by:

executeScript in interface DBAccessor

Throws:

SQLException

IOException

getNewDatabaseSession
```
public org.eclipse.persistence.sessions.DatabaseSession getNewDatabaseSession()
```
Description copied from interface: DBAccessor

Get a new DB session

Specified by:

getNewDatabaseSession in interface DBAccessor

Returns:

tableHasPrimaryKey
```
public boolean tableHasPrimaryKey(String tableName,
                                  String columnName)
                           throws SQLException
```
Description copied from interface: DBAccessor

Table has primary key

Specified by:

tableHasPrimaryKey in interface DBAccessor

Parameters:

tableName - name of the table

columnName - name of the constraint, could be null

Returns:

true if constraint exists

Throws:

SQLException

getColumnType
```
public int getColumnType(String tableName,
                         String columnName)
                  throws SQLException
```
Description copied from interface: DBAccessor

Gets the column's SQL type

Specified by:

getColumnType in interface DBAccessor

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
```
public Class getColumnClass(String tableName,
                            String columnName)
                     throws SQLException,
                            ClassNotFoundException
```
Description copied from interface: DBAccessor

Get type class of the column

Specified by:

getColumnClass in interface DBAccessor

Parameters:

tableName - name of the table

columnName - name of the column

Returns:

type class of the column

Throws:

SQLException

ClassNotFoundException

isColumnNullable
```
public boolean isColumnNullable(String tableName,
                                String columnName)
                         throws SQLException
```
Description copied from interface: DBAccessor

Check if column could be nullable

Specified by:

isColumnNullable in interface DBAccessor

Parameters:

tableName - name of the table

columnName - name of the column

Returns:

true if column could be nullable

Throws:

SQLException

setColumnNullable
```
public void setColumnNullable(String tableName,
                              DBAccessor.DBColumnInfo columnInfo,
                              boolean nullable)
                       throws SQLException
```
Description copied from interface: DBAccessor

Sets the specified column to either allow or prohibit NULL.

Specified by:

setColumnNullable in interface DBAccessor

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

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

Specified by:: setColumnNullable in interface DBAccessor
Throws:: SQLException

changeColumnType

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

Description copied from interface: DBAccessor

Alter column wrapper, which handle DB specific type conversion

Specified by:: changeColumnType in interface DBAccessor
Parameters:: tableName - name of the table; columnName - name of the column; fromType - previous type; toType - new desired type
Throws:: SQLException

getColumnInfo
```
public DBAccessor.DBColumnInfo getColumnInfo(String tableName,
                                             String columnName)
```
Obtain column metadata information by given table and column name. Not able to return column default value.

Specified by:

getColumnInfo in interface DBAccessor

Parameters:

tableName - Name of the table

columnName - Name of the column

Returns:

Column information or null, if no column found

Throws:

SQLException

getIndexesList
```
public List<String> getIndexesList(String tableName,
                                   boolean unique)
                            throws SQLException
```
Description copied from interface: DBAccessor

Gets list of index names from database metadata

Specified by:

getIndexesList in interface DBAccessor

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

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

Specified by:

getPrimaryKeyConstraintName in interface DBAccessor

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

Specified by:

dropPKConstraint in interface DBAccessor

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
```
public void addDefaultConstraint(String tableName,
                                 DBAccessor.DBColumnInfo column)
                          throws SQLException
```
Adds a default constraint to an existing column.

Specified by:

addDefaultConstraint in interface DBAccessor

Parameters:

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

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

Throws:

SQLException

escapeParameter

public static String escapeParameter(Object value,
                                     org.eclipse.persistence.platform.database.DatabasePlatform databasePlatform)

copyColumnToAnotherTable

public 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

Specified by:: copyColumnToAnotherTable in interface DBAccessor
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

getIntColumnValues
```
public List<Integer> getIntColumnValues(String tableName,
                                        String columnName,
                                        String[] conditionColumnNames,
                                        String[] values,
                                        boolean ignoreFailure)
                                 throws SQLException
```
Execute select columnName from tableName where columnNames values = values

Specified by:

getIntColumnValues in interface DBAccessor

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

values - 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

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

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

Specified by:: getKeyToStringColumnMap in interface DBAccessor
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; values - 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

executeQuery
```
protected <T> T executeQuery(String tableName,
                             String[] requestedColumnNames,
                             String[] conditionColumnNames,
                             String[] conditionValues,
                             boolean ignoreFailure,
                             org.apache.ambari.server.orm.DBAccessorImpl.ResultGetter<T> resultGetter)
                      throws SQLException
```
Executes a query returning data as specified by the ResultGetter implementation.

Parameters:

tableName - the table name

requestedColumnNames - an array of column names 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)

resultGetter - a ResultGetter implementation used to format the data into the expected return value

Returns:

the result from the resultGetter

Throws:

SQLException

buildQuery
```
protected String buildQuery(String tableName,
                            String[] requestedColumnNames,
                            String[] conditionColumnNames,
                            String[] conditionValues)
                     throws SQLException
```
Build a SELECT statement using the supplied table name, request columns and conditional column/value pairs.
The conditional pairs are optional but multiple pairs will be ANDed together.
Examples:
- SELECT id FROM table1
- SELECT id FROM table1 WHERE name='value1'
- SELECT id FROM table1 WHERE name='value1' AND key='key1'
- SELECT id, name FROM table1 WHERE key='key1'
- SELECT id, name FROM table1 WHERE key='key1' AND allowed='1'
Parameters:

tableName - the table name

requestedColumnNames - an array of column names 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

Returns:

a query string

Throws:

SQLException

moveColumnToAnotherTable

public 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

Specified by:: moveColumnToAnotherTable in interface DBAccessor
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

clearTable
```
public void clearTable(String tableName)
                throws SQLException
```
Remove all rows from the table

Specified by:

clearTable in interface DBAccessor

Parameters:

tableName - name of the table

Throws:

SQLException

clearTableColumn

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

Reset all rows with value for columnName column

Specified by:: clearTableColumn in interface DBAccessor
Parameters:: tableName - name of the table; columnName -; value - data to use for update
Throws:: SQLException

Class DBAccessorImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ambari.server.orm.DBAccessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER

PASSWORD

NULL_CATALOG_MEANS_CURRENT

TRUE

SUPPORT_CONNECTOR_VERSION

Constructor Detail

DBAccessorImpl

Method Detail

loadHelper

getConnection

getNewConnection

quoteObjectName

createTable

getDatabaseMetaData

tableExists

getDbType

getDbSchema

tableHasData

tableHasColumn

tableHasColumn

tableHasForeignKey

getCheckedForeignKey

tableHasForeignKey

tableHasForeignKey

tableHasIndex

createIndex

createIndex

addFKConstraint

addFKConstraint

addFKConstraint

addFKConstraint

tableHasConstraint

addUniqueConstraint

updateUniqueConstraint

addPKConstraint

addPKConstraint

renameColumn

addColumn

alterColumn

updateTable

insertRow

insertRowIfMissing

updateTable

executeUpdate

executeUpdate

executeQuery

executeQuery

executeQuery

executePreparedQuery

executePreparedQuery

executePreparedUpdate

executePreparedUpdate

dropTable

truncateTable

dropColumn

dropSequence

dropFKConstraint

dropFKConstraint

dropUniqueConstraint

dropUniqueConstraint

dropPKConstraint

dropPKConstraint

dropPKConstraint

executeScript

getNewDatabaseSession

tableHasPrimaryKey

getColumnType

getColumnClass

isColumnNullable

setColumnNullable

setColumnNullable

changeColumnType