SQLAlchemy ORM を使って、Python でCassandra データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Cassandra をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにCassandra データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてCassandra の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でCassandra データをモデル化

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

engine = create_engine("cassandra///?Database=MyCassandraDB&Port=7000&Server=127.0.0.1")

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

Cassandra への接続には、Server、Port、Database を接続プロパティとして設定します。追加で、内部認証を使う場合には、User、Password を接続プロパティに設定します。

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

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

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

Cassandra データをクエリ

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

query メソッドを使う

engine = create_engine("cassandra///?Database=MyCassandraDB&Port=7000&Server=127.0.0.1")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customer).filter_by(FirstName="Bob"):
	print("City: ", instance.City)
	print("TotalDue: ", instance.TotalDue)
	print("---------")

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

execute メソッドを使う

Customer_table = Customer.metadata.tables["Customer"]
for instance in session.execute(Customer_table.select().where(Customer_table.c.FirstName == "Bob")):
	print("City: ", instance.City)
	print("TotalDue: ", instance.TotalDue)
	print("---------")

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

Cassandra データの挿入（INSERT）

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

new_rec = Customer(City="placeholder", FirstName="Bob")
session.add(new_rec)
session.commit()

Cassandra データを更新（UPDATE）

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

updated_rec = session.query(Customer).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.FirstName = "Bob"
session.commit()

Cassandra データを削除（DELETE）

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

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

Cassandra からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。