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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でTableau CRM Analytics のデータをモデル化

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

engine = create_engine("tableaucrm///?OAuthClientId=MyConsumerKey&OAuthClientSecret=MyConsumerSecret&CallbackURL=http://localhost:portNumber&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Tableau CRM Analytics 接続プロパティの取得・設定方法

Tableau CRM Analytics は、OAuth 2 認証規格を使用します。Tableau CRM Analytics にアプリを登録して、OAuthClientId およびOAuthClientSecret を取得する必要があります。

認証の手順は、ヘルプドキュメントの「はじめに」セクションを参照してください。

Tableau CRM Analytics のデータのマッピングクラスの宣言

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

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

Tableau CRM Analytics のデータをクエリ

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

query メソッドを使う

engine = create_engine("tableaucrm///?OAuthClientId=MyConsumerKey&OAuthClientSecret=MyConsumerSecret&CallbackURL=http://localhost:portNumber&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Dataset_Opportunity).filter_by(StageName="Closed Won"):
	print("Name: ", instance.Name)
	print("CloseDate: ", instance.CloseDate)
	print("---------")

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

execute メソッドを使う

Dataset_Opportunity_table = Dataset_Opportunity.metadata.tables["Dataset_Opportunity"]
for instance in session.execute(Dataset_Opportunity_table.select().where(Dataset_Opportunity_table.c.StageName == "Closed Won")):
	print("Name: ", instance.Name)
	print("CloseDate: ", instance.CloseDate)
	print("---------")

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

Tableau CRM Analytics のデータの挿入（INSERT）

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

new_rec = Dataset_Opportunity(Name="placeholder", StageName="Closed Won")
session.add(new_rec)
session.commit()

Tableau CRM Analytics のデータを更新（UPDATE）

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

updated_rec = session.query(Dataset_Opportunity).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.StageName = "Closed Won"
session.commit()

Tableau CRM Analytics のデータを削除（DELETE）

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

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

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

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

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