DB2 (via Collector method) - v3.1.0

Open in new tab

About Collectors

Collector Method

Pre-requisites

Collector Server Minimum Requirements

DB2 Requirements

The DB2 user that the collector will be using must have select access to the following tables
1. syscat.tables
2. syscat.views
3. syscat.columns
4. syscat.procedures
5. syscat.functions
6. syscat.roleauth
7. syscat.tableauth
8. sysibm.sqlforeignkeys

Step 2: Create the Source in K

Create an DB2 source in K

Go to Settings, Select Sources and click Add Source
Select DB2 Source Type
Select “Load from File system” option
Give the source a Name - e.g. DB2 Production
Add the Host name for the DB2 Server
Click Finish Setup

Step 3: Getting Access to the Source Landing Directory

Collector Method

Step 4: Install the Collector

It is recommended to use a python environment such as pyenv or pipenv if you are not intending to install this package at the system level.

Some python packages also have dependencies on the OS level packages, so you may be required to install additional OS packages if the below fails to install.

You can download the Latest Core Library and whl via Platform Settings → Sources → Download Collectors

Run the following command to install the collector

pip install kada_collectors_extractors_<version>-none-any.whl

You will also need to install the common library kada_collectors_lib for this collector to function properly.

pip install kada_collectors_lib-<version>-none-any.whl

Step 5: Configure the Collector

The collector requires a set of parameters to connect to and extract metadata from DB2

The DB2 collector currently only supports meta_only=true, do not set this to false.

FIELD	FIELD TYPE	DESCRIPTION	EXAMPLE

FIELD	FIELD TYPE	DESCRIPTION	EXAMPLE
server	string	DB2 Server If using a custom port append with comma `Example: 10.1.1.23,5678`	“10.1.18.19”
username	string	Username to log into the DB2 account	“myuser”
password	string	Password to log into the DB2 account
database_name	string	The DB2 database to connect to	“db2inst”
output_path	string	Absolute path to the output location where files are to be written	“/tmp/output”
mask	boolean	To enable masking or not	true
compress	boolean	To gzip the output or not	true
meta_only	boolean	If for some reason you want to extract meta only set this to true otherwise leave it as false	false
host_name	string	This is the host value that you will be or have onboarded the source into K as.	db2prod
audit_schema	string	The schema for the audit tables if you are going to extract logs, default is audit	audit
audit_table	string	The table name for the audit table if you are going to extract logs, default is execute	execute

These parameters can be added directly into the run or you can use pass the parameters in via a JSON file. The following is an example you can use that is included in the example run code below.

kada_db2_extractor_config.json

{
    "server": "",
    "username": "",
    "password": "",
    "database_name": "",
    "output_path": "/tmp/output",
    "mask": true,
    "compress": true,
    "meta_only": true,
    "host_name": "",
    "audit_schema": "audit",
    "audit_table": "execute"
}

Step 6: Run the Collector

The following code is an example of how to run the extractor. You may need to uplift this code to meet any code standards at your organisation.

This can be executed in any python environment where the whl has been installed. It will produce and read a high water mark file from the same directory as the execution called DB2_hwm.txt and produce files according to the configuration JSON.

This is the wrapper script: kada_db2_extractor.py

Advance options:

If you wish to maintain your own high water mark files elsewhere you can use the above section’s script as a guide on how to call the extractor. The configuration file is simply the keyword arguments in JSON format. Refer to this document for more information Collector Integration General Notes | Storing HWM in another location

If you are handling external arguments of the runner yourself, you’ll need to consider additional items for the run method. Refer to this document for more information Collector Integration General Notes | The run method

username: username to sign into DB2 server
password: password to sign into DB2 server
server: DB2 server host
database_name: Name of the database.
host_name: The DB2 host or address name, this should be the name you onboarded or will onboard into K with.
output_path: full or relative path to where the outputs should go
mask: To mask the META/DATABASE_LOG files or not
compress: To gzip output files or not
meta_only: To extract metadata only
audit_schema: The schema name where the audit tables are stored
audit_table: The table name where the audit logs are stored

Step 7: Check the Collector Outputs

K Extracts

A set of files (eg metadata, databaselog, linkages, events etc) will be generated. These files will appear in the output_path directory you set in the configuration details

High Water Mark File

A high water mark file is created in the same directory as the execution called db2_hwm.txt and produce files according to the configuration JSON. This file is only produced if you call the publish_hwm method.

If you want prefer file managed hwm, you can edit the location of the hwn by following these instructions Collector Integration General Notes | Storing High Water Marks (HWM)

Step 8: Push the Extracts to K

Once the files have been validated, you can push the files to the K landing directory.

You can use Azure Storage Explorer if you want to initially do this manually. You can push the files using python as well (see Airflow example below)

Example: Using Airflow to orchestrate the Extract and Push to K

Collector Method