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

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

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

Amazon DynamoDB Data への接続

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

Amazon DynamoDB への接続には、AccessKey、SecretKey、オプションでDomain とRegion を設定します。 AWS サービスアカウントのセキュリティクレデンシャルページでAccessKey とSecretKey を取得できます。 Region は、DynamoDB にログインしている時の左上に表示されています。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でAmazon DynamoDB Data をモデル化します

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

engine = create_engine("amazondynamodb///?Access Key=xxx&Secret Key=xxx&Domain=amazonaws.com&Region=OREGON")

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

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

base = declarative_base()
class Lead(base):
	__tablename__ = "Lead"
	Industry = Column(String,primary_key=True)
	Revenue = Column(String)
	...

Amazon DynamoDB Data をクエリ

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

query メソッドを使う

engine = create_engine("amazondynamodb///?Access Key=xxx&Secret Key=xxx&Domain=amazonaws.com&Region=OREGON")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Lead).filter_by(FirstName="Bob"):
	print("Industry: ", instance.Industry)
	print("Revenue: ", instance.Revenue)
	print("---------")

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

execute メソッドを使う

Lead_table = Lead.metadata.tables["Lead"]
for instance in session.execute(Lead_table.select().where(Lead_table.c.FirstName == "Bob")):
	print("Industry: ", instance.Industry)
	print("Revenue: ", instance.Revenue)
	print("---------")

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

Amazon DynamoDB Data の挿入（INSERT）

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

new_rec = Lead(Industry="placeholder", FirstName="Bob")
session.add(new_rec)
session.commit()

Amazon DynamoDB Data を更新（UPDATE）

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

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

Amazon DynamoDB Data を削除（DELETE）

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

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

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

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