Package com.ibm.fhir.database.utils.common

Class CommonDatabaseAdapter

java.lang.Object

com.ibm.fhir.database.utils.common.CommonDatabaseAdapter

All Implemented Interfaces:

IDatabaseAdapter, IDatabaseTypeAdapter

Direct Known Subclasses:

Db2Adapter, DerbyAdapter, PostgresAdapter

public abstract class CommonDatabaseAdapter
extends Object
implements IDatabaseAdapter, IDatabaseTypeAdapter

Provides schema control functions common to our supported databases (DB2 and Derby)

Field Summary

Fields

Modifier and Type	Field	Description
protected IConnectionProvider	connectionProvider
protected IDatabaseTarget	target

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommonDatabaseAdapter()	Constructor used by AddColumn only for getting DB type specific column name.
protected	CommonDatabaseAdapter(IConnectionProvider cp, IDatabaseTranslator dt)	Public constructor for when we're using a connection provider
protected	CommonDatabaseAdapter(IDatabaseTarget tgt, IDatabaseTranslator dt)	Protected constructor

Method Summary

Modifier and Type	Method	Description
void	addNewTenantPartitions(Collection<Table> tables, String schemaName, int newTenantId)	Add a new tenant partition to each of the tables in the collection.
int	allocateTenant(String adminSchemaName, String schemaName, String tenantName, String tenantKey, String tenantSalt, String idSequenceName)	Allocate a new tenant
void	alterSequenceRestartWith(String schemaName, String sequenceName, long restartWith, int cache, int incrementBy)	Sets/resets the sequence to start with the given value.
void	alterTableAddColumn(String schemaName, String tableName, ColumnBase column)	Add a new column to an existing table
void	alterTableColumnIdentityCache(String schemaName, String tableName, String columnName, int cache)	Change the CACHE value of the named identity generated always column
protected String	buildColumns(List<ColumnBase> columns, IdentityDef identity)	Build the list of columns in the create table statement
protected String	buildCreateTableStatement(String schema, String name, List<ColumnBase> columns, PrimaryKeyDef pkDef, IdentityDef identity, String tablespaceName, List<With> withs, List<CheckConstraint> checkConstraints)	Generate a create table statement suitable for Derby
void	createForeignKeyConstraint(String constraintName, String schemaName, String name, String targetSchema, String targetTable, String targetColumnName, String tenantColumnName, List<String> columns, boolean enforced)
void	createIndex(String schemaName, String tableName, String indexName, String tenantColumnName, List<OrderedColumnDef> indexColumns)
void	createOrReplaceFunction(String schemaName, String functionName, Supplier<String> supplier)	creates or replaces the SQL function
void	createOrReplaceProcedure(String schemaName, String procedureName, Supplier<String> supplier)	Create the stored procedure using the DDL text provided by the supplier
void	createOrReplaceView(String schemaName, String viewName, String selectClause)	Create or replace the view
void	createSequence(String schemaName, String sequenceName, long startWith, int cache, int incrementBy)
void	createUniqueConstraint(String constraintName, List<String> columns, String schemaName, String name)	create a unique constraint on a table.
void	createUniqueIndex(String schemaName, String tableName, String indexName, String tenantColumnName, List<OrderedColumnDef> indexColumns)
void	createUniqueIndex(String schemaName, String tableName, String indexName, String tenantColumnName, List<OrderedColumnDef> indexColumns, List<String> includeColumns)
void	createView(String schemaName, String viewName, String selectClause)	Create the view as defined by the selectClause
void	deleteTenantMeta(String adminSchemaName, int tenantId)	Delete all the metadata associated with the given tenant identifier, as long as the tenant status is DROPPED.
void	dropForeignKey(String schemaName, String tableName, String constraintName)	Drop the FK on the table with the given constraint name
void	dropFunction(String schemaName, String functionName)	drops a given function
void	dropIndex(String schemaName, String indexName)	Drop the named index
void	dropPermission(String schemaName, String permissionName)	Drop permission object from the schema
void	dropProcedure(String schemaName, String procedureName)	Drop the given procedure
void	dropSequence(String schemaName, String sequenceName)
void	dropTable(String schemaName, String tableName)	Drop table from the schema
void	dropVariable(String schemaName, String variableName)
void	dropView(String schemaName, String viewName)	Drop the view from the database
int	findTenantId(String adminSchemaName, String tenantName)	Get the tenant id for the given schema and tenant name
String	getQualifiedName(String schemaName, String objectName)	Return the fully qualified name in the form "SCHEMA.OBJECT" Validates that both schema and object names are valid
IDatabaseTranslator	getTranslator()	Get the IDatabaseTranslator associated with this adapter
void	grantFunctionPrivileges(String schemaName, String functionName, Collection<Privilege> privileges, String toUser)	grants permissions on a given function
void	grantObjectPrivileges(String schemaName, String tableName, Collection<Privilege> privileges, String toUser)	Grant the list of privileges on the named object to the user.
void	grantProcedurePrivileges(String schemaName, String procedureName, Collection<Privilege> privileges, String toUser)	Grant the collection of privileges on the named procedure to the user
void	grantSequencePrivileges(String schemaName, String variableName, Collection<Privilege> privileges, String toUser)	Grant the collection of privileges on the named variable to the user
void	grantVariablePrivileges(String schemaName, String variableName, Collection<Privilege> privileges, String toUser)	Grant the collection of privileges on the named variable to the user
protected List<OrderedColumnDef>	prefixTenantColumn(String tenantColumnName, List<OrderedColumnDef> columns)	Prefix the tenantColumnName to the list of columns, or do nothing if tenantColumnName is null
void	reorgTable(String schemaName, String tableName)	Reorg the table if the underlying database supports it.
void	runStatement(IDatabaseStatement stmt)	Run the statement using the connectionProvider to obtain a new connection.
<T> T	runStatement(IDatabaseSupplier<T> supplier)	Run the given supplier statement against the database represented by this adapter
protected void	runStatement(String ddl)	Execute the statement on a connection managed by our connection provider
void	updateTenantStatus(String adminSchemaName, int tenantId, TenantStatus status)	Update the tenant status

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.fhir.database.utils.api.IDatabaseAdapter

