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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でUM SaaS Cloud のデータをモデル化

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

engine = create_engine("umsaascloud///?AuthScheme=Basic&User=myUser&Password=myPassword&Security Token=myToken")

UM SaaS Cloud 接続プロパティの取得・設定方法

デフォルトでは、本製品は本番環境に接続します。UMSaaSCloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。ユーザー / パスワード認証を使用している場合は、User にsandbox のユーザー名を設定してください。

UM SaaS Cloud への認証

UM SaaS Cloud は、Basic、OAuth、OAuthJWT（コンシューマーキー）など、複数の認証方式をサポートしています。ここではBasic 認証について説明します。認証情報の詳しい取得方法や他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。

Basic 認証

Basic 認証は、セキュリティトークンとユーザー資格情報の使用に基づきます。Basic 認証を使用するには、AuthScheme をBasic に、User とPassword をログイン資格情報に設定し、SecurityToken を設定します。

デフォルトではSecurityToken が必要ですが、UM SaaS Cloud で信頼できるIP アドレスの範囲を設定することで、オプションにすることができます。

UM SaaS Cloud のデータのマッピングクラスの宣言

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

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

UM SaaS Cloud のデータをクエリ

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

query メソッドを使う

engine = create_engine("umsaascloud///?AuthScheme=Basic&User=myUser&Password=myPassword&Security Token=myToken")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Account).filter_by(Industry="Floppy Disks"):
	print("BillingState: ", instance.BillingState)
	print("Name: ", instance.Name)
	print("---------")

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

execute メソッドを使う

Account_table = Account.metadata.tables["Account"]
for instance in session.execute(Account_table.select().where(Account_table.c.Industry == "Floppy Disks")):
	print("BillingState: ", instance.BillingState)
	print("Name: ", instance.Name)
	print("---------")

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

UM SaaS Cloud のデータの挿入（INSERT）

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

new_rec = Account(BillingState="placeholder", Industry="Floppy Disks")
session.add(new_rec)
session.commit()

UM SaaS Cloud のデータを更新（UPDATE）

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

updated_rec = session.query(Account).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Industry = "Floppy Disks"
session.commit()

UM SaaS Cloud のデータを削除（DELETE）

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

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

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

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

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