SQLAlchemy ORM を使って、Python でIBM Cloud SQL Query データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

IBM Cloud SQL Query Python Connector

IBM Cloud SQL Query へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにIBM Cloud SQL Query をシームレスに統合。



CData Python Connector for IBM Cloud SQL Query を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でIBM Cloud SQL Query にOR マッピング可能に。

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムIBM Cloud SQL Query data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。IBM Cloud SQL Query に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接IBM Cloud SQL Query 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

IBM Cloud SQL Query Data への接続

IBM Cloud SQL Query data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

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

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからIBM Cloud SQL Query に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でIBM Cloud SQL Query Data をモデル化します

次は、接続文字列で接続を確立します。create_engine 関数を使って、IBM Cloud SQL Query data に連携するEngne を作成します。

engine = create_engine("ibmcloudsqlquery///?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 SQL Query Data のマッピングクラスの宣言

接続を確立したら、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 SQL Query Data をクエリ

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

query メソッドを使う

engine = create_engine("ibmcloudsqlquery///?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 SQL Query Data の挿入(INSERT)

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

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

IBM Cloud SQL Query Data を更新(UPDATE)

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

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

IBM Cloud SQL Query Data を削除(DELETE)

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

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

製品の無償トライアル情報

IBM Cloud SQL Query Python Connector の30日の無償トライアル をぜひダウンロードして、IBM Cloud SQL Query data への接続をPython アプリやスクリプトから簡単に作成しましょう。