Databricks SQLのダッシュボード

Databricks SQL dashboards | Databricks on AWS [2022/3/10時点]の翻訳です。

本書は抄訳であり内容の正確性を保証するものではありません。正確な内容に関しては原文を参照ください。

Databricks SQLのダッシュボードを用いることで、ビジュアライゼーションとデータのコンテキストを与えるテキストボックスを組み合わせることができます。

保存されたダッシュボードの一覧

保存されているダッシュボードの一覧を参照するには、サイドバーのDashboardsをクリックします。デフォルトでは、ダッシュボードはCreated Byカラムにを用いて新しい順でソートされています。カラムのヘッダーをクリックすることでリストを並び替えることができます。

保存されたダッシュボードのフィルタリング

自分で作成したダッシュボード(My Dashboards)、お気に入り、タグでダッシュボード一覧をフィルタリングすることができます。

ダッシュボードの作成

新規ダッシュボードを作成するには以下のステップを実行します。既存のダッシュボードをクローンするには、ダッシュボードのクローンをご覧ください。

1. 以下のいずれかを実行します。
   • サイドバーのCreateをクリックしてDashboardを選択します。
   • Dashboardsをクリックして、+ New Dashboardボタンをクリックします。
   • 空のダッシュボードからスタートしたくないのであれば、クイックダッシュボードを作成することができます。
     • サイドバーのDatabricks SQL dashboards | Databricks on AWSDataをクリックします。
     • テーブルをブラウズし、Create > Quick Dashboardをクリックします。
     • 設定ページでは興味のあるカラムを選択し、これらのカラムを用いていくつかの基本的な情報を提供するクエリーとダッシュボードを作成し、ダッシュボードレベルのパラメーターや他の機能を表示します。
     • ダッシュボードをカスタマイズするには以下の手順を続けます。
2. ダッシュボード名を入力します。
3. ダッシュボードのコンテンツを追加します。
   • コメントを追加するにはAdd Textboxをクリックします。
     テキストを入力します。マークダウンを用いてテキストを修飾することができます。ダッシュボードのテキストボックスに静的な画像を追加するには、マークダウンイメージの構文![alt-text](<image-url>)を使用します。
   • クエリーのビジュアライゼーションを追加するには、Add Widgetをクリックします。
     1. クエリーを選択します。既存のクエリーを検索するか、一覧から最近使用したものを選択します。
     2. Choose Visualizationドロップダウンからビジュアライゼーションのタイプを選択します。
        
4. Add to Dashboardをクリックします。
   
5. ダッシュボードのコンテンツブロックをドラッグ&ドロップします。
6. Done Editingをクリックします。
   

ダッシュボードのクローン

ダッシュボードとそれに含まれるクエリーに対して、Can Run、Can Edit、Can Manage権限を持っているのであれば、ダッシュボードとクエリーをクローンすることができます。あなたが、クローンした新規ダッシュボードとクエリーのオーナーになります。

重要！
共有設定、アラート、サブスクリプションは新規ダッシュボードにはコピーされません。

ダッシュボードをクローンするには以下を実行します。

1. ダッシュボードの右上のをクリックし、Cloneを選択します。
2. 新規ダッシュボードの名前を入力し、Confirmをクリックします。

ダッシュボードからコンテンツを削除

1. ウィジェットの右上のをクリックし、Remove from Dashboardを選択します。
2. Deleteをクリックします。

ダッシュボードの編集

ダッシュボードを編集するには、ダッシュボードの右上のをクリックし、Editを選択します。

編集中はコンテンツを追加削除したり、フィルタリングを適用することができます。表示するパラメーターの並びを変更するには、希望の位置にそれぞれのパラメーターをドラッグ&ドロップします。

ダッシュボードにコンテンツを追加

1. ダッシュボードを編集モードで開きます。
2. Add TextboxかAdd Widgetをクリックします。
3. Add to Dashboardをクリックします。
4. Done Editingをクリックします。

SQLエディタでビジュアライゼーションをダッシュボードに追加することもできます。

ダッシュボードからコンテンツを削除

1. をクリックするか、オブジェクトの上にマウスカーソルを移動し、ウィジェットの右上のをクリックし、Remove from Dashboardを選択します。
2. Deleteをクリックします。

ダッシュボードのフィルター

