IBM InfoSphere Federation Server (via JDBC) - Import - 7.1

Talend Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Data Catalog

Bridge Specifications

Vendor IBM
Tool Name InfoSphere Federation Server
Tool Version 8.x
Tool Web Site http://www.ibm.com/software/data/infosphere/federation-server/
Supported Methodology [Relational Database] Data Store (Physical Data Model) via JDBC API
Incremental Harvesting
Multi-Model Harvesting
Remote Repository Browsing for Model Selection
Data Profiling

BRIDGE INFORMATION
Import tool: IBM InfoSphere Federation Server 8.x (http://www.ibm.com/software/data/infosphere/federation-server/)
Import interface: [Relational Database] Data Store (Physical Data Model) via JDBC API from IBM InfoSphere Federation Server (via JDBC)
Import bridge: 'JdbcIbmDb2UdbImport.IbmWebSphereFederationServer' 10.1.0

BRIDGE DOCUMENTATION
IMPORTING FROM A DB2 UNIVERSAL DATABASE USING JDBC.

This bridge establishes a JDBC connection with a physical DB2 database in order to extract the physical metadata. It is critical that the parameters are filled correctly in order to satisfy the local connection requirements on the client workstation that runs the bridge. Please refer to the individual parameter's tool tips for more detailed examples.

Note about permissions:
The username specified must have the CONNECT permission.

This bridge will connect to the syscat tables which exists in DB2/UDB environment when importing metadata. Also please note that the JVM used for the application environment must load the correct library, depending on its bit type (32-bit or 64-bit).
A 32-bit JVM can only load the 32-bit DB2 native libraries and a 64-bit JVM can only load the 64-bit DB2 native libraries.
http://www-01.ibm.com/support/docview.wss?uid=swg21419978
Please do not use this bridge to access mainframe based DB2 instances. Instead, one should use the generic Database (via JDBC) bridge.

Also please note that the JVM used for the application environment must load the correct library, depending on its bit type (32-bit or 64-bit).
A 32-bit JVM can only load the 32-bit DB2 native libraries and a 64-bit JVM can only load the 64-bit DB2 native libraries.
http://www-01.ibm.com/support/docview.wss?uid=swg21419978


Driver details:
- driver name: DB2 JDBC 4.0 Driver (com.ibm.db2.jcc.DB2Driver)
- file: db2jcc4.jar (3,714,904 bytes)
- file default location: /java/Jdbc/db2
NOTE: The customer is responsible for providing the driver at the default location or 'Driver location' parameter directory.


Bridge Parameters

Parameter Name Description Type Values Default Scope
Driver location
This parameter is optional.

By default, JAR files of the JDBC driver are loaded from:
'/java/Jdbc/db2'

However, you may use this parameter to specify a different location. All JARs found in the specified folder will be added to the CLASSPATH.

The 'com.ibm.db2.jcc.DB2Driver' JDBC driver with the 'IBM Data Server Driver for JDBC and SQLJ' name is required.
DIRECTORY      
Host Host name or IP address where DB2 UDB server is running. STRING   localhost Mandatory
Port DB2 UDB server port number. Defult value is 446. NUMERIC   446  
Database Database instance name. STRING     Mandatory
User The database user name on whose behalf the connection is being made.

Important note about permissions:
This bridge reads the metadata for a database, rather than the data. Hence, permission assignments need to be quite different than for a standard database user. The bridge requires access to the system tables, not the actual data tables, thus it is highly recommended that one engages their DB Admin staff to ensure proper permissions for the username entered here.

We do not have any specific instructions as to what are the minimal set of permissions required as it varies from database type to database type, as well as from version to version. In order to ensure that the bridge is working properly, one must first import using the bridge with a FULL Sys Admin type user name (all permissions), i.e., the same type of user name that is used to create and maintain the DB. Once the bridge is working properly against a give DB, then the DB Admin staff may create a user with lesser privileges that still produce a successful result.

Note, this parameter is not required. In the case of Oracle and SQL Server one can specify user credentials in the cHost bridge parameter. In addtion, many Microsoft Access databases allow one to connect without specifying user credentials.
Also, for the Microsoft SQL Server specific bridge, if this parameter is empty, then it is assumed that integrated security is being used (see http://msdn.microsoft.com/en-us/library/ms378428.aspx#Connectingintegrated). In this case, the bridge will attempt to connect with this type of signature:

jdbc:sqlserver://; integratedSecurity=true
instead of

jdbc:sqlserver://; user=userid;password=userpassword

However, in order for this to work, the user must the sqljdbc_auth.dll available on the PATH environment variable. Also the version of the library must match the version of the sqljdbc4.jar that they are using.
STRING      
Password The database user's password on whose behalf the connection is being made PASSWORD      
Schema Description: you can specify a list of database schemas to import.
When the list is empty all available schemas are imported.
The list can have one or more schema names separated by semicolons (e.g. schema1; schema2).
You can specify schema name patterns using DB2 SQL LIKE expressions syntax.
Patterns support inclusions and exclusions.
Here is an example of inclusion syntax, "A%; %B; %C%; D" that tries to get schema names that:
- start with A or
- end with B or
- contain C or
- equal D

Note: when a pattern has special characters, like spaces enclose it in single quote marks (e.g. "'two wo%'; onewo%;").

To exclude a pattern prefix it with NOT. Here is an example of exclusion syntax, "A%; %B; NOT %SYS; NOT 'SYS%'"
that contributes to the following SQL filter: "where (name like A% or name like %B) and (name not like %SYS) and (name not like 'SYS%')"

System schemas (that start with SYS) and all objects they have are ignored by default. To import them specify '-s' option in Miscellaneous parameter.
REPOSITORY_SUBSET      
Tables, Views Description: you can specify a list of database tables to import.
When the list is empty all available tables are imported.
The list can have one or more table names separated by semicolons (e.g. table1; table2).
You can specify table name patterns using SQL LIKE expressions syntax.
Patterns support inclusions and exclusions.
Here is an example of inclusion syntax, "A%; %B; %C%; D" that tries to get table names that: - start with A or
- end with B or
- contain C or
- equal D

Note: when a pattern has special characters, like spaces enclose it in single quote marks (e.g. "'two wo%'; onewo%;").

To exclude a pattern prefix it with NOT. Here is an example of exclusion syntax, "A%; %B; NOT %SYS; NOT 'SYS%'" that
contributes to the following SQL filter: "where (name like A% or name like %B) and (name not like %SYS) and (name not like 'SYS%')"
STRING      
Stored procedure details Specify what stored procedure details you would like to include

- 'Signature' - name and parameters of stored procedures (default)
- 'Code, signature' - above plus code
- 'None' - stored procedures are not included
ENUMERATED
None
Signature
Code, signature
Signature  
Import indexes Specifies if the Indexes should be imported or not.

- 'False' : Indexes are not imported(default)
- 'True' : Indexes are imported
BOOLEAN
False
True
False  
Miscellaneous Specify miscellaneous options identified with a -letter and value.

For example, -m 4G -f 100 -j -Dname=value -Xms1G

-f the database driver fetch size in number of rows (e.g. -f 100)

-zip exportFile to store DDL create tables statements (e.g -zip c:/temp/ddl/export.zip)

-m the maximum Java memory size whole number (e.g. -m 4G or -m 2500M ).
-s import system objects that are skipped by default (e.g. -s)
-v set environment variable(s) (e.g. -v var1=value -v var2="value with spaces").
-j the last option that is followed by Java command line options (e.g. -j -Dname=value -Xms1G).

-diff difference detection level (e.g. -diff ikm for disabling checking indexes, keys, classifier and feature maps)

-synonyms disable import of all synonyms
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"IBM InfoSphere Federation Server (via JDBC)"
Metamodel
JdbcIbmDb2Udb
Mapping Comments
     
Name Name  
Argument Procedure Column The stored procedure parameters are stored in the arguments
Description Comments on the column  
Kind Type The kind of parameter
Name Name  
Association Exported Keys  
Aggregation   True if all the attributes in the Exported Key a+C105re in the Primary Key
AssociationRole Exported Keys  
ExtraConstraint Update Rule, Delete Rule  
Multiplicity   Nullable property of the columns of the Exported Key
Source   Based on the multiplicity of each role
AssociationRoleNameMap Exported Keys The rolename map is created if the columns in the primary and foreign keys are different
Attribute Table Column  
Comment Comments on the column  
InitialValue Default value  
Name Name  
Optional Based on the nullable property  
PhysicalName Name  
Position Position If position is not provided, the order in which the attributes are retrieved is used.
BaseType Types  
DataType Data Type See datatype conversion array
Length Size  
Name   The name is computed from the datatype
PhysicalName Name  
Scale Maximum scale  
CandidateKey Index, Primary Key  
Name Name  
PhysicalName Name  
UniqueKey Non-Unique property  
Class Table of type "TABLE"
Comment Comments on the table  
CppClassType   Set to ENTITY
CppPersistent   Set to True
Name Name  
PhysicalName Name  
ClassDiagram Schema A class diagram is created for each package and contains all the elements of the package
DerivedType Column Table column, stored procedure column SQL View column or type
DataType Data Type See datatype conversion array
Length Size  
Name   The name is computed from the datatype
PhysicalName Name  
Scale Decimal digits  
UserDefined   True for Type
DesignPackage Schema A Package is created for each retrieved schema. If there is no schema a default package is created.
Name Name Set to "Schema" if there is no schema or the schema has no name.
ForeignKey Exported Keys  
Name Name  
PhysicalName Name  
Index Index, Primary Key, Exported Keys  
Clustered Index type true if index type is tableIndexClustered
Name Name  
PhysicalName Name  
IndexMember Index Member, Key Member  
Position Position in the Index or key  
SortOrder Ascending/descending order  
SQLViewAttribute View Column  
Comment Comments on the column  
Name Name  
PhysicalName Name  
Position Ordinal position  
SQLViewEntity Table of type "VIEW"
Comment Comments on the table  
Name Name  
PhysicalName Name  
StoreModel Catalog The model is built using the elements contained in the catalog (The default catalog used for Teradata)
Name Name Set to "Catalog".
StoredProcedure Stored Procedure  
Description Comments on the stored procedure  
Name Name