> ## Documentation Index
> Fetch the complete documentation index at: https://openmetadata-format-2-0-connector-overview-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# DB2 Connector | OpenMetadata Database Integration Guide

> Connect DB2 databases to OpenMetadata with our comprehensive connector guide. Step-by-step setup, configuration, and metadata extraction instructions.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/ibmdb2.webp" name="DB2" stage="PROD" availableFeatures={["Metadata", "Data Profiler", "Data Quality", "View Lineage", "View Column-level Lineage", "dbt", "Sample Data", "Auto-Classification"]} unavailableFeatures={["Query Usage", "Owners", "Tags", "Stored Procedures"]} />

<Warning>
  OpenMetadata doesn't ship DB2 connector in the ingestion contain by default.
  Please make sure you install the below Python package in the ingestion container if you are planning on running DB2 Connector.
  If you are running this as part of docker

  ```code theme={null}
  docker exec -it openmetadata_ingestion pip install '.[db2]'
  ```

  Using python pip, Please make sure you provide appropriate version of ingestion in below command

  ```code theme={null}
   pip install 'openmetadata-ingestion[db2]==1.2.4.0'
  ```
</Warning>

In this section, we provide guides and references to use the DB2 connector.
Configure and schedule DB2 metadata and profiler workflows from the OpenMetadata UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Lineage](/v2.0.x-SNAPSHOT/how-to-guides/data-lineage/workflow)
* [Data Profiler](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow)
* [Data Quality](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality)
* [dbt Integration](/v2.0.x-SNAPSHOT/connectors/database/dbt)
* [Troubleshooting](/v2.0.x-SNAPSHOT/connectors/database/db2/troubleshooting)

## Requirements

