SQLAlchemy ORM を使って、Python でHubSpot データに連携

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムHubSpot data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。HubSpot に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接HubSpot 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

HubSpot Data への接続

HubSpot data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

HubSpot はOAuth 認証標準を使用します。組み込みのOAuthClientId、OAuthClientSecret、CallbackURL を使用することも、自分でアプリを登録して使用することも可能です。app.

詳細はヘルプドキュメントの「はじめに」を参照してください。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからHubSpot に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でHubSpot Data をモデル化します

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

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

HubSpot Data のマッピングクラスの宣言

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

base = declarative_base()
class Prospects(base):
	__tablename__ = "Prospects"
	Slug = Column(String,primary_key=True)
	PageViews = Column(String)
	...

HubSpot Data をクエリ

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

query メソッドを使う

engine = create_engine("hubspot///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Prospects).filter_by(Region="ONTARIO"):
	print("Slug: ", instance.Slug)
	print("PageViews: ", instance.PageViews)
	print("---------")

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

execute メソッドを使う

Prospects_table = Prospects.metadata.tables["Prospects"]
for instance in session.execute(Prospects_table.select().where(Prospects_table.c.Region == "ONTARIO")):
	print("Slug: ", instance.Slug)
	print("PageViews: ", instance.PageViews)
	print("---------")

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

HubSpot Data の挿入（INSERT）

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

new_rec = Prospects(Slug="placeholder", Region="ONTARIO")
session.add(new_rec)
session.commit()

HubSpot Data を更新（UPDATE）

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

updated_rec = session.query(Prospects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Region = "ONTARIO"
session.commit()

HubSpot Data を削除（DELETE）

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

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

製品の無償トライアル情報

HubSpot Python Connector の30日の無償トライアル をぜひダウンロードして、HubSpot data への接続をPython アプリやスクリプトから簡単に作成しましょう。