activateRowAccessControl, checkCompatibility, createArrType, createIntVariable, createOrReplacePermission, createRowType, createSchema, createTable, createTablespace, createTablespace, createTenantPartitions, deactivateRowAccessControl, detachPartition, disableForeignKey, doesTableExist, dropDetachedPartitions, dropTablespace, dropTenantTablespace, dropType, enableForeignKey, listSchemaObjects, removeTenantPartitions, setIntegrityOff, setIntegrityUnchecked, setIntVariable, useSessionVariable

Methods inherited from interface com.ibm.fhir.database.utils.api.IDatabaseTypeAdapter

blobClause, clobClause, doubleClause, timestampClause, varbinaryClause, varcharClause

Field Detail

target

protected final IDatabaseTarget target

connectionProvider

protected final IConnectionProvider connectionProvider

Constructor Detail

CommonDatabaseAdapter

protected CommonDatabaseAdapter(IDatabaseTarget tgt,
                                IDatabaseTranslator dt)

Protected constructor

Parameters:

tgt - database targeted

dt - the translator for this type of database

CommonDatabaseAdapter

protected CommonDatabaseAdapter(IConnectionProvider cp,
                                IDatabaseTranslator dt)

Public constructor for when we're using a connection provider

Parameters:

cp -

dt -

CommonDatabaseAdapter

protected CommonDatabaseAdapter()

Constructor used by AddColumn only for getting DB type specific column name.

Method Detail

getTranslator

public IDatabaseTranslator getTranslator()

Description copied from interface: IDatabaseAdapter

Get the IDatabaseTranslator associated with this adapter

Specified by:

getTranslator in interface IDatabaseAdapter

Returns:

buildColumns

protected String buildColumns(List<ColumnBase> columns,
                              IdentityDef identity)

Build the list of columns in the create table statement

buildCreateTableStatement

protected String buildCreateTableStatement(String schema,
                                           String name,
                                           List<ColumnBase> columns,
                                           PrimaryKeyDef pkDef,
                                           IdentityDef identity,
                                           String tablespaceName,
                                           List<With> withs,
                                           List<CheckConstraint> checkConstraints)

Generate a create table statement suitable for Derby

Parameters:

schema -

name -

columns -

pkDef -

tablespaceName -

withs - the list of table metadata parameters

Returns:

createUniqueIndex

public void createUniqueIndex(String schemaName,
                              String tableName,
                              String indexName,
                              String tenantColumnName,
                              List<OrderedColumnDef> indexColumns,
                              List<String> includeColumns)

Specified by:

createUniqueIndex in interface IDatabaseAdapter

createUniqueIndex

public void createUniqueIndex(String schemaName,
                              String tableName,
                              String indexName,
                              String tenantColumnName,
                              List<OrderedColumnDef> indexColumns)

Specified by:

createUniqueIndex in interface IDatabaseAdapter

createIndex

public void createIndex(String schemaName,
                        String tableName,
                        String indexName,
                        String tenantColumnName,
                        List<OrderedColumnDef> indexColumns)

Specified by:

createIndex in interface IDatabaseAdapter

prefixTenantColumn

protected List<OrderedColumnDef> prefixTenantColumn(String tenantColumnName,
                                                    List<OrderedColumnDef> columns)

