Package com.ibm.fhir.database.utils.db2

Class Db2Adapter

java.lang.Object

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

com.ibm.fhir.database.utils.db2.Db2Adapter

All Implemented Interfaces:

IDatabaseAdapter, IDatabaseTypeAdapter

public class Db2Adapter
extends CommonDatabaseAdapter

Implementation of our database adapter which provides implementation of control functions specific to DB2 for things like schema and partition management

Field Summary

Fields inherited from class com.ibm.fhir.database.utils.common.CommonDatabaseAdapter

connectionProvider, target

Constructor Summary

Constructors

Constructor	Description
Db2Adapter()
Db2Adapter(IConnectionProvider cp)
Db2Adapter(IDatabaseTarget tgt)	Public constructor

Method Summary

Modifier and Type	Method	Description
void	activateRowAccessControl(String schemaName, String tableName)	ALTER TABLE ACTIVATE ROW ACCESS CONTROL
String	blobClause(long size, int inlineSize)	Generate a clause for BLOB (with an inline size if supported)
boolean	checkCompatibility(String adminSchema)	checks connectivity to the database and that it is compatible
void	createArrType(String schemaName, String typeName, String valueType, int arraySize)	Create ARRAY type used for passing values to stored procedures e.g.: CREATE OR REPLACE TYPE .t_str_values_arr AS .t_str_values ARRAY[256]
void	createIntVariable(String schemaName, String variableName)	CREATE VARIABLE ptng.session_tenant INT DEFAULT NULL;
void	createOrReplacePermission(String schemaName, String permissionName, String tableName, String predicate)	CREATE OR REPLACE PERMISSION ROW_ACCESS ON ptng.patients FOR ROWS WHERE patients.mt_id = ptng.session_tenant ENFORCED FOR ALL ACCESS ENABLE;
void	createOrReplaceProcedure(String schemaName, String procedureName, Supplier<String> supplier)	Create the stored procedure using the DDL text provided by the supplier
void	createRowType(String schemaName, String typeName, List<ColumnBase> columns)	Create ROW type used for passing values to stored procedures e.g.:
void	createSchema(String schemaName)	Create a database schema
void	createTable(String schemaName, String name, String tenantColumnName, List<ColumnBase> columns, PrimaryKeyDef primaryKey, IdentityDef identity, String tablespaceName)	Build the create table DDL
void	createTablespace(String tablespaceName)	Create a new tablespace with the given name
void	createTablespace(String tablespaceName, int extentSizeKB)	Create a new tablespace using the given extent size
void	createTenantPartitions(Collection<Table> tables, String schemaName, int newTenantId, int extentSizeKB)	Create the partitions on each of these tables
void	createTenantPartitionsThr(Table t, PartitionInfo pi, int newTenantId, String tablespaceName)	Ensure that the given table has all the partitions necessary up to and including the max tenant id
void	deactivateRowAccessControl(String schemaName, String tableName)	Deactivate row access control on a table ALTER TABLE DEACTIVATE ROW ACCESS CONTROL
void	detachPartition(String schemaName, String tableName, String partitionName, String intoTableName)	Detach the partition
void	disableForeignKey(String schemaName, String tableName, String constraintName)	Disable the FK with the given constraint name
boolean	doesTableExist(String schemaName, String tableName)	Check if the table currently exists
void	dropDetachedPartitions(Collection<Table> tables, String schemaName, int tenantId)	Drop the tables which were created by the detach partition operation (as part of tenant deprovisioning).
void	dropProcedure(String schemaName, String procedureName)	Drop the given procedure
void	dropTablespace(String tablespaceName)	Drop an existing tablespace, including all of its contents
void	dropTenantTablespace(int tenantId)	Drop the tablespace associated with the given tenantId
void	dropType(String schemaName, String typeName)	Drop the type object from the schema
void	enableForeignKey(String schemaName, String tableName, String constraintName)	Enable the FK with the given constraint name
protected void	loadPartitionInfoMap(Map<String,PartitionInfo> partitionInfoMap, String tableSchema)	Read partition info from the database catalog.
void	removeTenantPartitions(Collection<Table> tables, String schemaName, int tenantId)	Detach the partition associated with the tenantId from each of the given tables
void	runStatement(IDatabaseStatement stmt)	Run the statement using the connectionProvider to obtain a new connection.
void	setIntegrityOff(String schemaName, String tableName)
void	setIntegrityUnchecked(String schemaName, String tableName)
void	setIntVariable(String schemaName, String variableName, int value)	Build the DML statement for setting a session variable
boolean	useSessionVariable()
String	varbinaryClause(int size)	Generate a clause for binary data type
String	varcharClause(int size)	Generate a clause for VARCHAR