To create a new DB2 user, follow [IBM's guide to creating users manually](https://www.ibm.com/docs/ko/samfess/8.2.0?topic=schema-creating-users-manually).
The user must have the following permissions to ingest the metadata.

### DB2 for LUW (Linux, UNIX, Windows)

* `SELECT` privilege on `SYSCAT.SCHEMATA` to fetch the metadata of schemas.

```sql theme={null}
-- Grant SELECT on tables for schema metadata
GRANT SELECT ON SYSCAT.SCHEMATA TO USER_NAME;
```

### DB2 for z/OS

DB2 for z/OS uses `SYSIBM.*` catalog tables instead of `SYSCAT.*`. The connector auto-detects the platform and uses the appropriate catalog tables. The following permissions are required:

* `SELECT` privilege on `SYSIBM.SYSTABLES` to fetch schemas, table names, and table comments.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSTABLES TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSCOLUMNS` to fetch column metadata for tables.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSCOLUMNS TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSVIEWS` to fetch view names and definitions.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSVIEWS TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSINDEXES` to fetch index and primary key information.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSINDEXES TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSTABCONST` to fetch table constraints (primary keys, unique constraints).

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSTABCONST TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSKEYCOLUSE` to fetch key column usage for constraints.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSKEYCOLUSE TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSFOREIGNKEYS` to fetch foreign key column details.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSFOREIGNKEYS TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSRELS` to fetch foreign key relationships between tables.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSRELS TO USER_NAME;
```

* `SELECT` privilege on `SYSIBM.SYSSEQUENCES` to fetch sequence metadata.

```sql theme={null}
GRANT SELECT ON SYSIBM.SYSSEQUENCES TO USER_NAME;
```

### Profiler and Data Quality

Executing the profiler workflow or data quality tests requires the user to have `SELECT` permission on the tables and schemas where the profiler or tests run. For more information, see the [profiler workflow guide](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow) and the [data quality guide](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality).

## Metadata Ingestion

To ingest metadata from DB2, you need to create a service connection. The service connects DB2 with OpenMetadata. Once you create a service, OpenMetadata automatically starts ingesting metadata.

### Step 1: Add New Service

1. Navigate to **Settings** > **Services**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-services.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=1d8b1bddab7b8b43c20d4384be39e12a" alt="Navigate to Settings and Services" width="3004" height="1578" data-path="public/images/connector2.0/metadata-ingestion/access-services.png" />

2. Click **Add New Service**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=792f4403f83940c398633345505482a0" alt="Add New Service" width="3002" height="1514" data-path="public/images/connector2.0/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Database Services**, then click the **DB2** connector tile.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/rMh-qzx9_4Qo0Q4e/public/images/connector2.0/metadata-ingestion/Database/select-service/db2.png?fit=max&auto=format&n=rMh-qzx9_4Qo0Q4e&q=85&s=09d60f7d9d44468226e60be8ef8991e2" alt="Select Service" width="2164" height="1472" data-path="public/images/connector2.0/metadata-ingestion/Database/select-service/db2.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other DB2 services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/rMh-qzx9_4Qo0Q4e/public/images/connector2.0/metadata-ingestion/Database/service-name/db2.png?fit=max&auto=format&n=rMh-qzx9_4Qo0Q4e&q=85&s=61aa987599756491faa3e39f3c8776de" alt="Configure Service" width="1494" height="852" data-path="public/images/connector2.0/metadata-ingestion/Database/service-name/db2.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

### Step 4: Configure Connection Options

Specify your source credentials and verify the connection.

#### Enter Connection Details

Enter the connection details for DB2. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/connection-details/db2.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=68b8b85a68246957370bd565d9f5e980" alt="Configure Service Connection" width="1450" height="1210" data-path="public/images/connector2.0/metadata-ingestion/Database/connection-details/db2.png" />

* **Username**: Specify the user to connect to DB2. It should have enough privileges to read all the metadata.
* **Password**: Password to connect to DB2.
* **database**: Database of the data source.
* **Host and Port**: Enter the fully qualified hostname and port number for your DB2 deployment in the Host and Port field.
* **License File Name**: License file name in case the license is required for connection.
* **License**: Contents of your license file if applicable, make sure to replace new lines with `\n` before pasting it here.

<Tip>
  If you are using DB2 for IBM i:

  * From advanced config, choose the `ibmi` scheme.
  * In Host and Port, don't add the port number.
</Tip>

<Tip>
  If you have a **db2jcc\_license\_cisuz.jar** file, it will not work with **ibm\_db**. This file is a **Db2 Connect** license for the Java Driver.
  For **non-Java drivers**, such as the Python Client used in OpenMetadata ingestion, a **Db2 Connect** client-side license is required, typically named **db2con*.lic*\*.
  The **db2jcc\_license\_cisuz.jar** is specifically for Java-based clients, whereas OpenMetadata ingestion operates with a Python Client, making the `.jar` file incompatible.

  To activate a non-Java license for Db2 Connect **Application Server Edition**, **Advanced Application Server Edition**, **Enterprise Edition**, or **Trial**, follow these steps:

  * Download the **license activation kit** from IBM Passport Advantage: [IBM PPA](https://www.ibm.com/software/passportadvantage/pao_customer.html).
  * Unzip the package and locate the **non-Java license file** (for example, `db2consv_ee.lic`).
  * Apply the `.lic` file to activate the license.
    For more information, see [Everything About Db2 Connect Licensing](https://community.ibm.com/community/user/datamanagement/blogs/shilu-mathai2/2023/05/05/everything-about-db2-connect-licensing).
</Tip>

**Advanced Config** *(driver-level options; most connections don't need these)*

* **Connection Options (Optional)**: Enter any additional connection options that can be sent to the database during the connection. These details must be added as key-value pairs.
* **Connection Arguments (Optional)**: Enter any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as key-value pairs.

#### Test Connection

Once the credentials have been added, click on **Test Connection** and **Save** the changes.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/2XRXwl2QkxBakIS8/public/images/connectors/test-connection.png?fit=max&auto=format&n=2XRXwl2QkxBakIS8&q=85&s=abe3b568c662295afc530c6c6819f9a5" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets OpenMetadata ingests from your database service. Filter patterns use regular expressions applied to asset names.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  Leave all filter patterns empty to ingest all databases, schemas, and tables available in the source.
</Tip>

**Filter Options**

The Database, Schema, and Table sections each include the following filter options:

* **Database**: Controls which databases OpenMetadata ingests from the source.
* **Schema**: Controls which schemas within the ingested databases are included.
* **Table**: Controls which tables and views within the ingested schemas are included.

Each section provides the following controls:

* **Scan Mode**: You can choose between the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector, for example, **Exclude system databases** for the Databases section.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. OpenMetadata saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts schemas, tables, columns, and other structural metadata from your source and keeps your OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, OpenMetadata automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. Navigate to **Settings** > **Services** and select the service type.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-service-type.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=3c2d6613c061c17412ec5c800c0f3833" alt="Navigate to Settings and Services" width="2992" height="1612" data-path="public/images/connector2.0/metadata-ingestion/access-service-type.png" />

2. Click the service you have added.

3. Select the **Agents** tab and click **Add Agent** > **Metadata**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=9a59a29bca844f3035d14a7211574c57" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/connector2.0/metadata-ingestion/add-metadata-agent.png" />

   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=fa31ef8cb17d501983dd958c19e0c414" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/connector2.0/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure core parameters for metadata extraction. The following fields are available:

     | Field                                 | Default | Description                                                                                                              |
     | ------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
     | Default Owner                         | —       | Owner applied to all entities when no specific level owner is configured. Accepts a user or team name/email.             |
     | Service Owner                         | —       | Owner assigned to the service entity.                                                                                    |
     | Database Owner                        | —       | Owner assigned to all ingested databases. Accepts a single owner or a per-database name mapping.                         |
     | Database Schema Owner                 | —       | Owner assigned to all ingested schemas. Accepts a single owner or a per-schema name mapping.                             |
     | Table Owner                           | —       | Owner assigned to all ingested tables. Accepts a single owner or a per-table name mapping.                               |
     | Enable Inheritance                    | On      | When on, child entities inherit the owner from their parent when they have no owner configured.                          |
     | Query Log Duration                    | 1       | Number of days to look back in query logs when processing stored procedure results.                                      |
     | Query Parsing Timeout Limit           | 300     | Timeout in seconds for parsing a single query.                                                                           |
     | Number of Threads                     | 1       | Number of threads to use for parallel table ingestion.                                                                   |
     | Incremental Extraction                | Off     | When enabled, subsequent runs only extract entities changed since the last successful run.                               |
     | Successful Pipeline Run Lookback Days | 7       | Number of days to search back for a prior successful run to use as a baseline for incremental extraction.                |
     | Safety Margin Days                    | 1       | Additional days added to the baseline timestamp as a buffer for incremental extraction.                                  |
     | JSON Schema Sample Size               | 10      | Number of rows sampled to infer JSON column schema. Only applies when Extract JSON Schema is enabled in Advanced Config. |

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-agent-setup.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=393df3bce94f71184988e6c553aee4e0" alt="Agent Setup" width="1570" height="1396" data-path="public/images/connector2.0/metadata-ingestion/Database/database-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. For more information about various filter options, see **Step 6: Configure Ingestion Options**.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-filter-pattern.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=fe20668a777aaad09c9ffac681ee78bf" alt="Filter Patterns" width="1560" height="1030" data-path="public/images/connector2.0/metadata-ingestion/Database/database-filter-pattern.png" />

   * **Scope & Behaviour**: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs:

     | Toggle                         | Default | Description                                                                                                                                                                      |
     | ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Include Tables                 | On      | Ingest table metadata from the source. Turn off to skip tables entirely.                                                                                                         |
     | Include Tags                   | On      | Ingest tags from the source.                                                                                                                                                     |
     | Include Stored Procedures      | On      | Ingest stored procedure metadata.                                                                                                                                                |
     | Include DDL Statements         | Off     | Ingest DDL statements alongside table metadata.                                                                                                                                  |
     | Include Owners                 | Off     | Assign owners to ingested entities when the source owner's email matches a user in OpenMetadata. Does not overwrite an existing owner.                                           |
     | Include Custom Properties      | Off     | Ingest connector-specific custom properties onto entities.                                                                                                                       |
     | Mark Deleted Tables            | On      | Soft-delete tables in OpenMetadata when they are removed from the source. Applies only within the currently ingested schema.                                                     |
     | Mark Deleted Stored Procedures | On      | Soft-delete stored procedures in OpenMetadata when they are removed from the source.                                                                                             |
     | Mark Deleted Schemas           | Off     | Soft-delete schemas and all their child assets when removed from the source.                                                                                                     |
     | Mark Deleted Databases         | Off     | Soft-delete databases and all their child assets when removed from the source.                                                                                                   |
     | Override Metadata              | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value. |
     | Enable Debug Log               | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                               |

     <Note>
       Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures.
     </Note>

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-scope-behaviour.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=afc838a9f9c231e745c75fa1a23e2d50" alt="Scope & Behaviour" width="1566" height="1436" data-path="public/images/connector2.0/metadata-ingestion/Database/database-scope-behaviour.png" />

   * **Advanced Config**: Optional connector-specific settings such as Include Views and Extract JSON Schema.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-advance.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=a6026536873e21919d5be32198a74188" alt="Advanced Config" width="1564" height="352" data-path="public/images/connector2.0/metadata-ingestion/Database/database-advance.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/wI1VkO40X1vdRc0T/public/images/connectors/schedule.png?fit=max&auto=format&n=wI1VkO40X1vdRc0T&q=85&s=14df1dfeef735efd1ad9fb45da8a7352" alt="Schedule Interval" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />

6. Click **Add** to deploy the agent.

## Related

<Columns cols={2}>
  <Card title="Usage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/usage">
    Learn more about how to configure the Usage Workflow to ingest Query information from the UI.
  </Card>

  <Card title="Lineage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/lineage">
    Learn more about how to configure the Lineage from the UI.
  </Card>

  <Card title="Profiler Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow">
    Learn more about how to configure the Data Profiler from the UI.
  </Card>

  <Card title="Data Quality Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/configure">
    Learn more about how to configure the Data Quality tests from the UI.
  </Card>

  <Card title="dbt Integration" href="/v2.0.x-SNAPSHOT/connectors/database/dbt">
    Learn more about how to ingest dbt models' definitions and their lineage.
  </Card>
</Columns>