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

Method Summary

Modifier and Type	Method and Description
void	addColumn(String tableName, DBAccessor.DBColumnInfo columnInfo) Add column to existing table
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 keyColumn, String referenceTableName, String referenceColumn, boolean ignoreFailure) Add foreign key for a relation
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	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	dropConstraint(String tableName, String constraintName) Drop a constraint from table
void	dropConstraint(String tableName, String constraintName, boolean ignoreFailure) Drop a constraint from table
void	dropSequence(String sequenceName) Drop sequence
void	dropTable(String tableName) Drop table from schema
void	executeQuery(String query) Execute ad-hoc query on DB.
void	executeQuery(String query, boolean ignoreFailure) Execute query on DB
void	executeScript(String filePath) Helper method to run third party scripts like Quartz DDL
ResultSet	executeSelect(String query) Execute select query
org.eclipse.persistence.sessions.DatabaseSession	getNewDatabaseSession() Get a new DB session
boolean	insertRow(String tableName, String[] columnNames, String[] values, boolean ignoreFailure) Insert row into table
void	renameColumn(String tableName, String oldColumnName, DBAccessor.DBColumnInfo columnInfo) Rename existing column
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	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.
void	truncateTable(String tableName) Delete all table data
int	updateTable(String tableName, String columnName, Object value, String whereClause) Simple update operation on table

Method Detail

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

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[] keyColumns,
                     String referenceTableName,
                     String[] referenceColumns,
                     boolean ignoreFailure)
              throws SQLException

Add foreign key for a relation

Parameters:

tableName -

constraintName -

keyColumn -

referenceColumn -

Throws:

SQLException

addColumn

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

Add column to existing table

Parameters:

tableName -

columnInfo -

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

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

executeScript

void executeScript(String filePath)
            throws SQLException,
                   IOException

Helper method to run third party scripts like Quartz DDL

Parameters:

filePath -

Throws:

SQLException

IOException

executeQuery

void executeQuery(String query)
           throws SQLException

Execute ad-hoc query on DB.

Parameters:

query -

Throws:

SQLException

executeSelect

ResultSet executeSelect(String query)
                 throws SQLException

Execute select query

Parameters:

query -

Returns:

Throws:

SQLException

executeQuery

void executeQuery(String query,
                  boolean ignoreFailure)
           throws SQLException

Execute query on DB

Parameters:

query -

ignoreFailure -

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

dropConstraint

void dropConstraint(String tableName,
                    String constraintName)
             throws SQLException

Drop a constraint from table

Parameters:

tableName -

constraintName -

Throws:

SQLException

dropConstraint

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

Drop a constraint from table

Parameters:

tableName -

constraintName -

Throws:

SQLException

tableExists

boolean tableExists(String tableName)
             throws SQLException

Verify if table exists by looking at metadata.

Parameters:

tableName -

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

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: