製品をチェック

Highrise Connector の30日間無償トライアルをダウンロード

 ダウンロードはこちら

製品の詳細

Highrise アイコン Highrise Python Connector 相談したい

Highrise へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにHighrise をシームレスに統合。

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

CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でHighrise にOR マッピング可能に。

加藤龍彦
ウェブデベロッパー

最終更新日:2023-09-23
highrise ロゴ

CData

python ロゴ画像
Python ロゴ

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でHighrise データをモデル化

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

engine = create_engine("highrise///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost&AccountId=MyAccountId&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Highrise はOAuth 認証標準を利用しています。Highrise に認証するには、Highrise にアプリケーションを登録し、OAuthClientId、OAuthClientSecret、およびCallbackURL を取得する必要があります。データへの接続には、AccountId の設定も必要です。

OAuth の使用については、ヘルプドキュメントの「はじめに」を参照してください。

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

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

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

Highrise データをクエリ

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

query メソッドを使う

engine = create_engine("highrise///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost&AccountId=MyAccountId&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Deals).filter_by(GroupId="MyGroupId"):
	print("Name: ", instance.Name)
	print("Price: ", instance.Price)
	print("---------")

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

execute メソッドを使う

Deals_table = Deals.metadata.tables["Deals"]
for instance in session.execute(Deals_table.select().where(Deals_table.c.GroupId == "MyGroupId")):
	print("Name: ", instance.Name)
	print("Price: ", instance.Price)
	print("---------")

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

Highrise データの挿入(INSERT)

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

new_rec = Deals(Name="placeholder", GroupId="MyGroupId")
session.add(new_rec)
session.commit()

Highrise データを更新(UPDATE)

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

updated_rec = session.query(Deals).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.GroupId = "MyGroupId"
session.commit()

Highrise データを削除(DELETE)

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

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。