Methods inherited from class com.ibm.fhir.database.utils.common.CommonDatabaseAdapter

allocateTenant, alterSequenceRestartWith, alterTableColumnIdentityCache, buildColumns, buildCreateTableStatement, createForeignKeyConstraint, createIndex, createOrReplaceFunction, createSequence, createUniqueConstraint, createUniqueIndex, createUniqueIndex, deleteTenantMeta, dropFunction, dropIndex, dropPermission, dropSequence, dropTable, dropVariable, findTenantId, getQualifiedName, getTranslator, grantFunctionPrivileges, grantObjectPrivileges, grantProcedurePrivileges, grantSequencePrivileges, grantVariablePrivileges, prefixTenantColumn, runStatement, runStatement, updateTenantStatus

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

clobClause, doubleClause, timestampClause

Constructor Detail

Db2Adapter

public Db2Adapter(IDatabaseTarget tgt)

Public constructor

Parameters:

tgt - the target database we want to manage

Db2Adapter

public Db2Adapter(IConnectionProvider cp)

Db2Adapter

public Db2Adapter()

Method Detail

createTable

public void createTable(String schemaName,
                        String name,
                        String tenantColumnName,
                        List<ColumnBase> columns,
                        PrimaryKeyDef primaryKey,
                        IdentityDef identity,
                        String tablespaceName)

Description copied from interface: IDatabaseAdapter

Build the create table DDL

tenantColumnName - optional column name to enable multi-tenancy

createIntVariable

public void createIntVariable(String schemaName,
                              String variableName)

Description copied from interface: IDatabaseAdapter

 CREATE VARIABLE ptng.session_tenant INT DEFAULT NULL;
 

createOrReplacePermission

public void createOrReplacePermission(String schemaName,
                                      String permissionName,
                                      String tableName,
                                      String predicate)

Description copied from interface: IDatabaseAdapter

 CREATE OR REPLACE PERMISSION ROW_ACCESS ON ptng.patients FOR ROWS WHERE patients.mt_id =
 ptng.session_tenant ENFORCED FOR ALL ACCESS ENABLE;
 

activateRowAccessControl

public void activateRowAccessControl(String schemaName,
                                     String tableName)

Description copied from interface: IDatabaseAdapter

 ALTER TABLE  ACTIVATE ROW ACCESS CONTROL
 

setIntVariable

public void setIntVariable(String schemaName,
                           String variableName,
                           int value)

Description copied from interface: IDatabaseAdapter

Build the DML statement for setting a session variable

createTenantPartitions

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

Description copied from interface: IDatabaseAdapter

Create the partitions on each of these tables

createTenantPartitionsThr

public void createTenantPartitionsThr(Table t,
                                      PartitionInfo pi,
                                      int newTenantId,
                                      String tablespaceName)

Ensure that the given table has all the partitions necessary up to and including the max tenant id

Parameters:

t -

pi -

newTenantId -

tablespaceName -

loadPartitionInfoMap

protected void loadPartitionInfoMap(Map<String,PartitionInfo> partitionInfoMap,
                                    String tableSchema)

Read partition info from the database catalog.

Parameters:

partitionInfoMap -

tableSchema -

deactivateRowAccessControl

public void deactivateRowAccessControl(String schemaName,
                                       String tableName)

Description copied from interface: IDatabaseAdapter

Deactivate row access control on a table ALTER TABLE DEACTIVATE ROW ACCESS CONTROL

createRowType

public void createRowType(String schemaName,
                          String typeName,
                          List<ColumnBase> columns)

