SQLAlchemy ORM を使用して Python で CouchDB のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for CouchDB と SQLAlchemy ツールキットを使用して、CouchDB に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して CouchDB のデータ に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの CouchDB のデータ を操作する際に比類のないパフォーマンスを提供します。CouchDB に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 CouchDB にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

CouchDB のデータ への接続

CouchDB のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

Apache CouchDB 接続プロパティの取得・設定方法

それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

Apache CouchDB への認証

続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

• Basic：基本的なユーザー名 / パスワード認証
• JWT：JWT 認証
• None：パブリックなデータベースへの匿名アクセス

Basic 認証

データに接続するには、以下のプロパティを設定してください。

• AuthScheme：Basic
• User：認証に使用されるApache CouchDB ユーザーアカウント
• Password：認証するユーザーに関連付けられたApache CouchDB パスワード

その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて CouchDB にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での CouchDB のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、CouchDB のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("apachecouchdb:///?Url=http://localhost:5984&User=abc123&Password=abcdef")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、Movies テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

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

CouchDB のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("apachecouchdb:///?Url=http://localhost:5984&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、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

CouchDB のデータ の挿入

CouchDB のデータ を挿入するには、マッピングクラスのインスタンスを定義し、アクティブな session に追加します。セッションの commit 関数を呼び出して、追加されたすべてのインスタンスを CouchDB にプッシュします。

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

CouchDB のデータ の更新

CouchDB のデータ を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを CouchDB にプッシュします。

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

CouchDB のデータ の削除

CouchDB のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

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

無料トライアルと詳細情報

CData Python Connector for CouchDB の30日間の無料トライアルをダウンロードして、CouchDB のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。