製品情報をご覧ください

製品情報や無償評価版を製品ページにてご確認いただけます。

製品ページへ

SQLAlchemy ORM を使って、Python でCloudant データに連携

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

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

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

Cloudant Data への接続

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

Cloudant への接続には、以下の接続プロパティを設定します。

  • User:ユーザー名に設定。
  • Password:パスワードに設定。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でCloudant Data をモデル化します

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

engine = create_engine("cloudant///?User=abc123& Password=abcdef")

Cloudant Data のマッピングクラスの宣言

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

base = declarative_base()
class Movies(base):
	__tablename__ = "Movies"
	MovieRuntime = Column(String,primary_key=True)
	MovieRating = Column(String)
	...

Cloudant Data をクエリ

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

query メソッドを使う

engine = create_engine("cloudant///?User=abc123& Password=abcdef")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Movies).filter_by(MovieRating="R"):
	print("MovieRuntime: ", instance.MovieRuntime)
	print("MovieRating: ", instance.MovieRating)
	print("---------")

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

execute メソッドを使う

Movies_table = Movies.metadata.tables["Movies"]
for instance in session.execute(Movies_table.select().where(Movies_table.c.MovieRating == "R")):
	print("MovieRuntime: ", instance.MovieRuntime)
	print("MovieRating: ", instance.MovieRating)
	print("---------")

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

Cloudant Data の挿入(INSERT)

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

new_rec = Movies(MovieRuntime="placeholder", MovieRating="R")
session.add(new_rec)
session.commit()

Cloudant Data を更新(UPDATE)

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

updated_rec = session.query(Movies).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.MovieRating = "R"
session.commit()

Cloudant Data を削除(DELETE)

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

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

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

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

 
 
ダウンロード