Prefix the tenantColumnName to the list of columns, or do nothing if tenantColumnName is null

Parameters:

tenantColumnName -

columns -

Returns:

runStatement

protected void runStatement(String ddl)

Execute the statement on a connection managed by our connection provider

Parameters:

ddl -

getQualifiedName

public String getQualifiedName(String schemaName,
                               String objectName)

Return the fully qualified name in the form "SCHEMA.OBJECT" Validates that both schema and object names are valid

Parameters:

schemaName -

objectName -

Returns:

the fully qualified name

Throws:

IllegalArgumentException - if either name is not a valid database object name

dropTable

public void dropTable(String schemaName,
                      String tableName)

Description copied from interface: IDatabaseAdapter

Drop table from the schema

Specified by:

dropTable in interface IDatabaseAdapter

dropProcedure

public void dropProcedure(String schemaName,
                          String procedureName)

Description copied from interface: IDatabaseAdapter

Drop the given procedure

Specified by:

dropProcedure in interface IDatabaseAdapter

dropFunction

public void dropFunction(String schemaName,
                         String functionName)

Description copied from interface: IDatabaseAdapter

drops a given function

Specified by:

dropFunction in interface IDatabaseAdapter

dropPermission

public void dropPermission(String schemaName,
                           String permissionName)

Description copied from interface: IDatabaseAdapter

Drop permission object from the schema

Specified by:

dropPermission in interface IDatabaseAdapter

dropVariable

public void dropVariable(String schemaName,
                         String variableName)

Specified by:

dropVariable in interface IDatabaseAdapter

createForeignKeyConstraint

public void createForeignKeyConstraint(String constraintName,
                                       String schemaName,
                                       String name,
                                       String targetSchema,
                                       String targetTable,
                                       String targetColumnName,
                                       String tenantColumnName,
                                       List<String> columns,
                                       boolean enforced)

Specified by:

createForeignKeyConstraint in interface IDatabaseAdapter

createUniqueConstraint

public void createUniqueConstraint(String constraintName,
                                   List<String> columns,
                                   String schemaName,
                                   String name)

Description copied from interface: IDatabaseAdapter

create a unique constraint on a table.

Specified by:

createUniqueConstraint in interface IDatabaseAdapter

allocateTenant

public int allocateTenant(String adminSchemaName,
                          String schemaName,
                          String tenantName,
                          String tenantKey,
                          String tenantSalt,
                          String idSequenceName)

Description copied from interface: IDatabaseAdapter

Allocate a new tenant

Specified by:

allocateTenant in interface IDatabaseAdapter

Returns:

updateTenantStatus

public void updateTenantStatus(String adminSchemaName,
                               int tenantId,
                               TenantStatus status)

Update the tenant status

Specified by:

updateTenantStatus in interface IDatabaseAdapter

Parameters:

adminSchemaName -

tenantId -

status -

addNewTenantPartitions

public void addNewTenantPartitions(Collection<Table> tables,
                                   String schemaName,
                                   int newTenantId)

Add a new tenant partition to each of the tables in the collection. Idempotent, so can be run to add partitions for existing tenants to new tables

Specified by:

addNewTenantPartitions in interface IDatabaseAdapter

Parameters:

tables -

schemaName -

newTenantId -

runStatement

public void runStatement(IDatabaseStatement stmt)

Run the statement using the connectionProvider to obtain a new connection. Also, there should be a transaction open on the current thread at this time

Specified by:

runStatement in interface IDatabaseAdapter

Parameters:

stmt -

runStatement

public <T> T runStatement(IDatabaseSupplier<T> supplier)

Description copied from interface: IDatabaseAdapter

Run the given supplier statement against the database represented by this adapter

Specified by:

runStatement in interface IDatabaseAdapter

Returns:

createOrReplaceProcedure

public void createOrReplaceProcedure(String schemaName,
                                     String procedureName,
                                     Supplier<String> supplier)

Description copied from interface: IDatabaseAdapter

Create the stored procedure using the DDL text provided by the supplier

Specified by:

createOrReplaceProcedure in interface IDatabaseAdapter

createOrReplaceFunction

public void createOrReplaceFunction(String schemaName,
                                    String functionName,
                                    Supplier<String> supplier)

Description copied from interface: IDatabaseAdapter

creates or replaces the SQL function

Specified by:

createOrReplaceFunction in interface IDatabaseAdapter

createSequence

public void createSequence(String schemaName,
                           String sequenceName,
                           long startWith,
                           int cache,
                           int incrementBy)

Specified by:

createSequence in interface IDatabaseAdapter

startWith - the START WITH value for the sequence

cache - the sequence CACHE value

dropSequence

public void dropSequence(String schemaName,
                         String sequenceName)

Specified by:

