Database (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 ISO
Tool Name Database
Tool Version SQL-92 to SQL-2011
Tool Web Site http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=53681
Supported Methodology [Relational Database] Multi-Model, Data Store (Physical Data Model) via JDBC API
Multi-Model Harvesting
Incremental Harvesting
Data Profiling
Remote Repository Browsing for Model Selection

SPECIFICATIONS
Tool: ISO Database version SQL-92 to SQL-2011 via JDBC API
See http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=53681
Metadata: [Relational Database] Multi-Model, Data Store (Physical Data Model)
Bridge: Jdbc version 11.0.0

OVERVIEW
This bridge uses a JDBC connection to a database server to extract all its metadata (e.g. Schemas, Tables, Columns, Data Types.) and parse any SQL (e.g. Views, Stored Procedures)to produce the data flow lineage.

WARNING
The JDBC driver used by this bridge have limited implementation to extract advanced metadata such as Synonyms, View dependencies, Candidate keys, Stored Procedures, etc. In such case, more advanced queries have to be made to the proprietary system tables, which are specific to each database. Furthermore, such queries have to be performed using the native drivers provided by each database vendor.
This generic JDBC database bridge has only been tested with Oracle, IBM DB2 (DB/2 UDP databases only), Microsoft SQL Server, Sybase and Teradata, (and again provide less metadata than the specific database bridges), and no claims are made for metadata access when using this bridge with any other database.
Therefore, we recommend using the dedicated database import bridges to access metadata from Oracle, IBM DB2 (DB/2 UDP databases), Microsoft SQL Server, Sybase and Teradata.

REQUIREMENTS
Driver details:
- you may use any JDBC driver that supports JDBC 4.0
- driver JARs location: ${MODEL_bridge_home}/java/Jdbc/generic

FREQUENTLY ASKED QUESTIONS
Q: How does the bridge load the JDBC driver I want to use?
A: The directory or jar file pathname must be set in the 'Driver path' bridge parameter or in the system CLASSPATH environment variable before starting this bridge.

Q: Does my driver require any java security permissions in order to run?
A: Some drivers do require additional security permissions to be granted at runtime. You can grant additional permissions to the driver by editing the 'java.policy' file as below:
grant codeBase 'file:/C:/oracle/ora9/jdbc/lib/classes12.zip' {
permission java.security.AllPermission;
};
Please read your driver documentation for details.
This 'java.policy' file needs to be created in the same directory as the executable, usually ''${MODEL_BRIDGE_HOME}/java'

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html

SUPPORT
Provide a trouble shooting package with debug log. Debug log can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6


Bridge Parameters

Parameter Name Description Type Values Default Scope
Driver location The JDBC driver folder location where all found JAR files will be added to the CLASSPATH.
The generic JDBC driver default located is: ${MODEL_BRIDGE_HOME}/java/Jdbc/generic
DIRECTORY      
Driver class The full name (including the package name) of the java class that implements the JDBC Driver interface.

This value is database and driver dependent, e.g.

'IBM DB2'
com.ibm.db2.jcc.DB2Driver

'Microsoft Access'
sun.jdbc.odbc.JdbcOdbcDriver

'Microsoft SQL Server'
com.microsoft.sqlserver.jdbc.SQLServerDriver

'Netezza'
org.netezza.Driver

'Oracle 7'
oracle.jdbc.driver.OracleDriver

'Oracle 8 Thin'
oracle.jdbc.driver.OracleDriver

'PostgreSQL'
org.postgresql.Driver

'Sybase'
com.sybase.jdbc3.jdbc.SybDriver

'Teradata'
sun.jdbc.odbc.JdbcOdbcDriver, or com.teradata.jdbc.TeraDriver if you are intending to import views
STRING   sun.jdbc.odbc.JdbcOdbcDriver Mandatory
URL The JDBC database connection URL has the following syntax:
jdbc:URLSubProtocol:URLSubName

This value is database and driver dependent, e.g.

'IBM DB2 8.1 Net'
jdbc:db2://COMPUTER_NAME_OR_IP:PORT/DATABASE_NAME

'IBM DB2 8.1 App'
jdbc:db2:DATABASE_NAME

'Informix 12.10.xC3 and earlier'
jdbc:informix-sqli://COMPUTER_NAME_OR_IP:PORT/DATABASE_NAME:INFORMIXSERVER=DATABASE_SERVER

'Informix'
jdbc:informix-sqli://COMPUTER_NAME_OR_IP:PORT/DATABASE_NAME

'Microsoft Access'
jdbc:odbc:YOUR_DSN

'Microsoft SQL Server'
jdbc:sqlserver://COMPUTER_NAME_OR_IP:PORT

'MySQL'
jdbc:mysql://COMPUTER_NAME_OR_IP/DATABASE_NAME

'Netezza'
jdbc:netezza://COMPUTER_NAME_OR_IP:PORT/DBname

'Oracle 7 Thin'
jdbc:oracle:thin:@COMPUTER_NAME_OR_IP:PORT:ORACLE_SID

'Oracle 8 Thin'
jdbc:oracle:thin:@(description=(address=(host=DATABASE_HOST)(protocol=tcp)(port=1521))(connect_data=(sid=SID)))

'PostgreSQL'
jdbc:postgresql://COMPUTER_NAME_OR_IP:PORT/DATABASE_NAME

'SAP Hana'
jdbc:sap://COMPUTER_NAME_OR_IP:DATABASE_TUNNEL_PORT/?autocommit=false

'SyBase'
jdbc:sybase:Tds:COMPUTER_NAME_OR_IP:PORT

'Teradata'
jdbc:odbc:YOUR_DSN, or when using the TeraDriver (native java driver): jdbc:teradata://COMPUTER_NAME_OR_IP/TMODE=ANSI,CHARSET=UTF8
STRING   jdbc:[jdbc-prefix]:COMPUTER_NAME_OR_IP:PORT/DATABASE_NAME Mandatory
User The user name used to connect to the database via JDBC

USER PERMISSIONS
As with any other bridges, this bridge is warranted to be read only and only extracts metadata. Therefore the user of this bridge requires much less permissions than classic users needing to read/write data.

However, this bridge needs a user with (read only) access to system tables in order to access advanced metadata such as the SQL of views or stored procedures which are not implemented in the metadata portion of the JDBC driver, therefore the Database Administrator (DBA) needs to be involved in order get the proper user with enough permissions.

Note that there are no specific instructions as to what are the minimal set of permissions required as it varies from different database types and versions. In order to ensure that the bridge is working properly, one must first import using the bridge with a FULL Sys Admin type username (all permissions), i.e., the same type of username that is used to create and maintain the DB. Once the bridge is working properly against a given DB, then the DBA may create a user with lesser privileges that still produce a successful result.

USER IS OPTIONAL
The user parameter is optional as:

- no user credentials are needed:
for some databases such as Microsoft Access.
- the user credentials may be embedded the Host parameter:
for some databases such as Oracle and Microsoft SQL Server.

- the user credentials may be part of an integrity security:
for Microsoft SQL Server, 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:
- with : jdbc:sqlserver://; integratedSecurity=true
- instead of: jdbc:sqlserver://; user=userid;password=userpassword
However, in order for this to work, the user must have 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 user password used to connect to the database via JDBC. PASSWORD      
Catalog The name of the database catalog to import.

If left empty, the bridge will import only the first catalog found.

This parameter will be ignored for JDBC/ODBC sources which do not support database catalogs.
STRING      
Schema The subset of schemas to import expressed as a semicolon separated list of schemas, e.g.
schema1; schema2

All user schemas are imported if that list is empty.

All system schemas (e.g. SysAdmin) and objects are ignored by default. If system schemas are needed, use the Miscellaneous parameter option -s.

Schema name patterns using SQL LIKE expressions syntax:

- Inclusion syntax:
using '%, e.g.
A%; %B; %C%; D
- start with A or
- end with B or
- contain C or
- equal D

- Exclusion syntax:
using 'NOT", e.g.
A%; %B; NOT %SYS; NOT 'SYS%'
- where (name like A% or name like %B)
- and (name NOT like %SYS)
- and (name NOT like 'SYS%')

- Special characters:
using single quote, e.g.
'two wo%'; onewo%;
STRING      
Tables, Views The subset of tables to import expressed as a semicolon separated list of tables, e.g.
table1; table2

All user tables are imported if that list is empty.

All system tables (e.g. SysAdmin) and objects are ignored by default. If system tables are needed, use the Miscellaneous parameter option -s.

Table name patterns using SQL LIKE expressions syntax:

- Inclusion syntax:
using '%, e.g.
A%; %B; %C%; D
- start with A or
- end with B or
- contain C or
- equal D

- Exclusion syntax:
using 'NOT", e.g.
A%; %B; NOT %SYS; NOT 'SYS%'
- where (name like A% or name like %B)
- and (name NOT like %SYS)
- and (name NOT like 'SYS%')

- Special characters:
using single quote, e.g.
'two wo%'; onewo%;
STRING      
Case sensitivity Controls the database case sensitivity on names spaces (tables, views, tables, columns, stored procedures):

'Auto'
The bridge will try to use the JDBC API to find out if the database is set into the case sensitive mode.
If that API call is not implemented by the JDBC driver the bridge assumes the database is Case Insensitive.

'Case Sensitive'
Force case sensitive

'Case Insensitive
Force case insensitive
ENUMERATED
Auto
Case Sensitive
Case Insensitive
Auto  
View definition extracting SQL The database specific SQL query to retrieve the view definition.
If it is left empty, no relationships between views and their source tables will be built.
This query expects the first parameter to be the view name and, optionally, the second parameter to be the schema name.
Actual query text varies depending on the source database, e.g.

'IBM DB2 UDB'
SELECT CREATOR, NAME, TEXT FROM SYSIBM.SYSVIEWS WHERE CREATOR IN (?)

'IBM DB2 AS400'
SELECT TABLE_SCHEMA, TABLE_NAME, VIEW_DEFINITION FROM QSYS2.SYSVIEWS WHERE TABLE_SCHEMA IN (?)

'Microsoft SQL Server':
SELECT s.name, o.name, t.definition FROM sys.sql_modules t INNER JOIN sys.objects o ON (t.object_id=o.object_id) INNER JOIN sys.schemas s ON (o.schema_id=s.schema_id) WHERE o.type IN ('V') AND s.name IN (?)

'MySQL'
SELECT '',TABLE_NAME,VIEW_DEFINITION FROM INFORMATION_SCHEMA.VIEWS

'Netezza'
SELECT CURRENT_SCHEMA, VIEWNAME, DEFINITION FROM _V_VIEW WHERE OBJTYPE='VIEW'

'Oracle'
SELECT OWNER, VIEW_NAME, TEXT FROM ALL_VIEWS WHERE OWNER IN (?)

'PostgreSQL'
SELECT schemaname, viewname, definition FROM pg_views WHERE schemaname IN (?)

'SAP Hana'
SELECT SCHEMA_NAME, VIEW_NAME, DEFINITION FROM VIEWS

'Teradata'
SELECT d.DatabaseName, m.TVMName, CASE WHEN m.CreateText IS NULL THEN m.RequestText ELSE m.CreateText END FROM DBC.TVM m INNER JOIN dbc.dbase d ON(m.DatabaseId=d.DatabaseId) WHERE m.TableKind IN('V') AND d.DatabaseName IN (?)
STRING      
Synonyms lineage SQL The database specific SQL query to retrieve synonym.
This query must returns two columns: full synonym name and full table name.
The Full Name must contains schema name and table name
Actual query text varies depending on the source database, e.g.

'IBM DB2'
Not supported.

'Microsoft SQL Server'
SELECT s.name, a.name, null, a.base_object_name FROM sys.schemas AS s, sys.synonyms AS a WHERE s.schema_id = a.schema_id
- Result is a result set with two columns in format:
Schema.Synonym; Catalog.Schema.Table ;

'MySQL'
Not supported.

'Oracle'
SELECT OWNER, SYNONYM_NAME, TABLE_OWNER, TABLE_NAME FROM SYS.DBA_SYNONYMS [WHERE OWNER='SCOTT']
- Please, note the query text included in '[' and ']' is optional.
- Result is a result set with two columns in format:
Schema.Synonym; Schema.Table ;

'SAP Hana'
SELECT SCHEMA_NAME, SYNONYM_NAME, OBJECT_SCHEMA, OBJECT_NAME FROM SYNONYMS

'Teradata'
Not supported.
STRING      
Import indexes Controls the import of Indexes:

'False'
Indexes are not imported

'True'
Indexes are imported
BOOLEAN
False
True
False  
Stored procedure details Controls the amount of details imported from stored procedures:

'Signature'
The name and parameters of stored procedures

'Code, signature'
The above plus code

'Lineage, code, signature'
The above plus data lineage derived from the code

'None'
stored procedure details are not included.
ENUMERATED
None
Signature
Code, signature
Lineage, code, signature
Signature  
Procedures text SQL Database specific SQL query to retrieve stored procedures text. This query must returns two columns: full synonym name and full table name.
The Full Name must contains schema name and table name
Actual query text varies depending on the source database.

'IBM DB2'
SELECT procschema, procname, text FROM syscat.procedures WHERE procschema IN (?) UNION ALL SELECT FUNCSCHEMA, FUNCNAME, BODY FROM syscat.functions WHERE FUNCSCHEMA IN (?)
- Result is a result set with three columns in format:
Schema; Procedure; Code;

'Microsoft SQL Server'
SELECT s.name, o.name, t.definition FROM sys.sql_modules t INNER JOIN sys.objects o ON (t.object_id=o.object_id) INNER JOIN sys.schemas s ON (o.schema_id=s.schema_id) WHERE o.type IN ('TF','P','FN','IF') AND s.name IN (?)
- Result is a result set with three columns in format:
Schema; Procedure; Code;

'MySQL,
SELECT '', ROUTINE_NAME, ROUTINE_DEFINITION FROM INFORMATION_SCHEMA.ROUTINES

'Oracle'
SELECT s.owner, s.name, s.text FROM sys.dba_source s INNER JOIN sys.dba_procedures p ON (p.owner=s.owner AND p.object_name=s.name AND p.object_type=s.type) WHERE s.type IN ('PROCEDURE', 'FUNCTION') AND s.owner IN (?) ORDER BY s.name, s.line
- Result is a result set with three columns in format:
Schema; Procedure; Code;

'SAP Hana'
SELECT SCHEMA_NAME, PROCEDURE_NAME, DEFINITION FROM PROCEDURES

'Teradata'
Not supported.
STRING      
Miscellaneous
Specify miscellaneous options identified with a -option followed by a value if required:

GENERAL OPTIONS
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 2500M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -Dname=value -Xms1G

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, and have .bat or .sh extension.
The script path must not include any parent directory symbol (..).
The script should return exit code 0 to indicate success, or another value to indicate failure.
For example:
-prescript \"script.bat\"

JDBC OPTIONS
-f <number of rows>
The database driver fetch size in number of rows. E.g.
-f 100

-s
Import system objects that are skipped by default.

-synonyms
Disable import of all synonyms.

-server.name <database identification name>
Useful when importing a pluggable database that is being moved between containers or a development database going to a production server.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

-tt <string>
Set the JDBC table types to import. It helps when the database driver does not support some tables types like EXTERNAL_TABLE. E.g.
-tt TABLE;VIEW
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Database (via JDBC)"
Metamodel
Jdbc
Mapping Comments
     
Name Name  
Attribute Table Column  
Comment Comments on the column If JDBC driver supports
InitialValue Default value  
Name Name  
Optional Based on the nullable property For Access databases, set to false only if the attribute is in a Unique Index
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  
Class Table of type "TABLE"
Comment Comments on the table If JDBC driver supports
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.
SQLViewAttribute View Column  
Comment Comments on the column If JDBC driver supports
Name Name  
PhysicalName Name  
Position Ordinal position  
SQLViewEntity Table of type "VIEW"
Comment Comments on the table If JDBC driver supports
Name Name  
PhysicalName Name  
StoreModel Catalog The model is built using the elements contained in the catalog (e.g. the database for MS SQL server)
Name Name Set to "Catalog" if the catalog has no name.
Synonym Table Synonym If JDBC driver supports
Name Name