クエリーにフィルターを含み、ダッシュボードレベルでフィルターを適用する必要がある場合があります。全てのクエリーにフィルターを適用するにはUse Dashboard Level Filtersを選択します。

ダッシュボードの色のカスタマイズ

ダッシュボードのカラーパレットをカスタマイズすることができます。

カラーパレットの作成

ダッシュボードのカスタムカラーパレットを作成するには以下を実行します。

1. 右上のをクリックし、Editをクリックします。
2. Colorsをクリックします。
3. 既存のカラーパレットをインポートするには、Importをクリックしパレットを選択します。インポートしたパレットをカスタマイズできます。
4. 新規のパレットを作成するか、インポートしたパレットをカスタマイズするには以下を実行します。
   1. 新規の色を追加するには、Addをクリックします。
   2. 新規追加した色あるいは既存の色に対しては、以下のいずれかを実行して色を指定します。
      • 四角をクリックし、カラーセレクターから色を選択するか、スポイトを使用して色を選択します。
      • 四角の隣のテキストフィールドをクリックして16進数を入力します。
5. Applyをクリックします。

カスタムカラーパレットの使用をやめる

カスタムカラーパレットを削除するには以下を実行します。

1. 右上のをクリックし、Editをクリックします。
2. Colorsをクリックします。
3. Clearをクリックします。
4. Applyをクリックします。

ビジュアライゼーションの色のカスタマイズ

ビジュアライゼーションの色をカスタマイズするには、Customize colors for a visualizationをご覧ください。

デフォルトでは、カラーパレットはダッシュボードに適用され、ビジュアライゼーションはビジュアライゼーションに指定した色ではなく、ダッシュボードのカラーパレットを使用します。この挙動を上書きするには以下を実行します。

1. ダッシュボード上のビジュアライゼーションのをクリックし、Editをクリックします。
2. ビジュアライゼーションのRetain colors specifiedのチェックボックスを選択します。
3. OKをクリックします。

詳細はCustomize colors for a visualizationをご覧ください。

ダッシュボードの更新

ダッシュボードは、クエリーが実行される度に更新されるキャッシュからデータを取得するので高速にロードされます。しかし、クエリーを最近実行していない場合、ダッシュボードが古い結果を表示する場合があります。幾つかのクエリーのみが最近実行された場合には、ダッシュボードに新しいデータと古いデータが混在することもあり得ます。

手動でダッシュボードを更新するか、スケジュール実行で更新されると、ダッシュボードで使われている前段のクエリーは、パラメーターを含み全てが更新されます。個々のビジュアライゼーションが更新されると、パラメーターを含む前段のクエリー全てが更新されます。

手動によるダッシュボードの更新

更新を強制するには、ダッシュボード右上のRefreshボタンをクリックします。これは、ダッシュボードの全てのクエリーを実行し、ビジュアライゼーションを更新します。

ダッシュボードの自動更新

ダッシュボードのオーナーとCan Edit権限を持つユーザーが、スケジュールに基づき自動でダッシュボードが更新されるように設定することができます。自動でダッシュボードが更新されるようにするには以下を実行します。

1. ダッシュボード右上のScheduleボタンをクリックします。スケジュールのダイアログ画面が表示されます。
   
2. Refresh everyドロップダウンで期間を選択します。
3. SQL Endpointドロップダウンで、全てのクエリーで使用するSQLエンドポイントを選択します。これはオプションです。エンドポイントを選択しない場合、最後に使用されたSQLエンドポイントを用いてクエリーを実行します。
4. Subscribersの隣には、ダッシュボードが自動で更新された際に通知を行いたいメールアドレスのリストを入力します。これはオプションです。
   入力するアドレスはDatabricksのアカウントと関連づけられるか、アラートの宛先として設定されている必要があります。
5. Saveをクリックします。ScheduleボタンのラベルがScheduledに変化します。

ダッシュボードスナップショットのサブスクリプション

ダッシュボードのスナップショットを定期的にエクスポートし、メールで送信することができます。ダッシュボードのスナップショットは、フィルターやビジュアライゼーションが操作されていないデフォルトのダッシュボードの状態から取得されます。

ダッシュボードのオーナー、あるいはCan Edit権限を持っているのであれば、更新処理のスケジュールの作成や、更新の都度ダッシュボードのスナップショットをメールで受け取る購読者の追加を行うことができます。

