JayDeBeApi を使って Python からAha のデータにアクセス
Python と Java がインストールされている環境であれば、Python スクリプトと標準 SQL を使ってAha のデータにアクセスできます。CData API Driver for JDBC と JayDeBeApi モジュールを組み合わせることで、Python からリモートのAha のデータを操作できます。CData ドライバーを使用することで、業界標準に準拠した実績のあるドライバーを Python という人気の高い言語で活用できます。この記事では、ドライバーを使って Aha に SQL クエリを実行し、標準的な Python でAha のデータを可視化する方法を説明します。
JayDeBeApi モジュールを使用
JayDeBeApi は、JDBC(Java Database Connectivity)のブリッジとして機能する Python ライブラリで、Python プログラムから CData JDBC ドライバーを含む Java データベースとやり取りできるようになります。pip install コマンドでモジュールをインストールします。
pip install JayDeBeApi
JDBC URL を作成
JayDeBeApi をインストールしたら、SQL を使って Python からAha のデータを操作する準備が整います。
まず、Profile 接続プロパティをディスク上のAha! プロファイルの場所に設定します(例:C:\profiles\aha.apip)。次に、ProfileSettings 接続プロパティをAha! の接続文字列に設定します(以下を参照)。
Aha! API プロファイル設定
Aha! API はOAuth ベースの認証を使用します。
まず、Aha! でOAuth アプリを登録する必要があります。これはAha! アカウントの「Settings」>「Personal」>「Developer」>「OAuth Applications」から行えます。また、Aha アカウントのドメイン名にあるDomain を設定します。例えば、Aha アカウントがacmeinc.aha.io の場合、Domain は「acmeinc」となります。
以下の項目を接続文字列に設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されたclient_id に設定します。
- OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
- CallbackURL:アプリ設定で指定したRedirect URI に設定します。
- Domain:ProfileSettings でAha ドメインに設定します。
ビルトイン接続文字列デザイナー
JDBC URL の作成には、Aha JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
以下は、一般的な JDBC 接続文字列を含む変数の例です。
jdbc_url = "jdbc:api:Profile=C:\profiles\aha.apip;ProfileSettings='Domain=acmeinc';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
Python からAha のデータにアクセス
JDBC URL を設定したら、あとは JDBC ドライバーの JAR ファイルへの絶対パスだけが必要です。これはインストールディレクトリの "lib" フォルダにあります(Windows では "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar")。
注意: まだ設定していない場合は、JAVA_HOME 環境変数を Java のインストールディレクトリに設定してください。
以下のようなコードで Aha からデータを読み取り、表示できます。
import jaydebeapi
#The JDBC connection string
jdbc_url = "jdbc:api:Profile=C:\profiles\aha.apip;ProfileSettings='Domain=acmeinc';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
username = "****"
password = "****"
#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar"
conn = jaydebeapi.connect(
"cdata.jdbc.api.APIDriver",
jdbc_url,
[username, password],
jdbc_driver_jar,
)
cursor = conn.cursor()
cursor.execute("SELECT * FROM Ideas;")
results = cursor.fetchall()
for row in results:
print(row)
cursor.close()
conn.close()
無料トライアルと詳細情報
CData API Driver for JDBC の 30 日間無料トライアルをダウンロードして、Python でリアルタイムのAha のデータを操作してみてください。ご不明な点がございましたら、サポートチームまでお問い合わせください。