Crawl IBM Db2 for LUW

✦TL;DR

Extract metadata from IBM Db2 for LUW to catalog databases, schemas, tables, views, columns, stored procedures, and functions in Atlan.

||

|Connect

Extract metadata from your IBM Db2 for Linux, UNIX, and Windows (LUW) server into Atlan to catalog databases, schemas, tables, views, columns, stored procedures, and functions. Atlan also generates lineage from view, stored procedure, and function definitions.

Prerequisites

Before you begin, make sure you have:

• Configured Db2 for LUW user permissions with catalog read access
• Db2 connection details: host, credentials, and the name and port of every database you want to crawl
• Reviewed the order of operations for workflow execution

Create crawler workflow

Create a new IBM Db2 for LUW crawler workflow in Atlan by selecting the connector package, configuring your extraction method and connection details, and running the crawler to extract metadata.

1. In your Atlan workspace, click Connectors in the left sidebar.

   • If you are using the Old UI (Classic), click New Workflow in the top navigation.

2. Click Marketplace.

3. Search for IBM Db2 for LUW Assets and select it.

4. Click Install.

5. Once installation completes, click Setup Workflow on the same tile.

Configure extraction

Select your extraction method and provide the connection details.

Direct

In Direct extraction, Atlan connects to your Db2 for LUW server and crawls metadata directly.

1. For Host, enter the hostname or IP address of your Db2 server. Every database you crawl shares this host.

2. For Username, enter the username you created during setup.

3. For Password, enter the password for the username.

4. Under Databases, add one row for each database you want to crawl:

   • For Database, enter the database name, for example SAMPLE.
   • For Port, enter the listener port for that database (default: 50000). Encrypted connections typically use port 50001.
   • Click the add control to append another row. Each row becomes its own connection, because a Db2 for LUW connection reaches exactly one database. You can add up to 100 rows, or import them as JSON.

5. If your server requires encrypted connections, set Enable SSL/TLS to Enabled, then provide either a truststore or a certificate:

   • For SSL Truststore File, upload the JKS or PKCS12 truststore you prepared during setup.
   • For Truststore Password, enter the truststore password. Leave it empty if the truststore has no password.
   • For Truststore Type, select PKCS12 or JKS.
   • For SSL Server Certificate, upload the server or CA certificate as an .arm or .pem file instead of a truststore. Leave it empty if you uploaded a truststore.

6. Click Test Authentication to confirm connectivity to Db2 for LUW.

7. Once authentication is successful, navigate to the bottom of the screen and click Next.

Agent

In Agent extraction, Self-Deployed Runtime executes metadata extraction within your organization's environment.

1. Install Self-Deployed Runtime if you haven't already:

   • Install via Docker Compose
   • Install on Kubernetes

2. Select the Agent tab.

3. Store sensitive information, such as the username and password, in the secret store configured with the Self-Deployed Runtime and reference the secret keys in the corresponding fields. For more information, see Configure workflow for SDR mode of execution.

4. If your server requires encrypted connections, set Enable SSL/TLS to Enabled:

   • For SSL Truststore File, reference the truststore instead of uploading it - provide either an object store key in your deployment bucket (for example, objectstore://path/to/truststore.p12) or a secret store path whose value is the base64-encoded truststore. For more information, see Configure file inputs for workflow execution.
   • For Truststore Password, reference the secret store path whose value is the truststore password. Leave it empty if the truststore has no password.
   • For Truststore Type, select PKCS12 or JKS.
   • For SSL Server Certificate, reference the .arm or .pem certificate the same way if you use a certificate instead of a truststore.

5. For details on the remaining fields, including the Databases rows, refer to the Direct extraction tab.

6. Click Next after completing the configuration.

Configure connection

Set up the connection name and access controls for your Db2 for LUW data source in Atlan.

1. Provide a Connection Name that represents your source environment. For example, you might use values like production, development, gold, or analytics.

2. To change the users able to manage this connection, update the users or groups listed under Connection Admins. If you don't specify any user or group, nobody can manage the connection, including admins.

3. Click Next at the bottom of the screen.

Configure crawler

Configure which schemas to include or exclude. If a schema appears in both filters, the exclude filter takes precedence. System schemas (SYSCAT, SYSIBM, SYSSTAT, SYSPUBLIC, SYSTOOLS, SYSFUN, SYSIBMADM, NULLID, SYSIBMINTERNAL, SYSIBMTS) are excluded automatically.

Direct

1. To select specific schemas for crawling, click Include Schemas. By default, all schemas are included.

2. To exclude specific schemas from crawling, click Exclude Schemas. By default, no schemas are excluded.

Agent

In Agent extraction, provide the include and exclude filters as a JSON map of schema-name patterns to a list of object patterns. An empty list selects the whole schema.

1. For Include Schemas, enter the schemas to include. For example, {"^FINANCE$": []} includes the entire FINANCE schema. By default, all schemas are included.

2. For Exclude Schemas, enter the schemas to exclude. By default, no schemas are excluded.

The filters apply to every database in the Databases list. Atlan renders them as exact-match and LIKE predicates, so use % and _ for wildcards rather than regular expression syntax.

Run crawler

Direct

1. To verify permissions and configuration before running, click Preflight checks.

2. Choose your run option:

   • To run the crawler once immediately, click Run at the bottom of the screen.
   • To schedule the crawler to run hourly, daily, weekly, or monthly, click Schedule Run at the bottom of the screen.

Agent

Choose your run option:

• To run the crawler once immediately, click Run at the bottom of the screen.
• To schedule the crawler to run hourly, daily, weekly, or monthly, click Schedule Run at the bottom of the screen.

Once the crawler completes, you can view the assets in Atlan's asset page.

See also

• How Atlan connects to IBM Db2 for LUW: Connectivity, authentication, and data access patterns
• What does Atlan crawl from IBM Db2 for LUW: Complete reference of assets and metadata discovered during crawling
• Preflight checks for IBM Db2 for LUW: Validation checks for permissions and configuration before running the crawler