Db2 Resource Configuration

Before you configure your scanner, make sure you meet the prerequisites. Read our guide on Db2 integration requirements to double-check.

Source System Properties

This configuration can be setup by creating a new connection on Admin UI / Connections tab or editing an existing connection in Admin UI / Connections / Databases / Db2 / specific connection. New connection can also be created via Manta Orchestration API.

Granularity of the IBM Automatic Data Lineage connection for Db2 is one Db2 database. Use filter on schemas to limit the scope of analysis as needed. Use of multiple connections against a single Db2 database may lead to within-system lineage not be connected properly.

Property name

Description

Example

db2.dictionary.id

Name of a resource representing this Db2 database known as a dictionary ID, used as an output subdirectory name for extracted DDL files and the database dictionary

DB2

db2.subdialect

Type of Db2 server used; the supported values are "ZOS" for Db2 for z/OS and "DB2" for all other Db2 servers

DB2

db2.url

JDBC connection string for the Db2 database

jdbc:db2://<host>:<port>/<database>

db2.username

Name of user with the specified privileges needed for extraction

manta_user

db2.password

Password of user with the specified privileges

manta_password

db2.extractedSchemas

List of schemas to extract, separated by commas; each part is evaluated as a regular expression

Schema1,Schema2,Schema3,test_.*

db2.excludedSchemas

List of schemas to exclude from extraction, separated by commas

Schema5,Schema4

db2.extraction.method

Set to Agent:default when the desired extraction method is the default Manta Extractor Agent, set to Agent:{remote_agent_name} when a remote Agent is the desired extraction method, set to Git:{git.dictionary.id} when the Git ingest method is the desired extraction method. For more information on setting up a remote extractor Agent please refer to the Manta Flow Agent Configuration for Extraction documentation. For additional details on configuring a Git ingest method, please refer to the Manta Flow Agent Configuration for Extraction:Git Source documentation.

default

Git

agent

db2.ddl.encoding

Encoding of automatically extracted Db2 DDL scripts. See Encodings for applicable values.

utf8

db2.script.encoding

Encoding of manually provided PL/SQL scripts performed on this Db2 database instance. See Encodings for applicable values.

utf8

db2.hostName

User-set host name. Leave blank, to use the automatically extracted host name. Set to a custom unique host name to override the automatically extracted host name. We recommend using this value when connecting to z/OS.

User-set server name. Leave blank, to use the automatically extracted host name and instance name. Set to a custom unique host name and instance name to override the automatically extracted ones. The format is the host name followed by backslash and instance name (host name[\instance name]). We recommend setting this when connecting to z/OS where the instance name is optional. (as of R42.4)

DB2HOST
DB2HOST\INST (as of 42.1)

db2.excludedEntities

Specify the entities to exclude from extraction. The filter input is divided into two parts by a semicolon character ; . Each filter follows the same format of (Entity Types;)?Name Pattern.

  1. Entity types (optional): The first part lists the types of entities to exclude. These can include table, view, type, procedure, function, trigger, sequence, synonym, or database_link. Multiple entity types should be separated by a | character .

  2. Name pattern: The second part of the field is a name pattern that matches the entity names to be excluded. This pattern can be either a single name (for any database and any schema), a schema and a name separated by a / (for any database) or a database, schema and name separated by / (see examples).

Both parts of the filter expression are case-insensitive.

You can specify multiple filters by separating them with a comma ,.

If a non-filtered entity (e.g., a view) points to a filtered entity (e.g., a table), the filtered entity will still appear as a deduced item (available as of Manta R42.6).

  • temp_.*: Excludes all objects whose name starts with temp_, regardless of their type, database or schema

  • function;abc.*: Excludes functions whose name starts with abc, regardless of their database or schema

  • table|view;dw.*/.*,function|procedure;abc.*/def.*/ghi.*: Excludes every table and every view from schemas that start with 'dw' of all databases and every function and procedure whose name starts with 'ghi' from schemas that start with 'def' of databases that start with 'abc'

Common Scanner Properties

This configuration is common for all Db2 source systems and for all Db2 scenarios, and is configured in Admin UI > Configuration > CLI > Db2 > Db2 Common. It can be overridden on individual connection level.

Property name

Description

Example

db2.dictionary.dir

Directory with data dictionaries extracted from Db2

${manta.dir.temp}/db2

filepath.lowercase

Whether paths to files should be lowercase (false for case-sensitive file systems, true otherwise)

false
true

db2.dll.output

Directory for automatically extracted Db2 DDL scripts (for the extraction phase)

${manta.dir.temp}/db2/
${db2.dictionary.id}/ddl

db2.ddl.input

Directory with automatically extracted Db2 DDL scripts (for the analysis phase)

${db2.dll.output}

db2.script.input

Directory with manually provided PL/SQL scripts which are performed on this Db2 database instance (for the analysis phase)

${manta.dir.input}/db2/
${db2.dictionary.id}/

db2.script.replace

Path to the CSV file with the replacements to be applied to the provided PL/SQL scripts; see Placeholder Replacement in Input Scripts for details about the replacement file format

${manta.dir.input}/db2/
${db2.dictionary.id}/replace.csv

db2.script.replace.regex

Flag specifying whether replacements for PL/SQL scripts in the provided CSV file specified in db2.script.replace should be interpreted as regular expressions (true) or simple text (false)

false
true

db2.analyze.parallelCount

Number of parallel threads which will analyze DDL and PL/SQL

4

db2.dictionary.mappingFile

Path to automatically generated mappings for Db2 databases

${manta.dir.temp}/db2/

db2DictionaryMantaMapping.csv

db2.dictionary.mappingManualFile

Path to mappings provided manually for Db2 databases

${manta.dir.scenario}/conf/

db2DictionaryMantaMappingManual.csv

db2.extractor.enabled.encryptConnection

Use an SSL-protected connection

true
false

db2.analyze.retainUnusedResultSetColumns

Flag specifying whether the data lineage should include sub-query resultset columns that do not have any downstream lineage

By default, set to false

false
true

Manual Mapping Properties

It is possible to manually configure mappings for Db2 databases. This is necessary for non-extracted schemas in the Automatic Data Lineage extraction phase and complicated usage of database links.

Each mapping has its own row with the following parts separated by semicolons.

Property name

Description

Example

Dictionary ID

Name of a resource representing this Db2 database known as dictionary ID, used as an output subdirectory name for extracted DDL files and the database dictionary

DB2

Host name

Name of the host where the database is running

localhost
127.0.0.1

Instance name

Name of the database instance

DB2

Database name

Name of the database

SAMPLE

Connection ID

External Db2 connection ID in third-party tools; for example, as it appears in the Informatica PowerCenter connection string, etc., or it can be left empty

DB2

Include schemas

List of schemas to extract, separated by commas; each part is evaluated as a regular expression

Schema1,Schema2,Schema3,test_.*

Exclude schemas

List of schemas to exclude from extraction, separated by commas

Schema5,Schema4