SQLAlchemy ORM を使って、Python でDB2 のデータに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for DB2 は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで DB2 にデータ連携するPython アプリケーションを構築し、DB2 のデータを可視化できます。 本記事では、SQLAlchemy でDB2 に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. DB2 をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにDB2 のデータを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてDB2 の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でDB2 のデータをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、DB2 のデータに連携するEngne を作成します。

engine = create_engine("db2///?Server=10.0.1.2&Port=50000&User=admin&Password=admin&Database=test")

DB2 に接続するには以下のプロパティを設定します。

• Server: DB2 を実行するサーバー名。
• Port: DB2 サーバーのポート。
• Database: DB2 データベース名。

接続の準備ができたら、認証スキームを選択し、以下で説明するように適切なプロパティを設定します。

本製品 は、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 パスワード

接続文字列形式では以下のようになります。

公開鍵認証方式方式による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: 秘密鍵ファイルのパス

接続文字列形式では以下のようになります。

DB2 のデータのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Orders テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Orders(base):
	__tablename__ = "Orders"
	OrderName = Column(String,primary_key=True)
	Freight = Column(String)
	...

DB2 のデータをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("db2///?Server=10.0.1.2&Port=50000&User=admin&Password=admin&Database=test")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(ShipCity="New York"):
	print("OrderName: ", instance.OrderName)
	print("Freight: ", instance.Freight)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.ShipCity == "New York")):
	print("OrderName: ", instance.OrderName)
	print("Freight: ", instance.Freight)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

DB2 のデータの挿入（INSERT）

DB2 のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、DB2 にすべての追加インスタンスを送ります。

new_rec = Orders(OrderName="placeholder", ShipCity="New York")
session.add(new_rec)
session.commit()

DB2 のデータを更新（UPDATE）

DB2 のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、DB2 にレコードを追加します。

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ShipCity = "New York"
session.commit()

DB2 のデータを削除（DELETE）

DB2 のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

DB2 からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。