SQLAlchemy ORM を使って、Python でIBM Cloud Data Engine データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でIBM Cloud Data Engine データをモデル化

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

engine = create_engine("ibmclouddataengine///?Api Key=MyAPIKey&Instance CRN=myInstanceCRN&Region=myRegion&Schema=mySchema&OAuth Client Id=myOAuthClientId&OAuth Client Secret=myOAuthClientSecret&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

IBM Cloud Data Engine は、OAuth およびHMAC 認証標準を使います。詳細はヘルプドキュメントを参照してください。

IBM Cloud Data Engine データのマッピングクラスの宣言

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

base = declarative_base()
class Jobs(base):
	__tablename__ = "Jobs"
	Id = Column(String,primary_key=True)
	Status = Column(String)
	...

IBM Cloud Data Engine データをクエリ

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

query メソッドを使う

engine = create_engine("ibmclouddataengine///?Api Key=MyAPIKey&Instance CRN=myInstanceCRN&Region=myRegion&Schema=mySchema&OAuth Client Id=myOAuthClientId&OAuth Client Secret=myOAuthClientSecret&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Jobs).filter_by(UserId="user@domain.com"):
	print("Id: ", instance.Id)
	print("Status: ", instance.Status)
	print("---------")

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

execute メソッドを使う

Jobs_table = Jobs.metadata.tables["Jobs"]
for instance in session.execute(Jobs_table.select().where(Jobs_table.c.UserId == "user@domain.com")):
	print("Id: ", instance.Id)
	print("Status: ", instance.Status)
	print("---------")

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

IBM Cloud Data Engine データの挿入（INSERT）

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

new_rec = Jobs(Id="placeholder", UserId="user@domain.com")
session.add(new_rec)
session.commit()

IBM Cloud Data Engine データを更新（UPDATE）

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

updated_rec = session.query(Jobs).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.UserId = "user@domain.com"
session.commit()

IBM Cloud Data Engine データを削除（DELETE）

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

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

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

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

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