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

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

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

CockroachDB Data への接続

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

Set the following to connect to CockroachDB.

• Server: The host name or IP address of the server.
• Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
• Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
• User: The Cockroach DB user account used to authenticate.
• Password: The password used to authenticate the user.

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("cockroachdb///?User=root&Password=root&Database=system&Server=localhost&Port=26257")

CockroachDB 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)
	...

CockroachDB Data をクエリ

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

query メソッドを使う

engine = create_engine("cockroachdb///?User=root&Password=root&Database=system&Server=localhost&Port=26257")
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 などが利用可能です。詳細はヘルプドキュメントをご覧ください。

CockroachDB Data の挿入（INSERT）

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

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

CockroachDB Data を更新（UPDATE）

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

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

CockroachDB Data を削除（DELETE）

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

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

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

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