dropSequence in interface IDatabaseAdapter

alterSequenceRestartWith

public void alterSequenceRestartWith(String schemaName,
                                     String sequenceName,
                                     long restartWith,
                                     int cache,
                                     int incrementBy)

Description copied from interface: IDatabaseAdapter

Sets/resets the sequence to start with the given value.

Specified by:

alterSequenceRestartWith in interface IDatabaseAdapter

alterTableColumnIdentityCache

public void alterTableColumnIdentityCache(String schemaName,
                                          String tableName,
                                          String columnName,
                                          int cache)

Description copied from interface: IDatabaseAdapter

Change the CACHE value of the named identity generated always column

Specified by:

alterTableColumnIdentityCache in interface IDatabaseAdapter

dropForeignKey

public void dropForeignKey(String schemaName,
                           String tableName,
                           String constraintName)

Description copied from interface: IDatabaseAdapter

Drop the FK on the table with the given constraint name

Specified by:

dropForeignKey in interface IDatabaseAdapter

findTenantId

public int findTenantId(String adminSchemaName,
                        String tenantName)

Description copied from interface: IDatabaseAdapter

Get the tenant id for the given schema and tenant name

Specified by:

findTenantId in interface IDatabaseAdapter

Returns:

grantObjectPrivileges

public void grantObjectPrivileges(String schemaName,
                                  String tableName,
                                  Collection<Privilege> privileges,
                                  String toUser)

Description copied from interface: IDatabaseAdapter

Grant the list of privileges on the named object to the user. This is a general purpose method which can be used to specify privileges for any object type which doesn't need the object type to be specified in the grant DDL.

Specified by:

grantObjectPrivileges in interface IDatabaseAdapter

grantProcedurePrivileges

public void grantProcedurePrivileges(String schemaName,
                                     String procedureName,
                                     Collection<Privilege> privileges,
                                     String toUser)

Description copied from interface: IDatabaseAdapter

Grant the collection of privileges on the named procedure to the user

Specified by:

grantProcedurePrivileges in interface IDatabaseAdapter

grantFunctionPrivileges

public void grantFunctionPrivileges(String schemaName,
                                    String functionName,
                                    Collection<Privilege> privileges,
                                    String toUser)

Description copied from interface: IDatabaseAdapter

grants permissions on a given function

Specified by:

grantFunctionPrivileges in interface IDatabaseAdapter

grantVariablePrivileges

public void grantVariablePrivileges(String schemaName,
                                    String variableName,
                                    Collection<Privilege> privileges,
                                    String toUser)

Description copied from interface: IDatabaseAdapter

Grant the collection of privileges on the named variable to the user

Specified by:

grantVariablePrivileges in interface IDatabaseAdapter

grantSequencePrivileges

public void grantSequencePrivileges(String schemaName,
                                    String variableName,
                                    Collection<Privilege> privileges,
                                    String toUser)

Description copied from interface: IDatabaseAdapter

Grant the collection of privileges on the named variable to the user

Specified by:

grantSequencePrivileges in interface IDatabaseAdapter

deleteTenantMeta

public void deleteTenantMeta(String adminSchemaName,
                             int tenantId)

Description copied from interface: IDatabaseAdapter

Delete all the metadata associated with the given tenant identifier, as long as the tenant status is DROPPED.

Specified by:

deleteTenantMeta in interface IDatabaseAdapter

dropIndex

public void dropIndex(String schemaName,
                      String indexName)

Description copied from interface: IDatabaseAdapter

Drop the named index

Specified by:

dropIndex in interface IDatabaseAdapter

dropView

public void dropView(String schemaName,
                     String viewName)

Description copied from interface: IDatabaseAdapter

Drop the view from the database

Specified by:

dropView in interface IDatabaseAdapter

createOrReplaceView

public void createOrReplaceView(String schemaName,
                                String viewName,
                                String selectClause)

Description copied from interface: IDatabaseAdapter

Create or replace the view

Specified by:

createOrReplaceView in interface IDatabaseAdapter

createView

public void createView(String schemaName,
                       String viewName,
                       String selectClause)

Description copied from interface: IDatabaseAdapter

Create the view as defined by the selectClause

Specified by:

createView in interface IDatabaseAdapter

alterTableAddColumn

public void alterTableAddColumn(String schemaName,
                                String tableName,
                                ColumnBase column)

Description copied from interface: IDatabaseAdapter

Add a new column to an existing table

Specified by:

alterTableAddColumn in interface IDatabaseAdapter

reorgTable

public void reorgTable(String schemaName,
                       String tableName)

Description copied from interface: IDatabaseAdapter

Reorg the table if the underlying database supports it. Required after columns are added/removed from a table.

Specified by:

reorgTable in interface IDatabaseAdapter