Python のDash ライブラリを使って、PostgreSQL データ に連携するウェブアプリケーションを開発する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData Python Connectors の特徴

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

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

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でPostgreSQL データを可視化

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

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

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

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

cnxn = mod.connect("User=postgres;Password=admin;Database=postgres;Server=127.0.0.1;Port=5432;")

PostgreSQL への接続には、Server、Port（デフォルトは5432）、Database、およびUser、Password のプロパティを設定します。Database プロパティが設定されない場合には、User のデフォルトデータベースに接続します。

パスワード方式によるSSH 接続

パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。

• User: PostgreSQL のユーザ
• Password: PostgreSQL のパスワード
• Database: PostgreSQL の接続先データベース
• Server: PostgreSQL のサーバー
• Port: PostgreSQL のポート
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH のポート
• SSHServer: SSH サーバー
• SSHUser: SSH ユーザー
• SSHPassword: SSH パスワード

接続文字列形式では以下のようになります。

公開鍵認証方式方式によるSSH 接続

公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。

• User: PostgreSQL のユーザ
• Password: PostgreSQL のパスワード
• Database: PostgreSQL の接続先データベース
• Server: PostgreSQL のサーバー
• Port: PostgreSQL のポート
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHClientCertType: キーストアの種類
• SSHPort: SSH のポート
• SSHServer: SSH サーバー
• SSHUser: SSH ユーザー
• SSHClientCert: 秘密鍵ファイルのパス

接続文字列形式では以下のようになります。

PostgreSQL にクエリを実行

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

df = pd.read_sql("""SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'""", cnxn)

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

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

app_name = 'dash-postgresqledataplot'

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

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

Layout 設定

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

trace = go.Bar(x=df.ShipName, y=df.ShipCity, name='ShipName')

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='PostgreSQL Orders Data', barmode='stack')
		})
], className="container")

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

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

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

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

python postgresql-dash.py

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

おわりに

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

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

cnxn = mod.connect("User=postgres;Password=admin;Database=postgres;Server=127.0.0.1;Port=5432;")

df = pd.read_sql("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'", cnxn)
app_name = 'dash-postgresqldataplot'

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.ShipName, y=df.ShipCity, name='ShipName')

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='PostgreSQL Orders Data', barmode='stack')
		})
], className="container")

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