ODBC 経由で R から Carbone のデータ を分析
純粋な R スクリプトと標準 SQL で Carbone のデータ にアクセスできます。CData ODBC ドライバ for Carbone と RODBC パッケージを使用すると、R からリモート Carbone のデータ を操作できます。CData ドライバを使用することで、業界で実績のある標準に準拠したドライバを活用し、人気のオープンソース言語 R でデータにアクセスできます。この記事では、ドライバを使用して Carbone のデータ に SQL クエリを実行し、R で Carbone のデータ を可視化する方法を説明します。
R をインストール
マルチスレッドや管理コードによるドライバのパフォーマンス向上は、マルチスレッド対応の Microsoft R Open や、BLAS/LAPACK ライブラリにリンクした R を実行することで補完できます。この記事では Microsoft R Open(MRO)を使用します。
Carbone にODBC データソースとして接続
Carbone への接続情報と、Windows および Linux 環境での DSN 設定手順を説明します。
まず、Profile 接続プロパティをディスク上の Carbone プロファイルの場所に設定します(例:C:\profiles\Carbone.apip)。次に、ProfileSettings 接続プロパティを Carbone の接続文字列に設定します(以下を参照)。
Carbone API プロファイル設定
Carbone では、Authorization ヘッダーの Bearer トークンによる API キー認証を使用します。API キーは以下の手順で取得できます。
- https://account.carbone.io で Carbone アカウントにログインします。
- アカウントのホームページに表示されている API キーをコピーします。
API キーを取得したら、以下の接続プロパティを設定します。
- AuthScheme:APIKey に設定します。
- APIKey:Carbone の API キー(Bearer トークン)に設定します。
- CarboneVersion:(オプション)carbone-version リクエストヘッダーで指定する、対象の Carbone API のメジャーバージョンです。デフォルトは 5 です。指定できる値は 5、4、3、staging です。
DSN を設定する際に、Max Rows 接続プロパティも設定することをお勧めします。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。
Windows
まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最後のステップです。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成・設定できます。
Linux
Linux 環境で CData ODBC Driver for Carbone をインストールする場合、ドライバーのインストール時にシステム DSN が事前定義されます。システムデータソースファイル(/etc/odbc.ini)を編集して、必要な接続プロパティを定義することで DSN を変更できます。
/etc/odbc.ini
[CData API Source]
Driver = CData ODBC Driver for Carbone
Description = My Description
Profile = C:\profiles\Carbone.apip
AuthScheme = APIKey
APIKey = your_api_key
これらの設定ファイルの使用方法の詳細については、ヘルプドキュメント(インストール済みまたはオンライン)を参照してください。
RODBC パッケージを読み込む
ドライバを使用するには、RODBC パッケージをダウンロードします。RStudio で、[ツール] -> [パッケージのインストール]をクリックし、[パッケージ]ボックスに RODBC と入力します。
RODBC パッケージをインストールした後、以下の行でパッケージを読み込みます。
library(RODBC)
注意:この記事では RODBC バージョン 1.3-12 を使用しています。Microsoft R Open を使用すると、Microsoft の MRAN リポジトリのチェックポイント機能を使用して同じバージョンでテストできます。 checkpoint コマンドを使用すると、MRAN リポジトリでホストされている CRAN リポジトリのスナップショットからパッケージをインストールできます。2016年1月1日のスナップショットにはバージョン 1.3-12 が含まれています。
library(checkpoint)
checkpoint("2016-01-01")
Carbone のデータ にODBC データソースとして接続
以下の行で R から DSN に接続できます。
conn <- odbcConnect("CData API Source")
スキーマの検出
ドライバは Carbone API をリレーショナルテーブル、ビュー、ストアドプロシージャとしてモデル化します。以下の行でテーブルの一覧を取得できます。
sqlTables(conn)
SQL クエリを実行
sqlQuery 関数を使用して、Carbone API でサポートされている任意の SQL クエリを実行できます。
templates <- sqlQuery(conn, "SELECT Id, Name FROM Templates WHERE Category = 'Invoices'", believeNRows=FALSE, rows_at_time=1)
以下のコマンドでデータビューアウィンドウに結果を表示できます。
View(templates)
Carbone のデータ をプロット
これで、CRAN リポジトリで利用可能なデータビジュアライゼーションパッケージを使用して Carbone のデータ を分析できます。組み込みのバープロット関数を使用して、シンプルな棒グラフを作成できます。
par(las=2,ps=10,mar=c(5,15,4,2))
barplot(templates$Name, main="Carbone Templates", names.arg = templates$Id, horiz=TRUE)