注意
Can Edit権限を持っている場合、ダッシュボードにアクセスできるユーザー、あるいはすでにアラートの宛先として登録されているユーザーのみを購読者として登録することができます。Can Manage権限を持っているのであれば、ワークスペースにアクセスできる任意のユーザーを購読者として登録することができます。

購読者を追加するには、Subscribersフィールドに1つ以上のダッシュボードユーザー、アラート宛先のメールアドレスを入力します。

ダッシュボードに対してCan ViewかCan Edit権限を持っているのであれば、既存の更新スケジュールをサブスクライブすることができます。サブスクライブするには、Subscribeボタンをクリックします。

一時的にダッシュボードのスケジュール更新を停止

ダッシュボードに自動更新の設定がされている場合、右上にはScheduleボタンではなくScheduledボタンが表示されます。ダッシュボードの更新と購読者へのエクスポートを一時的に停止することができます。これによって、ダッシュボードの変更をテストしている間に更新を送信してしまうことを回避できます。購読者のリストを変更することなしに、定期更新の処理を一時的に停止するには以下を実施します。

1. Scheduledをクリックします。
2. Enabledトグルをクリックします。
3. Saveをクリックします。

ダッシュボードの自動更新を停止

ダッシュボードに自動更新の設定がされている場合、右上にはScheduleボタンではなくScheduledボタンが表示されます。自動更新を停止し、購読者を削除するには以下を実行します。

1. Scheduledをクリックします。
2. Refresh everyドロップダウンでNeverを選択します。
3. Saveをクリックします。ScheduledボタンのラベルがScheduleに変化します。

PDFとしてダウンロード

ダッシュボードをPDFファイルとしてダウンロードするには、ダッシュボード右上のをクリックしDownload as PDFを選択します。

ダッシュボードをゴミ箱に移動する

ダッシュボードをゴミ箱に移動するには、ダッシュボード右上のをクリックしMove to Trashをクリックします。確認メッセージに対してMove to Trashをクリックします。

ゴミ箱からダッシュボードを復帰させる

1. サイドバーのDashboardsをクリックします。
2. をクリックします。
3. ダッシュボードをクリックします。
4. ダッシュボード右上のをクリックしRestoreを選択します。

恒久的にダッシュボードを削除する

1. 全ダッシュボード一覧でをクリックします。
2. ダッシュボードをクリックします。
3. ダッシュボード右上のをクリックしDeleteを選択します。

クエリーを開く

ウィジェットで表示されているクエリーをSQLエディタで開くには、ウィジェットの右上のをクリックし、View Queryを選択します。

ダッシュボードのアクセス権を設定する

誰がダッシュボードを管理、実行できるのかを設定するには、Databricks SQLダッシュボードのアクセスコントロールをご覧ください。

管理者ビューへのアクセス

Databricksの管理者ユーザーは全てのダッシュボードに対する参照権限を持っています。このビューでは、管理者はいかなるダッシュボードも参照、削除することができます。しかし、管理者に共有されていないダッシュボードを編集することはできません。

全てのダッシュボードを参照するには以下を実行します。

1. サイドバーのDashboardsをクリックします。
2. 右側のパネルのAdmin Viewをクリックします。

ダッシュボードのオーナーシップの移譲

ダッシュボードのオーナーがワークスペースから削除されると、ダッシュボードのオーナーが存在しなくなり、管理者ユーザーのみがダッシュボードのアクセス権を管理することができるようになります。管理者ユーザーは、オーナーのないダッシュボードを含む任意のダッシュボードのオーナーシップを別のユーザーに移譲することができます。Databricks SQLのUIを用いてオーナーシップを移譲するには以下を実施します。

1. ダッシュボードを開きます。
2. Shareをクリックします。
3. Assign new ownerをクリックします。
4. ドロップダウンからオーナーにしたいユーザーを選択し、Confirmをクリックします。

REST APIを用いてオーナーシップを移譲するには、Transfer ownership of a dashboardをご覧ください。

以前はダッシュボードのオーナーだったユーザーは、ダッシュボードに対するCan Manage権限を失い、Can Manage権限を与えたユーザーが新たなオーナーになります。

Databricks 無料トライアル

Databricks 無料トライアル