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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でRedshift のデータをモデル化

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

engine = create_engine("redshift///?User=admin&Password=admin&Database=dev&Server=examplecluster.my.us-west-2.redshift.amazonaws.com&Port=5439")

Redshift への接続には次を設定します：

• Server: 接続するデータベースをホストしているクラスタのホスト名およびIP アドレス。
• Port: クラスタのポート。
• Database: データベース名、ブランクの場合ユーザーのデフォルトデータベースになります。
• User: ユーザー名。
• Password: ユーザーのパスワード。

Server およびPort の値はAWS の管理コンソールで取得可能です：

1. Amazon Redshift console (http://console.aws.amazon.com/redshift) を開く。
2. Clusters ページで、クラスタ名をクリック。
3. クラスタのConfiguration タブで、表示された接続文字列からクラスタのURL をコピーします。

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

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

   base = declarative_base()
   class Orders(base):
   	__tablename__ = "Orders"
   	ShipName = Column(String,primary_key=True)
   	ShipCity = Column(String)
   	...
   

   Redshift のデータをクエリ

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

   query メソッドを使う

   engine = create_engine("redshift///?User=admin&Password=admin&Database=dev&Server=examplecluster.my.us-west-2.redshift.amazonaws.com&Port=5439")
   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 などが利用可能です。詳細はヘルプドキュメントをご覧ください。

   Redshift のデータの挿入（INSERT）

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

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

   Redshift のデータを更新（UPDATE）

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

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

   Redshift のデータを削除（DELETE）

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

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

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

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

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