各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でGaroon のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でGaroon にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるGaroon 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Garoon は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Garoon にデータ連携するPython アプリケーションを構築し、Garoon のデータを可視化できます。 本記事では、SQLAlchemy でGaroon に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Garoon をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにGaroon のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてGaroon の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でGaroon のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、Garoon のデータに連携するEngne を作成します。
engine = create_engine("garoon///?User=myuseraccount&Password=mypassword&Url=http://subdomain.domain.com")
Garoon への認証は、パスワード認証、Basic 認証、クライアントSSL をサポートしています。
パスワード認証
Garoon への認証には、以下を設定する必要があります。
- Url：アカウントのURL。
- User：アカウントのユーザー名。
- Password：アカウントのパスワード。
Basic 認証
Basic 認証セキュリティ機能がドメインに設定されている場合は、BasicAuthUser とBasicAuthPassword の追加ログイン資格情報を指定します。Basic 認証ではUser とPassword に加えて、これらのクレデンシャルが必要です。
クライアントSSL
Basic 認証の代わりに、クライアント証明書を指定してCData 製品を認証できます。 SSLClientCert、SSLClientCertType、 SSLClientCertSubject、 およびSSLClientCertPassword を設定します。 さらに、User とPassword をGaroon のログイン資格情報に設定します。
Garoon のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Events テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Events(base): __tablename__ = "Events" Id = Column(String,primary_key=True) EventMenu = Column(String) ...
Garoon のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("garoon///?User=myuseraccount&Password=mypassword&Url=http://subdomain.domain.com")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Events).filter_by(CreatorName="Bob"):
print("Id: ", instance.Id)
print("EventMenu: ", instance.EventMenu)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Events_table = Events.metadata.tables["Events"]
for instance in session.execute(Events_table.select().where(Events_table.c.CreatorName == "Bob")):
print("Id: ", instance.Id)
print("EventMenu: ", instance.EventMenu)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Garoon のデータの挿入（INSERT）
Garoon のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Garoon にすべての追加インスタンスを送ります。
new_rec = Events(Id="placeholder", CreatorName="Bob") session.add(new_rec) session.commit()
Garoon のデータを更新（UPDATE）
Garoon のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Garoon にレコードを追加します。
updated_rec = session.query(Events).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.CreatorName = "Bob" session.commit()
Garoon のデータを削除（DELETE）
Garoon のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Events).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
Garoon からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
