Superset を ClickHouse に接続

ClickHouse対応

Apache Superset は、Python 製のオープンソースのデータ探索・可視化プラットフォームです。Superset は、ClickHouse が提供する Python ドライバーを使用して ClickHouse に接続します。では、その仕組みを見ていきましょう…

目標

このガイドでは、ClickHouse データベースのデータを使って Superset でダッシュボードを作成します。ダッシュボードは次のようになります。

接続情報を準備する

HTTP(S) で ClickHouse に接続するには、次の情報が必要です。

Parameter(s)	Description
`HOST` and `PORT`	通常、TLS を使用する場合のポートは 8443、TLS を使用しない場合は 8123 です。
`DATABASE NAME`	デフォルトでは `default` という名前のデータベースがあります。接続先のデータベース名を使用してください。
`USERNAME` and `PASSWORD`	デフォルトのユーザー名は `default` です。用途に応じたユーザー名を使用してください。

ClickHouse Cloud サービスの詳細は、ClickHouse Cloud コンソールで確認できます。サービスを選択し、Connect をクリックします。

HTTPS を選択します。接続情報は curl コマンドの例として表示されます。

セルフマネージド ClickHouse を使用している場合、接続情報は ClickHouse 管理者によって設定されます。

ドライバーをインストールする

Superset は clickhouse-connect ドライバーを使用して ClickHouse に接続します。clickhouse-connect の詳細は https://pypi.org/project/clickhouse-connect/ にあり、次のコマンドでインストールできます。
```
pip install clickhouse-connect
```

Superset を ClickHouse に接続する

Superset で、上部メニューから Data を選択し、続いてドロップダウンメニューから Databases を選択します。+ Database ボタンをクリックして、新しいデータベースを追加します。

CONNECT をクリックし、続いて FINISH ボタンをクリックしてセットアップウィザードを完了します。完了すると、データベースの一覧に追加したデータベースが表示されます。

データセットを追加

Superset で ClickHouse のデータを扱うには、データセット を定義する必要があります。Superset の上部メニューで Data を選択し、次にドロップダウンメニューから Datasets を選択します。
データセットを追加するボタンをクリックします。新しいデータベースをデータソースとして選択すると、そのデータベースで定義されているテーブルが表示されます。

ダイアログウィンドウの下部にある ADD ボタンをクリックすると、テーブルがデータセットの一覧に表示されます。これでダッシュボードを作成し、ClickHouse のデータを分析する準備は完了です！

Superset でチャートとダッシュボードを作成する

Superset に慣れているなら、この次のセクションもすぐに理解できるはずです。Superset を初めて使う場合でも、まあ……世の中にある多くの優れた可視化ツールと同じです。使い始めるのは簡単ですが、細かな違いやコツは、実際に使いながら少しずつ身についていきます。

まずはダッシュボードから始めます。Superset の上部メニューで Dashboards を選択します。右上のボタンをクリックして、新しいダッシュボードを追加します。以下のダッシュボード名は UK property prices です。

新しいチャートを作成するには、上部メニューから Charts を選択し、新しいチャートを追加するボタンをクリックします。多数のオプションが表示されます。次の例では、CHOOSE A DATASET ドロップダウンから uk_price_paid データセットを選び、Pie Chart チャートを使用しています。

Superset の円グラフでは Dimension と Metric が必要で、それ以外の設定は任意です。Dimension と Metric には任意のフィールドを選べます。この例では、ClickHouse のフィールド district を Dimension、AVG(price) を Metric としています。

SAVE ボタンをクリックしてチャートを保存し、次に ADD TO DASHBOARD ドロップダウンで UK property prices を選択します。その後、SAVE & GO TO DASHBOARD をクリックすると、チャートが保存され、ダッシュボードに追加されます。