SQLAlchemy ORM を使用して Python で Gong のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData API Driver for Python と SQLAlchemy ツールキットを使用して、Gong に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Gong のデータ に接続し、クエリを実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Gong のデータ を操作する際に比類のないパフォーマンスを提供します。Gong に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Gong にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Gong のデータ への接続

Gong のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

Gong への認証では、Gong の API Key と API Secret を使った API キー認証を利用できます。

認証

Gong への認証では、Gong の API Key と API Secret、およびテナントの Domain を指定する必要があります。これらの認証情報は結合され、Base64 エンコードされて、すべての API リクエストで使われる Basic 認証ヘッダーを形成します。

API キー認証の設定

API キーで認証するには、Gong のアカウント設定から API Key と API Secret を取得します。

取得したら、AuthScheme を APIKey に設定し、認証情報を指定して接続します：

• AuthScheme：APIKey に設定します。
• APIKey：Gong の API Key に設定します。
• APISecret：Gong の API Secret に設定します。
• Domain：Gong のテナントドメインに設定します（例：us-36533.api.gong.io）。

接続文字列の例

Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Gong にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Gong のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Gong のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("api:///?Profile=C:\profiles\Gong.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_api_key&APISecret=your_api_secret&Domain=your-tenant.api.gong.io'")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、AnsweredScorecards テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

base = declarative_base()
class AnsweredScorecards(base):
	__tablename__ = "AnsweredScorecards"
	 = Column(String,primary_key=True)
	 = Column(String)
	...

Gong のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("api:///?Profile=C:\profiles\Gong.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_api_key&APISecret=your_api_secret&Domain=your-tenant.api.gong.io'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AnsweredScorecards).filter_by(=""):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

AnsweredScorecards_table = AnsweredScorecards.metadata.tables["AnsweredScorecards"]
for instance in session.execute(AnsweredScorecards_table.select().where(AnsweredScorecards_table.c. == "")):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

無料トライアルと詳細情報

CData API Driver for Python の30日間の無料トライアルをダウンロードして、Gong のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。