DB2 のデータにPythonで接続する方法｜CData Connect AI SDK

Jerod Johnson
Director, Technology Evangelism

PythonのDB-API 2.0準拠コードでリアルタイムのDB2 のデータを読み書きする方法を解説。CData Connect AI Python SDKとPAT認証で、pip install1つから10分で接続を実現します。

CData Connect AI Python SDK を使うと、標準的なDB-API 2.0のPythonコードでDB2 のデータをそのまま読み書きできます。プログラミング不要の他ツールと異なり、pandasやpetlなど既存のPythonエコシステムにそのまま組み込めます。パッケージのインストールからクエリ実行まで3ステップで完了します。

CData Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントで、標準的な Python のデータベースコードでリアルタイムのDB2 のデータを取得・操作できます。接続まわりは Connect AI が引き受けてくれるので、パッケージを1つインストールしてパーソナルアクセストークンで認証するだけで、DB2（および Connect AI に接続済みのその他すべてのソース）にクエリを実行できます。しかも sqlite3 や psycopg2 といったライブラリでおなじみの connect() / cursor() / fetchall() という同じパターンをそのまま使えます。

この記事では、Connect AI で DB2 に接続し、パーソナルアクセストークンを生成して SDK をインストールし、リアルタイムのDB2 のデータを読み取る（対応している場合は書き込む）までの流れをご紹介します。

事前準備

CData Connect AI のアカウント
Python 3.8 以降
有効な認証情報を持つアクティブな DB2 アカウント

Connect AI で DB2 に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

「Add Connection」パネルから「DB2」を選択します

DB2 に接続するために必要な認証プロパティを入力します。
DB2 に接続するには以下のプロパティを設定します。
- Server: DB2 を実行するサーバー名。
- Port: DB2 サーバーのポート。
- Database: DB2 データベース名。
接続の準備ができたら、認証スキームを選択し、以下で説明するように適切なプロパティを設定します。
CData 製品は、DB2 への認証に4つの異なるスキームをサポートします。DB2 ユーザー資格情報（デフォルト）、暗号化されたユーザー資格情報、IBM Identity and Access Management（IAM）認証、および Kerberos です。
DB2 ユーザー資格情報
ユーザー資格情報を使用して認証するには、次のプロパティを設定します。
- AuthScheme：USRIDPWD。
- User：データベースへのアクセス権を持つユーザーのユーザー名。
- Password：データベースへのアクセス権を持つユーザーのパスワード。
暗号化されたユーザー資格情報
サーバーがセキュア認証に対応しており、暗号化されたユーザー資格情報を使用して認証を行いたい場合は、このプロパティを設定します。
- AuthScheme：EUSRIDPWD
IAM、Kerberos で認証したい場合は、ヘルプドキュメントの「はじめに」セクションを参照してください。

パスワード方式によるSSH 接続

パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。
- User: DB2 のユーザ
- Password: DB2 のパスワード
- Database: DB2 の接続先データベース
- Server: DB2 のサーバー
- Port: DB2 のポート
- UserSSH: "true"
- SSHAuthMode: "Password"
- SSHPort: SSH のポート
- SSHServer: SSH サーバー
- SSHUser: SSH ユーザー
- SSHPassword: SSH パスワード
接続文字列形式では以下のようになります。
```
Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=testUseSSH=true;SSHAuthMode=Password;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;
```
公開鍵認証方式方式によるSSH 接続

公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。
- User: DB2 のユーザ
- Password: DB2 のパスワード
- Database: DB2 の接続先データベース
- Server: DB2 のサーバー
- Port: DB2 のポート
- UserSSH: "true"
- SSHAuthMode: "Public_Key"
- SSHClientCertType: キーストアの種類
- SSHPort: SSH のポート
- SSHServer: SSH サーバー
- SSHUser: SSH ユーザー
- SSHClientCert: 秘密鍵ファイルのパス
接続文字列形式では以下のようになります。
```
Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=test;UseSSH=true;SSHAuthMode=Public_Key;SSHClientCertType=PUBLIC_KEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;
```
「Save & Test」をクリックします
「Permissions」タブに移動し、ユーザーベースの権限を更新します。

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
PAT に名前を付けて Create をクリックします。
パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

SDK をインストールする

pip を使って PyPI から SDK をインストールします。

pip install cdata-connect-ai

接続して最初のクエリを実行する

アカウントのメールアドレスと PAT で接続したら、sys_tables にクエリを実行して、接続済みのソース全体で利用可能なテーブルを確認してみましょう。Connect AI の識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：DB21）になります。

import cdata_connect_ai

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

# Discover what's available across your connected sources
cur.execute("SELECT CatalogName, SchemaName, TableName FROM sys_tables LIMIT 25")

for row in cur.fetchall():
    print(row)

結果から任意のテーブルを選び、直接クエリを実行してみましょう。

cur.execute(
    "SELECT OrderName, Freight "
    "FROM [DB21].[DB2].[Orders] "
    "LIMIT 10"
)

for row in cur.fetchall():
    print(row)

DB2 に書き込む

データソースと接続の権限が許可していれば、同じカーソルで INSERT、UPDATE、DELETE ステートメントも実行できます。フィルタ付きの読み取りとまったく同じように、pyformat（%(name)s）パラメータで値をバインドし、影響を受けた行数は cursor.rowcount で確認できます。

# Insert a new record
cur.execute(
    "INSERT INTO [DB21].[DB2].[Orders] (OrderName) "
    "VALUES (%(newvalue)s)",
    {"newvalue": "Example value"},
)
print(f"Rows inserted: {cur.rowcount}")

# Update existing records
cur.execute(
    "UPDATE [DB21].[DB2].[Orders] "
    "SET Freight = %(newvalue)s "
    "WHERE ShipCity = 'New York'",
    {"newvalue": "Updated value"},
)
print(f"Rows updated: {cur.rowcount}")

conn.close()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。同じパラメータ化のパターンは、DELETE ステートメントや cursor.callproc() によるストアドプロシージャの実行にも使えます。

これがワークフローのすべてです。パッケージが1つ、PAT、そして標準的な DB-API 呼び出しだけ。SDK は通常の DB-API 接続を返すので、Python のデータエコシステムのほかのツールにもそのまま組み込めます。ここから先は、この同じ接続を使って、DB2 のデータを pandas に読み込んだり、petl で ETL パイプラインを構築したり、Dash の Web アプリを動かしたりできます。

DB2 のデータにPythonで接続する方法｜CData Connect AI SDK

事前準備

Connect AI で DB2 に接続する方法は？

DB2 ユーザー資格情報

暗号化されたユーザー資格情報

パスワード方式によるSSH 接続

公開鍵認証方式方式によるSSH 接続

パーソナルアクセストークン（PAT）を生成する

SDK をインストールする

接続して最初のクエリを実行する

DB2 に書き込む

関連情報と無料トライアル

はじめる準備はできましたか？

この記事の内容

関連記事