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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でAmazon DynamoDB データをモデル化

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

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

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

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

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

接続を確立したら、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 データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 データの挿入（INSERT）

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

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

Amazon DynamoDB データを更新（UPDATE）

Amazon DynamoDB データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションで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 データを削除（DELETE）

Amazon DynamoDB データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 へのデータ連携には、ぜひCData Python Connector をご利用ください

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

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