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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("certinia///?User=myUser&Password=myPassword&Security Token=myToken&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Certinia 接続プロパティの取得・設定方法

デフォルトでは、CData 製品は本番環境に接続します。サンドボックスアカウントを使用するには、UseSandbox をtrue に設定します。User にサンドボックスのユーザー名を指定してください。

Certinia への認証

Certinia への接続に使用できる認証方法は以下のとおりです。

• ログイン認証
• SSO
• OAuth

ログインおよびトークン

User およびPassword をログインクレデンシャルに設定します。さらにSecurityToken を設定します。SecurityToken については、信頼できるIP アドレスに利用中のIP を追加することで指定する必要がなくなります。

セキュリティトークンを無効にするには、以下の手順を実行してください。

1. Certinia にログインして、「設定」セクションの「Quick Find」ボックスに「Network Access」と入力します。
2. 使用しているIP アドレスを信頼できるIP アドレスのリストに追加します。

セキュリティトークンの取得には、以下を実行してください。

1. Certinia の個人情報設定用ページを開きます。
2. セキュリティトークンリセット用のリンクをクリックすると、トークンが指定したメールアドレスに送信されます。
3. 取得したセキュリティトークンを、SecurityToken 接続プロパティに指定するか、Password に追加してください。

OAuth

すべてのOAuth フローで、AuthScheme をOAuth に設定する必要があります。詳しい設定方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

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

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

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

Certinia のデータをクエリ

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

query メソッドを使う

engine = create_engine("certinia///?User=myUser&Password=myPassword&Security Token=myToken&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
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 などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Certinia のデータの挿入（INSERT）

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

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

Certinia のデータを更新（UPDATE）

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

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

Certinia のデータを削除（DELETE）

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

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

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

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

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