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

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、TLSを使用しない場合は8123です。

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

  • USERNAMEとPASSWORD: デフォルトでは、ユーザー名はdefaultです。ご利用のケースに適したユーザー名を使用してください。

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

ClickHouse Cloud service connect button

HTTPSを選択すると、詳細が例のcurlコマンドで提供されます。

ClickHouse Cloud HTTPS connection details

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

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

  1. SupersetはClickHouseに接続するためにclickhouse-connectドライバーを使用します。clickhouse-connectの詳細はhttps://pypi.org/project/clickhouse-connect/で確認でき、次のコマンドでインストールできます:

  2. Supersetを起動(または再起動)します。

3. SupersetをClickHouseに接続する

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

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

  1. 二番目のステップでは:
  • SSLをオンまたはオフに設定します。
  • 以前に収集した接続情報を入力します。
  • DISPLAY NAMEを指定します:これは任意の名前で構いません。他の複数のClickHouseデータベースに接続する場合は、より説明的な名前を付けてください。
ClickHouse接続パラメーターを示すSuperset接続構成フォーム

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

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

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

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

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

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

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

Supersetに慣れている方は、次のセクションをすぐに理解できるでしょう。Supersetが初めての方は...世界の他の多くのクールな可視化ツールのように、始めるのにそれほど時間はかかりませんが、詳細やニュアンスは使用しながら学んでいくことになります。

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

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

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

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

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

  1. 以上です。ClickHouseのデータに基づいてSupersetでダッシュボードを構築することで、高速なデータ分析の新しい世界が広がります!
ClickHouseからのUK不動産価格データの複数のビジュアライゼーションを含む完成したSupersetダッシュボード