【徹底解説】Dash を使ってPython からCouchDB のデータに連携するアプリを簡単に開発

Python エコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for ApacheCouchDB を使うことで、pandas モジュールとDash フレームワークでCouchDB にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、CouchDB に連携して、CouchDB のデータ をビジュアライズするシンプルなウェブアプリを作る方法をご紹介します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. CouchDB をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Dash をはじめとする多様なデータ分析・BI ツールにCouchDB のデータを連携
3. ノーコードでの手軽な接続設定

必要なモジュールのインストール

まずは、pip で必要なモジュールおよびフレームワークをインストールします：

pip install pandas
pip install dash
pip install dash-daq

Python でCouchDB のデータを可視化

必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に掲載しているので、参考にしてください。

まず、CData Connector を含むモジュールをインポートします：

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.apachecouchdb as mod
import plotly.graph_objs as go

接続文字列を使ってデータへの接続を確立します。connect 関数を使ってCData CouchDB Connector からCouchDB のデータ との接続を確立します。

cnxn = mod.connect("Url=http://localhost:5984;User=abc123;Password=abcdef;")

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

それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

Apache CouchDB への認証

続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

• Basic：基本的なユーザー名 / パスワード認証
• JWT：JWT 認証
• None：パブリックなデータベースへの匿名アクセス

Basic 認証

データに接続するには、以下のプロパティを設定してください。

• AuthScheme：Basic
• User：認証に使用されるApache CouchDB ユーザーアカウント
• Password：認証するユーザーに関連付けられたApache CouchDB パスワード

その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

CouchDB にクエリを実行

read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。

df = pd.read_sql("""SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'""", cnxn)

ウェブアプリケーションの設定

DataFrame に格納されたクエリ結果を使って、ウェブアプリにname、stylesheet、title を設定していきます。

app_name = 'dash-apachecouchdbedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Layout 設定

次に、CouchDB のデータ をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。

trace = go.Bar(x=df.MovieRuntime, y=df.MovieRating, name='MovieRuntime')

app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(alt='CouchDB Movies Data', barmode='stack')
		})
], className="container")

アプリをセットアップして実行

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。以下のコードで実行できます。

if __name__ == '__main__':
    app.run_server(debug=True)

最後に、Python でウェブアプリを起動してブラウザでCouchDB のデータ を見てみましょう。

python apachecouchdb-dash.py

ちゃんとデータが表示できてますね！

おわりに

CouchDB Python Connector の30日の無償トライアル をぜひダウンロードして、CouchDB のデータ への接続をPython アプリやスクリプトから簡単に作成してみてください。

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.apachecouchdb as mod
import plotly.graph_objs as go

cnxn = mod.connect("Url=http://localhost:5984;User=abc123;Password=abcdef;")

df = pd.read_sql("SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'", cnxn)
app_name = 'dash-apachecouchdbdataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.MovieRuntime, y=df.MovieRating, name='MovieRuntime')

app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(alt='CouchDB Movies Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)