メインコンテンツまでスキップ
メインコンテンツまでスキップ

SupersetをClickHouseに接続する

Community Maintained

Apache Supersetは、Pythonで書かれたオープンソースのデータ探索および可視化プラットフォームです。Supersetは、ClickHouseが提供するPythonドライバーを使用してClickHouseに接続します。どのように機能するか見てみましょう...

目標

このガイドでは、ClickHouseデータベースからのデータを使用してSupersetでダッシュボードを構築します。ダッシュボードは以下のようになります:

UKの不動産価格を複数の視覚化(円グラフや表を含む)で示したSupersetダッシュボード

データを追加する

作業するデータセットがない場合は、例の一つを追加できます。このガイドではUK Price Paidデータセットを使用するので、それを選ぶことができます。同じドキュメントカテゴリに他にもいくつかありますので、確認してみてください。

1. 接続の詳細を収集する

To connect to ClickHouse with HTTP(S) you need this information:

  • The HOST and PORT: typically, the port is 8443 when using TLS or 8123 when not using TLS.

  • The DATABASE NAME: out of the box, there is a database named default, use the name of the database that you want to connect to.

  • The USERNAME and PASSWORD: out of the box, the username is default. Use the username appropriate for your use case.

The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select the service that you will connect to and click Connect:

ClickHouse Cloud service connect button

Choose HTTPS, and the details are available in an example curl command.

ClickHouse Cloud HTTPS connection details

If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.


以下は、ClickHouseにHTTP(S)で接続するために必要な情報です:

  • HOSTとPORT: 通常、TLSを使用する場合はポートが8443、使用しない場合は8123です。

  • DATABASE NAME: デフォルトでは、defaultという名前のデータベースがあります。接続したいデータベースの名前を使用します。

  • USERNAMEとPASSWORD: デフォルトでは、ユーザー名はdefaultです。使用ケースに適したユーザー名を使用します。

ClickHouse Cloudサービスの詳細は、ClickHouse Cloudコンソールで確認できます。 接続するサービスを選択し、Connectをクリックしてください:

ClickHouse Cloud service connect button

HTTPSを選択すると、詳細はexample curlコマンドで確認できます。

ClickHouse Cloud HTTPS connection details

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

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

  1. Supersetは、ClickHouseに接続するためにclickhouse-connectドライバーを使用します。clickhouse-connectの詳細はhttps://pypi.org/project/clickhouse-connect/にあり、以下のコマンドでインストールできます:
pip install clickhouse-connect
  1. Supersetを開始(または再起動)します。

3. SupersetをClickHouseに接続する

  1. Superset内で、上部メニューからデータを選択し、ドロップダウンメニューからデータベースを選択します。+ データベースボタンをクリックして新しいデータベースを追加します:
データベースメニューに+ データベースボタンがハイライトされたSupersetインターフェース

  1. 最初のステップでは、データベースのタイプとしてClickHouse Connectを選択します:
ClickHouse Connectオプションが選択されたSupersetデータベース接続ウィザード

  1. 2番目のステップで:
  • SSLをオンまたはオフに設定します。
  • 前に収集した接続情報を入力します。
  • 表示名を指定します:これはお好みの名前にできます。複数のClickHouseデータベースに接続する場合は、より説明的な名前をつけてください。
ClickHouse接続パラメーターを示すSuperset接続設定フォーム

  1. 接続ボタンと次に完了ボタンをクリックしてセットアップウィザードを完了させると、データベースのリストにあなたのデータベースが表示されるはずです。

4. データセットを追加する

  1. SupersetでClickHouseデータと対話するには、データセットを定義する必要があります。Supersetの上部メニューからデータを選択し、ドロップダウンメニューからデータセットを選択します。

  2. データセットを追加するボタンをクリックします。データソースとして新しいデータベースを選択すると、そのデータベースで定義されたテーブルが表示されます:

ClickHouseデータベースからの利用可能なテーブルを示すSupersetデータセット作成ダイアログ

  1. ダイアログウィンドウの下部にある追加ボタンをクリックすると、テーブルがデータセットのリストに表示されます。ダッシュボードを構築し、ClickHouseデータを分析する準備が整いました!

5. Supersetでのチャートとダッシュボードの作成

Supersetに慣れている方には、このセクションは楽に感じられるでしょう。Supersetが初めての方へ...他の素晴らしい可視化ツールと同様に、始めるのはあまり時間がかかりませんが、詳細やニュアンスはツールを使用する中で徐々に学ばれていきます。

  1. ダッシュボードから始めます。Supersetの上部メニューからダッシュボードを選択します。右上のボタンをクリックして新しいダッシュボードを追加します。以下のダッシュボードはUK property pricesと名付けられています:
チャート追加の準備が整ったUK property pricesという名前の空のSupersetダッシュボード

  1. 新しいチャートを作成するには、上部メニューからチャートを選択し、新しいチャートを追加するボタンをクリックします。多くのオプションが表示されます。以下の例では、CHOOSE A DATASETドロップダウンからのuk_price_paidデータセットを使用した円グラフの例です:
円グラフの視覚化タイプが選択されたSupersetチャート作成インターフェース

  1. Supersetの円グラフには次元メトリックが必要で、他の設定はオプションです。次元とメトリックのフィールドを自分で選ぶことができます。この例では、次元としてClickHouseフィールドdistrictを、メトリックとしてAVG(price)を使用しています。
円グラフ用に選択されたdistrictフィールドを示す次元設定
円グラフ用の集計関数AVG(price)を示すメトリック設定

  1. 円グラフよりもドーナツグラフを好む場合は、カスタマイズの下で設定できます:
ドーナツグラフオプションと他の円グラフ設定を示すカスタマイズパネル

  1. 保存ボタンをクリックしてチャートを保存し、次にADD TO DASHBOARDドロップダウンからUK property pricesを選択し、SAVE & GO TO DASHBOARDをクリックするとチャートが保存され、ダッシュボードに追加されます:
ダッシュボード選択ドロップダウンとSave & Go to Dashboardボタンを含むチャート保存ダイアログ

  1. これで完了です。ClickHouseのデータに基づくSupersetでのダッシュボードの構築は、驚異的に速いデータ分析の世界を開きます!
ClickHouseからのUKプロパティ価格データのさまざまな視覚化が含まれる完成したSupersetダッシュボード