R から JDBC 経由でConfluenceののデータを分析
R と Java がインストールされている環境であれば、純粋な R スクリプトと標準的な SQL を使用してConfluence のデータにアクセスできます。CData JDBC Driver for Confluence と RJDBC パッケージを使えば、R からリモートのConfluence のデータを操作できます。CData Driver を使用することで、業界で実績のある標準規格に準拠したドライバーを活用し、人気のオープンソース言語 R でデータにアクセスできます。この記事では、ドライバーを使ってConfluenceに SQL クエリを実行し、標準的な R 関数を呼び出してConfluence のデータを可視化する方法を説明します。
R のインストール
マルチスレッドとマネージドコードによるドライバーのパフォーマンス向上を最大限に活かすには、マルチスレッド対応の Microsoft R Open を使用するか、BLAS/LAPACK ライブラリとリンクされたオープンソース R を使用します。この記事では Microsoft R Open 3.2.3 を使用しています。このバージョンは、2016年1月1日時点の CRAN リポジトリのスナップショットからパッケージをインストールするように事前設定されており、再現性が確保されています。
RJDBC パッケージの読み込み
ドライバーを使用するには、RJDBC パッケージをダウンロードしてください。 RJDBC パッケージをインストールしたら、以下のコードでパッケージを読み込みます。
library(RJDBC)
Confluenceに JDBC データソースとして接続
Confluenceに JDBC データソースとして接続するには、以下の情報が必要です。
- Driver Class: cdata.jdbc.confluence.ConfluenceDriver に設定します。
- Classpath: ドライバー JAR ファイルの場所を設定します。デフォルトでは、インストールフォルダの lib サブフォルダです。
dbConnect や dbSendQuery などの DBI 関数は、R でデータアクセスコードを記述するための統一されたインターフェースを提供します。以下のコードで、CData JDBC Driver for Confluence に JDBC リクエストを行う DBI ドライバーを初期化します。
driver <- JDBC(driverClass = "cdata.jdbc.confluence.ConfluenceDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.confluence.jar", identifier.quote = "'")
これで DBI 関数を使用してConfluenceに接続し、SQL クエリを実行できます。dbConnect 関数で JDBC 接続を初期化します。
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 ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
java -jar cdata.jdbc.confluence.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
以下は、一般的な JDBC 接続文字列を含む dbConnect 呼び出しの例です。
conn <- dbConnect(driver,"jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")
スキーマの検出
このドライバーは、Confluence API をリレーショナルテーブル、ビュー、ストアドプロシージャとしてモデル化します。以下のコードでテーブルの一覧を取得できます。
dbListTables(conn)
SQL クエリの実行
dbGetQuery 関数を使用して、Confluence API でサポートされている任意の SQL クエリを実行できます。
pages <- dbGetQuery(conn,"SELECT Key, Name FROM Pages WHERE Id = '10000'")
以下のコマンドで、結果をデータビューアウィンドウに表示できます。
View(pages)
Confluence のデータのプロット
これで、CRAN リポジトリで利用可能なデータ可視化パッケージを使ってConfluence のデータを分析できます。組み込みのバープロット関数でシンプルな棒グラフを作成できます。
par(las=2,ps=10,mar=c(5,15,4,2)) barplot(pages$Name, main="Confluence Pages", names.arg = pages$Key, horiz=TRUE)