Description copied from interface: IDatabaseAdapter

Create ROW type used for passing values to stored procedures e.g.:

 CREATE OR REPLACE TYPE .t_str_values AS ROW (parameter_name_id INTEGER,
 str_value VARCHAR(511 OCTETS), str_value_lcase VARCHAR(511 OCTETS))
 

createArrType

public void createArrType(String schemaName,
                          String typeName,
                          String valueType,
                          int arraySize)

Description copied from interface: IDatabaseAdapter

Create ARRAY type used for passing values to stored procedures e.g.: CREATE OR REPLACE TYPE .t_str_values_arr AS .t_str_values ARRAY[256]

dropType

public void dropType(String schemaName,
                     String typeName)

Description copied from interface: IDatabaseAdapter

Drop the type object from the schema

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

Overrides:

createOrReplaceProcedure in class CommonDatabaseAdapter

dropProcedure

public void dropProcedure(String schemaName,
                          String procedureName)

Description copied from interface: IDatabaseAdapter

Drop the given procedure

Specified by:

dropProcedure in interface IDatabaseAdapter

Overrides:

dropProcedure in class CommonDatabaseAdapter

createTablespace

public void createTablespace(String tablespaceName)

Description copied from interface: IDatabaseAdapter

Create a new tablespace with the given name

createTablespace

public void createTablespace(String tablespaceName,
                             int extentSizeKB)

Description copied from interface: IDatabaseAdapter

Create a new tablespace using the given extent size

dropTablespace

public void dropTablespace(String tablespaceName)

Description copied from interface: IDatabaseAdapter

Drop an existing tablespace, including all of its contents

detachPartition

public void detachPartition(String schemaName,
                            String tableName,
                            String partitionName,
                            String intoTableName)

Description copied from interface: IDatabaseAdapter

Detach the partition

removeTenantPartitions

public void removeTenantPartitions(Collection<Table> tables,
                                   String schemaName,
                                   int tenantId)

Description copied from interface: IDatabaseAdapter

Detach the partition associated with the tenantId from each of the given tables

dropDetachedPartitions

public void dropDetachedPartitions(Collection<Table> tables,
                                   String schemaName,
                                   int tenantId)

Description copied from interface: IDatabaseAdapter

Drop the tables which were created by the detach partition operation (as part of tenant deprovisioning).

doesTableExist

public boolean doesTableExist(String schemaName,
                              String tableName)

Description copied from interface: IDatabaseAdapter

Check if the table currently exists

Returns:

varbinaryClause

public String varbinaryClause(int size)

Description copied from interface: IDatabaseTypeAdapter

Generate a clause for binary data type

Returns:

blobClause

public String blobClause(long size,
                         int inlineSize)

Description copied from interface: IDatabaseTypeAdapter

Generate a clause for BLOB (with an inline size if supported)

Returns:

varcharClause

public String varcharClause(int size)

Description copied from interface: IDatabaseTypeAdapter

Generate a clause for VARCHAR

Returns:

checkCompatibility

public boolean checkCompatibility(String adminSchema)

Description copied from interface: IDatabaseAdapter

checks connectivity to the database and that it is compatible

Returns:

runStatement

public void runStatement(IDatabaseStatement stmt)

Description copied from class: CommonDatabaseAdapter

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

Overrides:

runStatement in class CommonDatabaseAdapter

createSchema

public void createSchema(String schemaName)

Description copied from interface: IDatabaseAdapter

Create a database schema

useSessionVariable

public boolean useSessionVariable()

Returns:

a false, if not used, or true if used with the persistence layer.

dropTenantTablespace

public void dropTenantTablespace(int tenantId)

Description copied from interface: IDatabaseAdapter

Drop the tablespace associated with the given tenantId

disableForeignKey

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

Description copied from interface: IDatabaseAdapter

Disable the FK with the given constraint name

enableForeignKey

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

Description copied from interface: IDatabaseAdapter

Enable the FK with the given constraint name

setIntegrityOff

public void setIntegrityOff(String schemaName,
                            String tableName)

setIntegrityUnchecked

public void setIntegrityUnchecked(String schemaName,
                                  String tableName)