IBM Db2 for z/OS connection

Last updated: Dec 11, 2024

To access your data in IBM Db2 for z/OS, create a connection asset for it.

Db2 for z/OS is an enterprise data server for IBM Z. It manages core business data across an enterprise and supports key business applications.

Supported versions

IBM Db2 for z/OS version 11 and later.

Prerequisites

Obtain the certificate file

A certificate file on the Db2 for z/OS server is required to use this connection.These steps must be done on the Db2 for z/OS server: Obtain an IBM Db2 Connect Unlimited Edition license certificate file from IBM Db2 Connect: Pricing and Installing the IBM Data Server Driver for JDBC and SQLJ. For installation instructions, see Activating the license certificate file for Db2 Connect Unlimited Edition.

Run the bind command

Run the following commands from the Db2 client that is configured to access the Db2 for z/OS server.
You need to run the bind command only once per remote database per Db2 client version.

db2 connect to DBALIAS user USERID using PASSWORD
db2 bind [email protected] blocking all sqlerror continue messages ddcsmvs.msg grant public
db2 connect reset

For information about bind commands, see Binding applications and utilities (Db2 Connect Server).

Run catalog commands

Run the following catalog commands from the Db2 client that is configured to access the Db2 for z/OS server:

db2 catalog tcpip node node_name remote hostname_or_address server port_no_or_service_name

Example:
db2 catalog tcpip node db2z123 remote 192.0.2.0 server 446

 db2 catalog dcs database local_name as real_db_name

Example:
db2 catalog dcs database db2z123 as db2z123

```
db2 catalog database local_name as alias at node node_name authentication server
```
Example:
db2 catalog database db2z123 as db2z123 at node db2z123 authentication server

For information about catalog commands, see CATALOG TCPIP NODE and CATALOG DCS DATABASE.

Create a connection to Db2 for z/OS

To create the connection asset, you need these connection details:

Hostname or IP address
Port number
Collection ID: The ID of the collections of packages to use
Location: The unique name of the Db2 location you want to access
Username and password
Application name (optional): The name of the application that is currently using the connection. For information, see Client info properties support by the IBM Data Server Driver for JDBC and SQLJ.
Client accounting information (optional): The value of the accounting string from the client information that is specified for the connection. For information, see Client info properties support by the IBM Data Server Driver for JDBC and SQLJ.
Client hostname (optional): The hostname of the machine on which the application that is using the connection is running. For information, see Client info properties support by the IBM Data Server Driver for JDBC and SQLJ.
Client user (optional): The name of the user on whose behalf the application that is using the connection is running. For information, see Client info properties support by the IBM Data Server Driver for JDBC and SQLJ.
SSL certificate (if required by the database server)

For Private connectivity, to connect to a database that is not externalized to the internet (for example, behind a firewall), you must set up a secure connection.

Choose the method for creating a connection based on where you are in the platform

In a project: Click Assets > New asset > Connect to a data source. See Adding a connection to a project.
In a catalog: Click Add to catalog > Connection. See Adding a connection asset to a catalog.
In a deployment space: Click Import assets > Data access > Connection. See Adding data assets to a deployment space.
In the Platform assets catalog: Click New connection. See Adding platform connections.

Next step: Add data assets from the connection

Where you can use this connection

You can use Db2 for z/OS connections in the following workspaces and tools:

Projects

DataStage (DataStage service). See Connecting to a data source in DataStage.
Decision Optimization (watsonx.ai Studio and watsonx.ai Runtime)
Metadata import (IBM Knowledge Catalog)
Notebooks (watsonx.ai Studio). Click Read data on the Code snippets pane to get the connection credentials and load the data into a data structure. See Load data from data source connections.
SPSS Modeler (watsonx.ai Studio)

Catalogs

Platform assets catalog
Other catalogs (IBM Knowledge Catalog)

Data lineage

Metadata import (lineage) (IBM Knowledge Catalog and IBM Manta Data Lineage)

Data Virtualization service: You can connect to this data source from Data Virtualization.

Restriction

For SPSS Modeler, you can use this connection only to import data. You cannot export data to this connection or to a Db2 for z/OS connected data asset.

Running SQL statements

To ensure that your SQL statements run correctly, refer to the Db2 for z/OS and SQL concepts for the correct syntax.

Configuring lineage metadata import for IBM Db2 for z/OS

When you create a metadata import for the Db2 for z/OS connection, you can set options specific to this data source, and define the scope of data for which lineage is generated. For details about metadata import, see Designing metadata imports.

To import lineage metadata for Db2 for z/OS, complete these steps:

Create a data source definition. Select IBM Db2 as the data source type.
Create a connection to the data source in a project.
Create a metadata import. Learn more about options that are specific to Db2 for z/OS data source:

When you define a scope, you can analyze the entire data source or use the include and exclude options to define the exact schemas that you want to be analyzed. See Include and exclude lists.
Optionally, you can provide external input in the form of a .zip file. You add this file in the Add inputs from file field. The file must have a supported structure. See External inputs.
Optionally, specify advanced import options.

Include and exclude lists

You can include or exclude assets up to the schema level. Each value is evaluated as a regular expression. Assets which are added later in the data source will also be included or excluded if they match the conditions specified in the lists. Example values:

mySchema: mySchema schema.
mySchema[1-5]: any schema with a name that starts with mySchema and ends with a digit between 1 and 5.

External inputs

If you use external Db2 PL/SQL scripts, you can add them in a .zip file as an external input. You can organize the structure of a .zip file as subfolders that represent schemas. After the scripts are scanned, they are added under respective schemas in the selected catalog or project. The .zip file can have the following structure:

<schema_name>
   <script_name.sql>
<script_name.sql>
replace.csv

The replace.csv file contains placeholder replacements for the scripts that are added in the .zip file. For more information about the format, see Placeholder replacements.

Advanced import options

Extract extended attributes: You can extract extended attributes like primary key, unique and referential integrity constraints of columns. By default these attributes are not extracted.

Learn more

IBM Db2 for z/OS documentation

Parent topic: Supported connections