JayDeBeApi を使って Python からDiscourse のデータにアクセス

Python と Java がインストールされている環境であれば、Python スクリプトと標準 SQL を使ってDiscourse のデータにアクセスできます。CData API Driver for JDBC と JayDeBeApi モジュールを組み合わせることで、Python からリモートのDiscourse のデータを操作できます。CData ドライバーを使用することで、業界標準に準拠した実績のあるドライバーを Python という人気の高い言語で活用できます。この記事では、ドライバーを使って Discourse に SQL クエリを実行し、標準的な Python でDiscourse のデータを可視化する方法を説明します。

JayDeBeApi モジュールを使用

JayDeBeApi は、JDBC（Java Database Connectivity）のブリッジとして機能する Python ライブラリで、Python プログラムから CData JDBC ドライバーを含む Java データベースとやり取りできるようになります。pip install コマンドでモジュールをインストールします。

pip install JayDeBeApi

JDBC URL を作成

JayDeBeApi をインストールしたら、SQL を使って Python からDiscourse のデータを操作する準備が整います。

Discourse API は API キー認証を使用します。

API キー認証の設定

Discourse の認証には API Key と Username が必要です。API キーは、Discourse 管理パネルの API セクションで生成します。ユーザー固有の API キー、または全ユーザー向けの API キーを作成できます。 API キーを取得したら、Domain および Username とあわせて ProfileSettings 接続プロパティに設定します。

接続文字列の例

Profile=C:\profiles\Discourse.apip;ProfileSettings='Domain=forum.example.com;APIKey=your_api_key;Username=your_username;'AuthScheme=APIKey;

ビルトイン接続文字列デザイナー

JDBC URL の作成には、Discourse JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから実行します。

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

以下は、一般的な JDBC 接続文字列を含む変数の例です。

jdbc_url = "jdbc:api:Profile=C:\profiles\Discourse.apip;ProfileSettings='Domain=forum.example.com;APIKey=your_api_key;Username=your_username;'AuthScheme=APIKey;"

Python からDiscourse のデータにアクセス

JDBC URL を設定したら、あとは JDBC ドライバーの JAR ファイルへの絶対パスだけが必要です。これはインストールディレクトリの "lib" フォルダにあります（Windows では "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar"）。

注意: まだ設定していない場合は、JAVA_HOME 環境変数を Java のインストールディレクトリに設定してください。

以下のようなコードで Discourse からデータを読み取り、表示できます。

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:api:Profile=C:\profiles\Discourse.apip;ProfileSettings='Domain=forum.example.com;APIKey=your_api_key;Username=your_username;'AuthScheme=APIKey;"

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 Backups;")


results = cursor.fetchall()
for row in results:
    print(row)

cursor.close()
conn.close()

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

CData API Driver for JDBC の 30 日間無料トライアルをダウンロードして、Python でリアルタイムのDiscourse のデータを操作してみてください。ご不明な点がございましたら、サポートチームまでお問い合わせください。