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

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

JayDeBeApi モジュールを使用

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

pip install JayDeBeApi

JDBC URL を作成

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

Confluence 接続プロパティの取得・設定方法

任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

Confluence への認証

Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。

API トークン - Confluence Cloud アカウント

トークンの取得

アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

トークンを使用する認証

Cloud アカウントへの認証を行うには、以下を入力します。

• AuthScheme：APIToken に設定。
• User：Confluence サーバーに認証する際に使用されるユーザー。
• APIToken：現在認証されているユーザーに紐づくAPI トークン。
• Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

Basic 認証 - Confluence Server インスタンス

Server インスタンスへの認証を行うには、以下のように指定します。

• AuthScheme：Basic に設定。
• User：Confluence インスタンスに認証する際に使用されるユーザー。
• Password：Confluence サーバーに認証する際に使われるパスワード。
• Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

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

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

java -jar cdata.jdbc.confluence.jar

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

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

jdbc_url = "jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;"

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

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

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

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

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;"

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.confluence.jar"

conn = jaydebeapi.connect(
   "cdata.jdbc.confluence.ConfluenceDriver",
   jdbc_url,
   [username, password],
   jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Pages;")


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

cursor.close()
conn.close()

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

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