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

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

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

Phoenix Data への接続

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

Phoenix Query Server 経由でApache Phoenix に接続します。デフォルトのポートと異なる場合は、Server とPort プロパティを設定してApache Phoenix に接続します。Servre プロパティは通常、Apache Phoenix をホストしているサーバーのホスト名またはIP アドレスです。

Apache Phoenix への認証

デフォルトでは、認証は使用されません（プレーン）。サーバーに認証が設定されている場合は、AuthScheme をNEGOTIATE に設定して、 必要な場合にはUser とPassword プロパティを設定して、Kerberos で認証します。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("apachephoenix///?Server=localhost&Port=8765")

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

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

base = declarative_base()
class MyTable(base):
	__tablename__ = "MyTable"
	Id = Column(String,primary_key=True)
	Column1 = Column(String)
	...

Phoenix Data をクエリ

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

query メソッドを使う

engine = create_engine("apachephoenix///?Server=localhost&Port=8765")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(MyTable).filter_by(Id="123456"):
	print("Id: ", instance.Id)
	print("Column1: ", instance.Column1)
	print("---------")

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

execute メソッドを使う

MyTable_table = MyTable.metadata.tables["MyTable"]
for instance in session.execute(MyTable_table.select().where(MyTable_table.c.Id == "123456")):
	print("Id: ", instance.Id)
	print("Column1: ", instance.Column1)
	print("---------")

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

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

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