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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でPORTERS データをモデル化

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

engine = create_engine("api///?Profile=C:\profiles\HRBC.apip&ProfileSettings='Partition=5226&AppID=my_app_id&AppSecret=my_app_secret&'InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

PORTERS（HRBC）に接続するには、PORTERS のAppID とAppSecret が必要です。AppID とAppSecret はPORTERS サポートチームに依頼して取得できます。これらのプロパティを取得したら、ProfileSettings 接続プロパティに設定してください。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

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

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

base = declarative_base()
class BoardList(base):
	__tablename__ = "BoardList"
	Name = Column(String,primary_key=True)
	Description = Column(String)
	...

PORTERS データをクエリ

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

query メソッドを使う

engine = create_engine("api///?Profile=C:\profiles\HRBC.apip&ProfileSettings='Partition=5226&AppID=my_app_id&AppSecret=my_app_secret&'InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(BoardList).filter_by(BoardId="1"):
	print("Name: ", instance.Name)
	print("Description: ", instance.Description)
	print("---------")

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

execute メソッドを使う

BoardList_table = BoardList.metadata.tables["BoardList"]
for instance in session.execute(BoardList_table.select().where(BoardList_table.c.BoardId == "1")):
	print("Name: ", instance.Name)
	print("Description: ", instance.Description)
	print("---------")

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

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

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

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