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 providerprotected
CommonDatabaseAdapter(IDatabaseTarget tgt, IDatabaseTranslator dt)
Protected constructor
-
Method Summary
All Methods Instance Methods Concrete Methods 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 tenantvoid
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 tablevoid
alterTableColumnIdentityCache(String schemaName, String tableName, String columnName, int cache)
Change the CACHE value of the named identity generated always columnprotected String
buildColumns(List<ColumnBase> columns, IdentityDef identity)
Build the list of columns in the create table statementprotected String
buildCreateTableStatement(String schema, String name, List<ColumnBase> columns, PrimaryKeyDef pkDef, IdentityDef identity, String tablespaceName)
Generate a create table statement suitable for Derbyvoid
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 functionvoid
createOrReplaceProcedure(String schemaName, String procedureName, Supplier<String> supplier)
Create the stored procedure using the DDL text provided by the suppliervoid
createOrReplaceView(String schemaName, String viewName, String selectClause)
Create or replace the viewvoid
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 selectClausevoid
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 namevoid
dropFunction(String schemaName, String functionName)
drops a given functionvoid
dropIndex(String schemaName, String indexName)
Drop the named indexvoid
dropPermission(String schemaName, String permissionName)
Drop permission object from the schemavoid
dropProcedure(String schemaName, String procedureName)
Drop the given procedurevoid
dropSequence(String schemaName, String sequenceName)
void
dropTable(String schemaName, String tableName)
Drop table from the schemavoid
dropVariable(String schemaName, String variableName)
void
dropView(String schemaName, String viewName)
Drop the view from the databaseint
findTenantId(String adminSchemaName, String tenantName)
Get the tenant id for the given schema and tenant nameString
getQualifiedName(String schemaName, String objectName)
Return the fully qualified name in the form "SCHEMA.OBJECT" Validates that both schema and object names are validIDatabaseTranslator
getTranslator()
Get theIDatabaseTranslator
associated with this adaptervoid
grantFunctionPrivileges(String schemaName, String functionName, Collection<Privilege> privileges, String toUser)
grants permissions on a given functionvoid
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 uservoid
grantSequencePrivileges(String schemaName, String variableName, Collection<Privilege> privileges, String toUser)
Grant the collection of privileges on the named variable to the uservoid
grantVariablePrivileges(String schemaName, String variableName, Collection<Privilege> privileges, String toUser)
Grant the collection of privileges on the named variable to the userprotected List<OrderedColumnDef>
prefixTenantColumn(String tenantColumnName, List<OrderedColumnDef> columns)
Prefix the tenantColumnName to the list of columns, or do nothing if tenantColumnName is nullvoid
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 adapterprotected void
runStatement(String ddl)
Execute the statement on a connection managed by our connection providervoid
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, 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 targeteddt
- 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 theIDatabaseTranslator
associated with this adapter- Specified by:
getTranslator
in interfaceIDatabaseAdapter
- 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)
Generate a create table statement suitable for Derby- Parameters:
schema
-name
-columns
-pkDef
-tablespaceName
-- Returns:
-
createUniqueIndex
public void createUniqueIndex(String schemaName, String tableName, String indexName, String tenantColumnName, List<OrderedColumnDef> indexColumns, List<String> includeColumns)
- Specified by:
createUniqueIndex
in interfaceIDatabaseAdapter
-
createUniqueIndex
public void createUniqueIndex(String schemaName, String tableName, String indexName, String tenantColumnName, List<OrderedColumnDef> indexColumns)
- Specified by:
createUniqueIndex
in interfaceIDatabaseAdapter
-
createIndex
public void createIndex(String schemaName, String tableName, String indexName, String tenantColumnName, List<OrderedColumnDef> indexColumns)
- Specified by:
createIndex
in interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
dropProcedure
public void dropProcedure(String schemaName, String procedureName)
Description copied from interface:IDatabaseAdapter
Drop the given procedure- Specified by:
dropProcedure
in interfaceIDatabaseAdapter
-
dropFunction
public void dropFunction(String schemaName, String functionName)
Description copied from interface:IDatabaseAdapter
drops a given function- Specified by:
dropFunction
in interfaceIDatabaseAdapter
-
dropPermission
public void dropPermission(String schemaName, String permissionName)
Description copied from interface:IDatabaseAdapter
Drop permission object from the schema- Specified by:
dropPermission
in interfaceIDatabaseAdapter
-
dropVariable
public void dropVariable(String schemaName, String variableName)
- Specified by:
dropVariable
in interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
- Returns:
-
updateTenantStatus
public void updateTenantStatus(String adminSchemaName, int tenantId, TenantStatus status)
Update the tenant status- Specified by:
updateTenantStatus
in interfaceIDatabaseAdapter
- 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 interfaceIDatabaseAdapter
- 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 interfaceIDatabaseAdapter
- 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 interfaceIDatabaseAdapter
- 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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
createSequence
public void createSequence(String schemaName, String sequenceName, long startWith, int cache, int incrementBy)
- Specified by:
createSequence
in interfaceIDatabaseAdapter
startWith
- the START WITH value for the sequencecache
- the sequence CACHE value
-
dropSequence
public void dropSequence(String schemaName, String sequenceName)
- Specified by:
dropSequence
in interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
- 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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
dropIndex
public void dropIndex(String schemaName, String indexName)
Description copied from interface:IDatabaseAdapter
Drop the named index- Specified by:
dropIndex
in interfaceIDatabaseAdapter
-
dropView
public void dropView(String schemaName, String viewName)
Description copied from interface:IDatabaseAdapter
Drop the view from the database- Specified by:
dropView
in interfaceIDatabaseAdapter
-
createOrReplaceView
public void createOrReplaceView(String schemaName, String viewName, String selectClause)
Description copied from interface:IDatabaseAdapter
Create or replace the view- Specified by:
createOrReplaceView
in interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
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 interfaceIDatabaseAdapter
-
-