Package com.atlassian.bamboo.utils.db

Class AbstractDbmsBean

java.lang.Object

com.atlassian.bamboo.utils.db.AbstractDbmsBean

All Implemented Interfaces:

BambooDatabaseTypeProvider, DbmsBean

Direct Known Subclasses:

H2DbmsBean, MsSqlDbmsBean, MySqlDbmsBean, OracleDbmsBean, PostgreSqlDbmsBean

public abstract class AbstractDbmsBean
extends Object
implements DbmsBean

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.utils.db.DbmsBean

DbmsBean.ColumnDefinition, DbmsBean.ConstraintDefinition, DbmsBean.IndexDefinition

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LARGE_STRING_TYPE

Constructor Summary

Constructors

Constructor	Description
AbstractDbmsBean()

Method Summary

Modifier and Type	Method	Description
protected void	actuallyChangeColumnToNotNull(Connection c, String tableName, String columnName)
void	addColumn(Connection c, String tableName, String columnName, int columnType, Integer columnSize)	Add a column to a table.
protected void	changeColumnDefinition(Connection c, String table, String column, String sqlType, boolean isNullable)
void	changeColumnToNotNull(Connection c, String tableName, String columnName)	Changes column to not null, unless it's already not null.
void	changeColumnType(Connection c, String table, String column, int type, @Nullable Integer columnSize, boolean isNullable)	Changes column type to the new type (see Types.
void	changeTableNameToUpperCase(Connection connection, String oldName)	Rename table from lower case to upper case.
@NotNull String	clobEquals(@NotNull String columnName)	Comparison string for CLOB column.
void	createColumn(@NotNull Connection connection, @NotNull String tableName, @NotNull String columnName, @org.jetbrains.annotations.NotNull int columnType)
void	createIndex(Connection c, String index, String table, String column)
protected void	createPrimaryKey(Connection c, String table, String pkName, Collection<String> columns)
void	createUniqueConstraint(Connection c, String uniqueKey, String table, String... columns)	Create unique key
boolean	dropColumn(@NotNull Connection connection, @NotNull String tableName, @NotNull String columnName)	Checks whether given table contains the specified column and drops it Checks whether given table contains the specified column and drops it, as well as foreign key constraints and index on the column.
void	dropConstraint(Connection c, String tableName, String constraint)	Drop constraint
protected void	dropConstraints(Connection connection, String tableName, String columnName)
void	dropForeignKeyConstraint(Connection c, String tableName, String foreignKey)
void	dropIndex(Connection c, String table, String index)
boolean	dropIndexIfExists(Connection c, String table, @NotNull String indexName)	Tries to find index by name ignoring case and removes it if found.
void	dropTable(Connection c, String tableName)	Drop table.
protected @Nullable DbmsBean.ColumnDefinition	getColumnDefinition(Connection connection, String tableName, @Nullable String columnName)
String	getColumnDefinitionString(int columnType)
List<DbmsBean.ColumnDefinition>	getColumns(Connection c, @NotNull String table, @Nullable String column)
protected List<DbmsBean.ConstraintDefinition>	getConstraintDefinitions(Connection connection, String query, @Nullable String column, @Nullable Function<String,String> nullableNameProcessor)	Finds all constraints affecting given column.
protected DbmsBean.ConstraintDefinition.ConstraintType	getConstraintType(String typeName)
Set<String>	getIndexNames(@NotNull Connection c, @NotNull String table, @Nullable String column)	Returns indices set up on a given table, optionally narrowed down to a column.
Collection<DbmsBean.IndexDefinition>	getIndices(@NotNull Connection c, @NotNull String table)
String	getLargeTextTypeName()
@Nullable String	getSchema(Connection c)	Schema name, retrieved from connection or cache
protected @Nullable String	getSchemaUncached(Connection c)
protected @NotNull String	getSqlTypeName(int type)
List<String>	getTables(@NotNull Connection c)	Retrieves the list of table names in the current schema.
boolean	hasIndexOnColumns(Connection c, String tableName, List<String> columns)
boolean	isColumnPresent(@NotNull Connection connection, @NotNull String tableName, @NotNull String columnName)	Checks whether given table contains the specified column.
boolean	isColumnPresent(@NotNull Statement statement, @NotNull String tableName, @NotNull String columnName)	Checks whether given table contains the specified column.
protected boolean	isColumnPresent(Statement statement, String tableName, Predicate<String> columnNamePredicate)
boolean	isH2()
boolean	isMsSqlServer()
boolean	isMySql()
boolean	isOracle()
boolean	isPostgreSql()
protected boolean	isTable(List<String> definitionColumns)
boolean	isTablePresent(@NotNull Connection c, @NotNull String tableName)	Checks whether given table is present in the database
void	migrateColumnType(Connection c, String table, String column, int columnType, @Nullable Integer columnSize)	Changes column type to the new type (see Types.
protected DbmsBean.ColumnDefinition	newColumnDefinition(String columnName, int dataType, String dataTypeName, OptionalInt columnSize, Optional<Boolean> isNullable)
String	quote(String name)	Quotes the supplied name according to the quoting rules of the underlying DBMS.
protected String	quoteIfNeeded(String name)	Some tables in db can be stored in a case sensitive manner.
abstract void	renameColumn(Connection c, String tableName, String oldName, String newName)	Rename columns.
String	toLowerCase(String columnName)	Wraps column name with DB-specific toLowerCase function
protected String	unquoteIfNeeded(String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.persistence3.BambooDatabaseTypeProvider

getDatabaseType

Methods inherited from interface com.atlassian.bamboo.utils.db.DbmsBean

dropPrimaryKey, getCatalog, getConcat, getConstraints, getQuery, resizeVarcharColumn

Field Details

LARGE_STRING_TYPE

public static final int LARGE_STRING_TYPE

See Also:

• Constant Field Values

Constructor Details

AbstractDbmsBean

public AbstractDbmsBean()

Method Details

isColumnPresent

public boolean isColumnPresent(@NotNull
 @NotNull Connection connection,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull String columnName)
                        throws SQLException

Description copied from interface: DbmsBean

Checks whether given table contains the specified column.

Specified by:

isColumnPresent in interface DbmsBean

Returns:

true if given table contains the specified column or false when either column or table doesn't exist

Throws:

SQLException

isColumnPresent

public boolean isColumnPresent(@NotNull
 @NotNull Statement statement,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull String columnName)
                        throws SQLException

Description copied from interface: DbmsBean

Checks whether given table contains the specified column.

Specified by:

isColumnPresent in interface DbmsBean

Returns:

true if given table contains the specified column or false when either column or table doesn't exist

Throws:

SQLException

isColumnPresent

protected boolean isColumnPresent(Statement statement,
 String tableName,
 Predicate<String> columnNamePredicate)
                           throws SQLException

Throws:

SQLException

changeColumnType

public void changeColumnType(Connection c,
 String table,
 String column,
 int type,
 @Nullable
 @Nullable Integer columnSize,
 boolean isNullable)
                      throws SQLException

Description copied from interface: DbmsBean

Changes column type to the new type (see Types. Uses alter table, so won't cope with all type conversions.

Specified by:

changeColumnType in interface DbmsBean

Throws:

SQLException

getSqlTypeName

@NotNull
protected @NotNull String getSqlTypeName(int type)

getConstraintType

protected DbmsBean.ConstraintDefinition.ConstraintType getConstraintType(String typeName)

getConstraintDefinitions

protected List<DbmsBean.ConstraintDefinition> getConstraintDefinitions(Connection connection,
 String query,
 @Nullable
 @Nullable String column,
 @Nullable
 @Nullable Function<String,String> nullableNameProcessor)
                                                                throws SQLException

Finds all constraints affecting given column. Constraints affecting more than one column will be included.

Parameters:

connection -

query -

column -

Returns:

Throws:

SQLException

changeColumnDefinition

protected void changeColumnDefinition(Connection c,
 String table,
 String column,
 String sqlType,
 boolean isNullable)
                               throws SQLException

Throws:

SQLException

migrateColumnType

public void migrateColumnType(Connection c,
 String table,
 String column,
 int columnType,
 @Nullable
 @Nullable Integer columnSize)
                       throws SQLException

Description copied from interface: DbmsBean

Changes column type to the new type (see Types. Uses rename + add + copy + drop for maximum compatibility.

Specified by:

migrateColumnType in interface DbmsBean

Throws:

SQLException

dropColumn

public boolean dropColumn(@NotNull
 @NotNull Connection connection,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull String columnName)
                   throws SQLException

Description copied from interface: DbmsBean

Checks whether given table contains the specified column and drops it Checks whether given table contains the specified column and drops it, as well as foreign key constraints and index on the column. The method will automatically detect constraint names on DBMS that supports it or use provided names on DBMS that don't.

Specified by:

dropColumn in interface DbmsBean

Returns:

Throws:

SQLException

createColumn

public void createColumn(@NotNull
 @NotNull Connection connection,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull String columnName,
 @NotNull
 @org.jetbrains.annotations.NotNull int columnType)
                  throws SQLException

Specified by:

createColumn in interface DbmsBean

Throws:

SQLException

dropConstraints

protected void dropConstraints(Connection connection,
 String tableName,
 String columnName)

dropIndex

public void dropIndex(Connection c,
 String table,
 String index)
               throws SQLException

Specified by:

dropIndex in interface DbmsBean

Throws:

SQLException

dropIndexIfExists

public boolean dropIndexIfExists(Connection c,
 String table,
 @NotNull
 @NotNull String indexName)
                          throws SQLException

Description copied from interface: DbmsBean

Tries to find index by name ignoring case and removes it if found.

Specified by:

dropIndexIfExists in interface DbmsBean

Returns:

true if index was found

Throws:

SQLException

createIndex

public void createIndex(Connection c,
 String index,
 String table,
 String column)
                 throws SQLException

Specified by:

createIndex in interface DbmsBean

Throws:

SQLException

createUniqueConstraint

public void createUniqueConstraint(Connection c,
 String uniqueKey,
 String table,
 String... columns)
                            throws SQLException

Description copied from interface: DbmsBean

Create unique key

Specified by:

createUniqueConstraint in interface DbmsBean

Throws:

SQLException - if the operation fails (ie. key exists or data in the column is not unique)

isTablePresent

public boolean isTablePresent(@NotNull
 @NotNull Connection c,
 @NotNull
 @NotNull String tableName)
                       throws SQLException

Description copied from interface: DbmsBean

Checks whether given table is present in the database

Specified by:

isTablePresent in interface DbmsBean

Parameters:

c - connection used to verify DB table existence

tableName - name of DB table

Returns:

true if database is accessible and table exists, false otherwise

Throws:

SQLException - if a database error occurs or connection is closed

getTables

public List<String> getTables(@NotNull
 @NotNull Connection c)
                       throws SQLException

Description copied from interface: DbmsBean

Retrieves the list of table names in the current schema.

Specified by:

getTables in interface DbmsBean

Throws:

SQLException

isTable

protected boolean isTable(List<String> definitionColumns)

changeTableNameToUpperCase

public void changeTableNameToUpperCase(Connection connection,
 String oldName)
                                throws SQLException

Description copied from interface: DbmsBean

Rename table from lower case to upper case. No-op if database is table names are case insensitive.

Specified by:

changeTableNameToUpperCase in interface DbmsBean

Throws:

SQLException

renameColumn

public abstract void renameColumn(Connection c,
 String tableName,
 String oldName,
 String newName)
                           throws SQLException

Description copied from interface: DbmsBean

Rename columns.

Specified by:

renameColumn in interface DbmsBean

Throws:

SQLException

addColumn

public void addColumn(Connection c,
 String tableName,
 String columnName,
 int columnType,
 Integer columnSize)
               throws SQLException

Description copied from interface: DbmsBean

Add a column to a table.

Specified by:

addColumn in interface DbmsBean

Throws:

SQLException

dropConstraint

public void dropConstraint(Connection c,
 String tableName,
 String constraint)
                    throws SQLException

Description copied from interface: DbmsBean

Drop constraint

Specified by:

dropConstraint in interface DbmsBean

Throws:

SQLException - if constraint does not exist

dropForeignKeyConstraint

public void dropForeignKeyConstraint(Connection c,
 String tableName,
 String foreignKey)
                              throws SQLException

Specified by:

dropForeignKeyConstraint in interface DbmsBean

Throws:

SQLException

dropTable

public void dropTable(Connection c,
 String tableName)
               throws SQLException

Description copied from interface: DbmsBean

Drop table.

Specified by:

dropTable in interface DbmsBean

Throws:

SQLException

changeColumnToNotNull

public void changeColumnToNotNull(Connection c,
 String tableName,
 String columnName)
                           throws SQLException

Description copied from interface: DbmsBean

Changes column to not null, unless it's already not null.

Specified by:

changeColumnToNotNull in interface DbmsBean

Throws:

SQLException

actuallyChangeColumnToNotNull

protected void actuallyChangeColumnToNotNull(Connection c,
 String tableName,
 String columnName)
                                      throws SQLException

Throws:

SQLException

quote

public String quote(String name)

Description copied from interface: DbmsBean

Quotes the supplied name according to the quoting rules of the underlying DBMS.

Specified by:

quote in interface DbmsBean

clobEquals

@NotNull
public @NotNull String clobEquals(@NotNull
 @NotNull String columnName)

Description copied from interface: DbmsBean

Comparison string for CLOB column.

Specified by:

clobEquals in interface DbmsBean

Parameters:

columnName - column name

Returns:

string for prepared statement

quoteIfNeeded

protected String quoteIfNeeded(String name)

Some tables in db can be stored in a case sensitive manner. Then ala == ALA != "Ala" != "alA". This method ensures that the names leaving this bean can be used in a non-ambigous manner.

unquoteIfNeeded

protected String unquoteIfNeeded(String name)

getIndexNames

public Set<String> getIndexNames(@NotNull
 @NotNull Connection c,
 @NotNull
 @NotNull String table,
 @Nullable
 @Nullable String column)
                          throws SQLException

Description copied from interface: DbmsBean

Returns indices set up on a given table, optionally narrowed down to a column. For H2, it will also return implicit indices set up to support FK relationships. For SQL Server, it will return implicit PK indices. Case of returned index names is database specific - all comparisons should be case-independent.

Specified by:

getIndexNames in interface DbmsBean

Throws:

SQLException

hasIndexOnColumns

public boolean hasIndexOnColumns(Connection c,
 String tableName,
 List<String> columns)
                          throws SQLException

Specified by:

hasIndexOnColumns in interface DbmsBean

Throws:

SQLException

getIndices

public Collection<DbmsBean.IndexDefinition> getIndices(@NotNull
 @NotNull Connection c,
 @NotNull
 @NotNull String table)
                                                throws SQLException

Specified by:

getIndices in interface DbmsBean

Throws:

SQLException

getColumns

public List<DbmsBean.ColumnDefinition> getColumns(Connection c,
 @NotNull
 @NotNull String table,
 @Nullable
 @Nullable String column)
                                           throws SQLException

Specified by:

getColumns in interface DbmsBean

Throws:

SQLException

createPrimaryKey

protected void createPrimaryKey(Connection c,
 String table,
 String pkName,
 Collection<String> columns)
                         throws SQLException

Throws:

SQLException

newColumnDefinition

protected DbmsBean.ColumnDefinition newColumnDefinition(String columnName,
 int dataType,
 String dataTypeName,
 OptionalInt columnSize,
 Optional<Boolean> isNullable)

getColumnDefinition

@Nullable
protected @Nullable DbmsBean.ColumnDefinition getColumnDefinition(Connection connection,
 String tableName,
 @Nullable
 @Nullable String columnName)
                                                           throws SQLException

Throws:

SQLException

getSchema

@Nullable
public @Nullable String getSchema(Connection c)
                           throws SQLException

Description copied from interface: DbmsBean

Schema name, retrieved from connection or cache

Specified by:

getSchema in interface DbmsBean

Returns:

schema name

Throws:

SQLException

getSchemaUncached

@Nullable
protected @Nullable String getSchemaUncached(Connection c)
                                      throws SQLException

Throws:

SQLException

getLargeTextTypeName

public String getLargeTextTypeName()

Specified by:

getLargeTextTypeName in interface DbmsBean

getColumnDefinitionString

public String getColumnDefinitionString(int columnType)

Specified by:

getColumnDefinitionString in interface DbmsBean

toLowerCase

public String toLowerCase(String columnName)

Wraps column name with DB-specific toLowerCase function

Specified by:

toLowerCase in interface DbmsBean

isH2

public boolean isH2()

Specified by:

isH2 in interface DbmsBean

Returns:

true if db configured in Hibernate is H2

isMsSqlServer

public boolean isMsSqlServer()

Specified by:

isMsSqlServer in interface DbmsBean

Returns:

true if db configured in Hibernate is Microsoft SQL Server

isMySql

public boolean isMySql()

Specified by:

isMySql in interface DbmsBean

Returns:

true if db configured in Hibernate is MySQL

isOracle

public boolean isOracle()

Specified by:

isOracle in interface DbmsBean

Returns:

true if db configured in Hibernate is Oracle

isPostgreSql

public boolean isPostgreSql()

Specified by:

isPostgreSql in interface DbmsBean

Returns:

true if db configured in Hibernate is PostgreSQL