How to Build an ETL App for DB2 Data in Python with CData Connect AI

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Connect AI Python SDK and the petl framework, you can build DB2-connected applications and pipelines for extracting, transforming, and loading DB2 data. This article shows how to connect to Connect AI and use petl to extract, transform, and load DB2 data.

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so petl can read directly from the SDK connection with etl.fromdb. There is no driver to install per source: connect with a Personal Access Token and build your pipeline.

Connect to DB2 in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "DB2" from the Add Connection panel

3. Enter the necessary authentication properties to connect to DB2.

   Set the following properties to connect to DB2:

   • Server: Set this to the name of the server running DB2.
   • Port: Set this to the port the DB2 server is listening on.
   • Database: Set this to the name of the DB2 database.
   • User: Set this to the username of a user allowed to access the database.
   • Password: Set this to the password of a user allowed to access the database.

   You will also need to install the corresponding DB2 driver:

   • Windows: Install the IBM Data Server Provider for .NET.

     On Windows, installing the IBM Data Server Provider is sufficient, as the installation registers it in the machine.config.

   • Java: Install the IBM Data Server Driver for JDBC.

     In the Java version, place the IBM Data Server Driver JAR in the www\WEB-INF\lib\ folder for this application.

   
4. Click Save & Test
5. Navigate to the Permissions tab and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK and the petl framework using the pip utility:

pip install cdata-connect-ai
pip install petl

Build an ETL App for DB2 Data in Python

Once the required modules are installed, you are ready to build the ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, import the modules and connect to Connect AI with your account email and PAT:

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Create a SQL Statement to Query DB2

Use SQL to create a statement for querying DB2. In this article, we read data from the Orders entity. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, DB21).

sql = (
    "SELECT OrderName, Freight "
    "FROM [DB21].[DB2].[Orders] "
    "WHERE ShipCity = 'New York'"
)

Extract, Transform, and Load the DB2 Data

With a connection and query in hand, use petl to extract, transform, and load the DB2 data. In this example, we extract DB2 data, sort the data by the Freight column, and load the data into a CSV file.

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Freight')

etl.tocsv(table2, 'orders_data.csv')

Load New Rows Back into DB2

When DB2 supports writes, load rows back with a batch INSERT. The SDK's executemany takes @name placeholders and a list of parameter dictionaries, one per row.

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [DB21].[DB2].[Orders] (OrderName, Freight) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

Note: Even for writable sources, a read-only PAT or connection permission will reject write operations.

With the CData Connect AI Python SDK, you can work with DB2 data just like you would with any database, including direct access to data in ETL packages like petl.

More Information and Free Trial

Now you can pipe live DB2 data through petl using the CData Connect AI Python SDK. For more information on connecting to DB2 (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start building data pipelines for live DB2 data in Python.

Full Source Code

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT OrderName, Freight "
    "FROM [DB21].[DB2].[Orders] "
    "WHERE ShipCity = 'New York'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Freight')

etl.tocsv(table2, 'orders_data.csv')

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [DB21].[DB2].[Orders] (OrderName, Freight) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()