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

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

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

HarperDB Data への接続

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

Set the Server, User, and Password connection properties to connect to HarperDB. Set UseSSL to secure connections with TLS/SSL.

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("harperdb///?Server=127.0.0.1&User=admin&Password=1234")

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

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

base = declarative_base()
class Customers(base):
	__tablename__ = "Customers"
	City = Column(String,primary_key=True)
	CompanyName = Column(String)
	...

HarperDB Data をクエリ

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

query メソッドを使う

engine = create_engine("harperdb///?Server=127.0.0.1&User=admin&Password=1234")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers).filter_by(Country="US"):
	print("City: ", instance.City)
	print("CompanyName: ", instance.CompanyName)
	print("---------")

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

execute メソッドを使う

Customers_table = Customers.metadata.tables["Customers"]
for instance in session.execute(Customers_table.select().where(Customers_table.c.Country == "US")):
	print("City: ", instance.City)
	print("CompanyName: ", instance.CompanyName)
	print("---------")

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

HarperDB Data の挿入（INSERT）

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

new_rec = Customers(City="placeholder", Country="US")
session.add(new_rec)
session.commit()

HarperDB Data を更新（UPDATE）

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

updated_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Country = "US"
session.commit()

HarperDB Data を削除（DELETE）

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

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

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

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