SQLAlchemy ORM を使って、Python でBusiness b-ridge データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でBusiness b-ridge データをモデル化

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

engine = create_engine("businessbridge///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Business b-ridge 接続プロパティの取得・設定方法

B b-ridge への接続には、Company Key、Project Key、Subscription Key が必要となります。それぞれWeb API 利用申請時に取得できます。取得したKey を接続プロパティに設定して接続します。

• CompanyKey：Business b-ridge のCompany Key に設定。
• ProjectKey：Business b-ridge のProject Key に設定。
• SubscriptionKey：控えておいたSubscription Key に設定。

Business b-ridge データのマッピングクラスの宣言

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

base = declarative_base()
class CDATA(base):
	__tablename__ = "CDATA"
	ItemId = Column(String,primary_key=True)
	StructureId = Column(String)
	...

Business b-ridge データをクエリ

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

query メソッドを使う

engine = create_engine("businessbridge///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(CDATA).filter_by(ItemTypeId="1"):
	print("ItemId: ", instance.ItemId)
	print("StructureId: ", instance.StructureId)
	print("---------")

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

execute メソッドを使う

CDATA_table = CDATA.metadata.tables["CDATA"]
for instance in session.execute(CDATA_table.select().where(CDATA_table.c.ItemTypeId == "1")):
	print("ItemId: ", instance.ItemId)
	print("StructureId: ", instance.StructureId)
	print("---------")

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

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

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

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