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

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

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

EnterpriseDB Data への接続

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

データに接続するには、以下の接続プロパティが必要です。

• Server: EnterpriseDB データベースをホスティングしているサーバーのホスト名またはIP アドレス。
• Port: EnterpriseDB データベースをホスティングしているサーバーのポート。

オプションで、以下を設定することもできます。

• Database: EnterpriseDB サーバーに接続する場合のデフォルトのデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。

Basic 認証による接続

Basic 認証を使って認証するには、以下を設定します。

• User：EnterpriseDB サーバーに認証する際に使われるユーザー。
• Password：EnterpriseDB サーバーに認証する際に使われるパスワード。

SSL 認証による接続

SSL 認証を利用して、セキュアなセッションを介してEnterpriseDB データに接続できます。以下の接続プロパティを設定して、データに接続します。

• SSLClientCert：クライアント証明書のための証明書ストア名に設定します。クライアントとサーバーの両方のマシンでトラストストアとキーストアが保持される2-way SSL の場合に使用されます。
• SSLClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
• SSLClientCertSubject：TLS/SSL クライアント証明書のSubject。ストア内の証明書を検索するために使用されます。
• SSLClientCertType：クライアントストアの証明書タイプ。
• SSLServerCert：サーバーが受け入れ可能な証明書。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("enterprisedb///?User=postgres&Password=admin&Database=postgres&Server=127.0.0.1&Port=5444")

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

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

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

EnterpriseDB Data をクエリ

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

query メソッドを使う

engine = create_engine("enterprisedb///?User=postgres&Password=admin&Database=postgres&Server=127.0.0.1&Port=5444")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(ShipCountry="USA"):
	print("ShipName: ", instance.ShipName)
	print("ShipCity: ", instance.ShipCity)
	print("---------")

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

execute メソッドを使う

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.ShipCountry == "USA")):
	print("ShipName: ", instance.ShipName)
	print("ShipCity: ", instance.ShipCity)
	print("---------")

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

EnterpriseDB Data の挿入（INSERT）

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

new_rec = Orders(ShipName="placeholder", ShipCountry="USA")
session.add(new_rec)
session.commit()

EnterpriseDB Data を更新（UPDATE）

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

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ShipCountry = "USA"
session.commit()

EnterpriseDB Data を削除（DELETE）

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

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

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

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