SQL エディターでのクエリの作成とデータの探索

Azure Databricks UI には、クエリの作成、使用可能なデータの参照、視覚化の作成に使用できる SQL エディターが用意されています。 保存したクエリをワークスペース内の他のチーム メンバーと共有することもできます。 この記事では、SQL エディターを使用してクエリの記述、実行、管理を行う方法について説明します。 新しいバージョンの SQL エディターがパブリック プレビュー段階にあります。 新しい SQL エディターを有効にして操作する方法については、「 新しい SQL エディターを使用して同僚と連携するを参照してください。

エディターを開いた後は、SQL クエリを作成したり、使用可能なデータを参照したりできます。 テキスト エディターでは、オートコンプリート、自動書式設定、その他のさまざまなキーボード ショートカットがサポートされています。

テキスト エディターの上部にあるクエリ タブを使用して、複数のクエリを開くことができます。 各クエリ タブには、クエリを実行したり、クエリをお気に入りに登録したり、SQL ウェアハウスに接続したりするためのコントロールがあります。 クエリの保存、スケジュール、共有を行うこともできます。

SQL エディターを開きます。

Azure Databricks UI で SQL エディターを開くには、サイドバーの [SQL Editor] をクリックします。

SQL エディターが開き、最後に開いたクエリが表示されます。 クエリが存在しない場合、またはすべてのクエリが明示的に閉じられている場合は、新しいクエリが開きます。 New Query という名前が自動的に付けられ作成タイムスタンプがタイトルに追加されます。

コンピューティングに接続

クエリを実行するには、少なくとも実行中の SQL ウェアハウスに対する CAN USE アクセス許可が必要です。 エディターの上部付近にあるドロップダウンを使用して、使用可能なオプションを表示できます。 一覧をフィルター処理するには、テキスト ボックスにテキストを入力します。

クエリを初めて作成するときは、使用可能な SQL ウェアハウスの一覧がアルファベット順に表示されます。 次にクエリを作成するときは、最後に使用した SQL ウェアハウスが選択されます。

SQL ウェアハウスの横にあるアイコンは、次の状態を示します。

• 実行中
• 開始中
• 停止

選択した SQL ウェアハウスは、クエリの実行時に自動的に再起動されます。 SQL ウェアハウスを開始するその他の方法については、「ウェアハウスを開始する」を参照してください。

SQL エディターでデータ オブジェクトを参照する

メタデータの読み取りアクセス許可がある場合は、SQL エディター内のスキーマ ブラウザーに使用可能なデータベースとテーブルが表示されます。 Catalog Explorer からデータ オブジェクトを参照することもできます。

アクティブなコンピューティングを使用せずに、カタログ エクスプローラーで Unity Catalog 管理データベース オブジェクト間を移動できます。 hive_metastore および他のカタログ (Unity Catalog によって管理されていない) 内のデータを探索するには、適切な権限でコンピューティングにアタッチする必要があります。 Azure Databricks を使用したデータ ガバナンスに関するページを参照してください。

スキーマを更新するには、スキーマ ブラウザーの上部付近にある をクリックします。 検索ボックスにフィルター文字列を入力して、スキーマをフィルター処理できます。

テーブル名をクリックすると、そのテーブルの列が表示されます。

クエリを作成する

SQL エディターでテキストを入力してクエリを作成できます。 スキーマ ブラウザーから要素を挿入して、カタログとテーブルを参照できます。

1. SQL エディターでクエリを入力します。

   SQL エディターではオートコンプリートがサポートされています。 入力すると、オートコンプリートが入力補完を提案します。 たとえば、カーソル位置の有効な入力補完が列である場合、オートコンプリートは列名を提案します。 「select * from table_name as t where t.」と入力した場合、オートコンプリートでは t が table_name の別名であると認識して、table_name 内の列を提案します。

   

2. (省略可能) 編集を完了したら、[保存] をクリックします。 既定では、クエリはユーザーのホーム フォルダーに保存されますが、別の場所を選択してもかまいません。 その後、 [保存] をクリックします。

データソースの問合せ

クエリ自体で 完全修飾テーブル名 を使用するか、ドロップダウン セレクターからカタログとスキーマの組み合わせをクエリ内のテーブル名と共に選択することで、クエリ ソースを識別できます。 クエリの完全修飾テーブル名は、SQL エディターのカタログおよびスキーマ セレクターをオーバーライドします。 テーブルまたは列名にスペースが含まれている場合は、SQL クエリのバックティックでそれらの識別子をラップします。

次の例では、カタログに格納できるさまざまなテーブルのようなオブジェクトに対してクエリを実行する方法を示します。

標準のテーブルまたはビューのクエリを実行する

次の例では、 samples カタログからテーブルを照会します。

SELECT
  o_orderdate,
  o_orderkey,
  o_custkey,
  o_totalprice,
  o_shippriority
FROM
  samples.tpch.orders

メトリック ビューのクエリを実行する

次の例では、サンプル カタログのテーブルをソースとして使用するメトリック ビューに対してクエリを実行します。 3 つの指標が評価され、Order Month と Order Status にわたり集計されます。 Order Monthで並べ替えられた結果が返されます。 ワークスペースで同様のメトリック ビューを作成するには、「 メトリック ビューの作成」を参照してください。

SELECT
 `Order Month`,
 `Order Status`,
 MEASURE(`Order Count`),
 MEASURE(`Total Revenue`),
 MEASURE(`Total Revenue per Customer`)
FROM
 orders_metric_view
GROUP BY ALL
ORDER BY 1 ASC;

オートコンプリートのオンとオフを切り替える

ライブ オートコンプリートでは、スキーマ トークン、クエリ構文識別子 (SELECT や JOIN など)、クエリ スニペットのタイトルを補完できます。 データベース スキーマが 5,000 個のトークン (テーブルまたは列) を超えない限り、既定で有効になります。

ライブ オートコンプリートを無効または有効にするには、SQL エディターの下にあるトグルを使用します。

• ライブ オートコンプリートを無効にするには、Ctrl + Space キーを押すか、SQL エディターの下にある ボタンをクリックします。

Databricks Assistant を使用してクエリを最適化する

/optimizeスラッシュ コマンドは、クエリの評価と最適化をアシスタントに求めます。 詳細については、「 Python、PySpark、SQL コードの最適化」を参照してください。

クエリを保存する

SQL エディターの右上にある [保存] ボタンをにより、クエリが保存されます。

複数のクエリを編集する

既定では、SQL エディターではタブが使用されるため、複数のクエリを同時に編集できます。 新しいタブを開く場合は、+ をクリックし、[Create new query](新しいクエリの作成) または [Open existing query](既存のクエリを開く) を選択します。 [既存のクエリを開く] をクリックして、保存されたクエリの一覧を表示します。 [マイ クエリ] または [お気に入り] をクリックして、クエリの一覧をフィルター処理します。 表示するクエリを含む行で、[開く] をクリックします。

1 つのクエリまたは複数のクエリを実行する

1 つのクエリまたはすべてのクエリを実行するには:

1. SQL ウェアハウスを選択します。

2. SQL エディターでクエリを強調表示します (クエリ ペインに複数のクエリがある場合)。

3. Ctrl/Cmd + Enter キーを押すか、[Run (1000)](実行 (1000)) をクリックして、結果を結果ペインにテーブルとして表示します。

   

クエリを終了する

実行中にクエリを終了するには、[キャンセル] をクリックします。 管理者は、「実行中のクエリの終了」を参照して、別のユーザーによって開始された実行中のクエリを停止できます。

クエリ オプション

を使用できます。クエリ エディターの上部付近にある kebab コンテキスト メニューを使用すると、クエリ情報の複製、元に戻す、書式設定、編集するためのメニュー オプションにアクセスできます。

保存したクエリに戻す

クエリを編集すると、クエリのコンテキスト メニューに変更を元に戻すオプションが表示されます。 [元に戻す] をクリックすると、保存したバージョンに戻ることができます。

クエリの破棄と復元

クエリをごみ箱に移動するには:

• Kebab コンテキスト メニューの をクリックします。SQL エディターのクエリの横にある [ ごみ箱に移動] を選択します。
• [ごみ箱に移動] をクリックして確定します。

クエリをごみ箱から復元するには:

1. [すべてのクエリ] リストで をクリックします。
2. クエリをクリックします。
3. Kebab コンテキスト メニューの をクリックします。SQL エディターの右上にある [ 復元] をクリックします。

クエリの説明を設定し、クエリ情報を表示する

クエリの説明を設定するには:

1. をクリックします。クエリの横にある kebab コンテキスト メニューをクリックし、[クエリ情報の編集] をクリックします。

   

2. [説明] テキスト ボックスに説明を入力します。 その後、 [保存] をクリックします。 このダイアログでは、クエリの作成と更新の時期などの履歴を表示することもできます。

クエリのお気に入り登録とタグ付け

お気に入りとタグを使用して、ワークスペース ランディング ページと、ダッシュボードおよびクエリの各一覧ページに表示される、クエリとダッシュボードのリストをフィルター処理できます。

お気に入り: クエリをお気に入りに追加するには、クエリの一覧で、タイトルの左側にある星をクリックします。 星が黄色に変わります。

タグ: 組織にとって意味のある任意の文字列で、クエリとダッシュボードにタグ付けできます。

タグの追加

クエリ エディターでタグを追加します。

1. をクリックします。クエリの横にある kebab コンテキスト メニューをクリックし、[クエリ情報の編集] をクリックします。 [クエリ情報] ダイアログが表示されます。

2. クエリにタグが適用されていない場合は、タグが表示されるテキスト ボックスに [Add some tags] (タグの追加) と表示されます。 新しいタグを作成するには、ボックスに入力します。 複数のタグを入力するには、エントリ間で Tab キーを押します。

   

3. [保存] をクリックしてタグを適用し、ダイアログを閉じます。

タグを削除する

1. をクリックします。クエリの横にある kebab コンテキスト メニューをクリックし、[クエリ情報の編集] をクリックします。
2. 削除するタグの [X] をクリックします。
3. [保存] をクリックしてダイアログを閉じます。

クエリ結果を表示する

クエリを実行すると、その下のペインに結果が表示されます。 新しいクエリに対して [New result table] (新しい結果テーブル) がオンになっています。 必要に応じて、ドロップダウンをクリックしてオフにします。 このセクションの画像では、新しい結果テーブルを使用しています。

結果ウィンドウを使用して、クエリの結果を操作したり探索したりできます。 結果ウィンドウには、結果を探索するための次の機能があります。

視覚化、フィルター、パラメーター

をクリックして、視覚化、フィルター、またはパラメーターを追加します。 以下のオプションが表示されます。

視覚化: 視覚化は、結果セットを探索するのに役立ちます。 使用可能な視覚化の種類の完全な一覧については、「視覚化の種類」を参照してください。

フィルター: フィルターを使用すると、クエリの実行後に結果セットを制限できます。 フィルターを適用して、データのさまざまなサブセットを選択的に表示できます。 フィルターの使用方法については、「クエリのフィルター」を参照してください。

パラメーター: パラメーターを使用すると、実行時にクエリに値を代入することで、結果セットを制限できます。 パラメーターを適用する方法については、「クエリ パラメーターの操作」を参照してください。

ダッシュボードで編集、ダウンロード、または追加を行う

結果タブで をクリックすると、その他のオプションが表示されます。

1. [編集] をクリックして、視覚化に表示される結果をカスタマイズします。
2. [削除] をクリックして結果のタブを削除します。
3. [重複] をクリックして、結果のタブを複製します。
4. [ダッシュボードに追加] をクリックして、クエリと視覚化を新しいダッシュボードにコピーします。
   • このアクションを行うと、クエリに関連するすべての視覚化を含む新しいダッシュボードが作成されます。 ダッシュボードを編集する方法については、「ダッシュボード」を参照してください。
   • 新しいダッシュボードの名前を選択するように求められます。 新しいダッシュボードはホーム フォルダーに保存されます。
   • 既存のダッシュボードに結果を追加することはできません。
5. [Add to legacy dashboard] (レガシ ダッシュボードに追加) をクリックして、結果のタブを新規または既存のレガシ ダッシュボードに追加します。
6. ダウンロード オプションのいずれかをクリックして結果をダウンロードします。 詳細と制限については、この後の説明を参照してください。

結果のダウンロード: 結果は、CSV、TSV、または Excel ファイルとしてダウンロードできます。

Databricks SQL から CSV および TSV 形式では最大約 1 GB の結果データを、Excel ファイルには最大 100,000 行をダウンロードできます。

最終的なファイル ダウンロードよりも前の手順に 1 GB の制限が適用されるため、最終的なファイル ダウンロード サイズは 1 GB よりも多少増減する場合があります。

過去の実行

完全なクエリ構文を含め、以前のクエリの実行を表示できます。 過去の実行は読み取り専用モードで開き、新しいクエリに複製または編集を再開するボタンがあります。 このタブには、スケジュールされた実行は表示されません。

結果を探索する

返されたクエリ結果は、クエリの下に表示されます。 [Raw results] (生の結果) タブには、返された行が設定されます。 組み込みのフィルターを使用して、値の昇順または降順で結果を並べ替えることができます。 フィルターを使用して、特定の値を含む結果行を検索することもできます。

結果ウィンドウのタブを使用して、視覚化、フィルター、パラメーターを追加できます。

クエリ ウィンドウで保存されたクエリの一覧をフィルター処理する

クエリ ウィンドウで、作成したクエリの一覧 (マイ クエリ)、お気に入り、タグを使用してすべてのクエリの一覧をフィルター処理できます。

更新の自動化

[スケジュール] ボタンを使用して、クエリ実行の自動周期を設定できます。 自動更新は、最新のデータを使用してダッシュボードとレポートを最新の状態に保つのに役立ちます。 スケジュールされたクエリでは、Databricks SQL アラートを有効にすることもできます。これは、値が指定されたしきい値に達したときに通知を送信する特殊な種類のスケジュールされたタスクです。

「クエリのスケジュールを設定する」をご覧ください。

Databricks SQL アラートを参照してください。

クエリを共有する

[共有] ボタンを使用すると、ワークスペース内の他のユーザーとクエリを共有できます。 共有する場合は、次のいずれかのオプションを選択します。

• 所有者 (所有者の資格情報) として実行: この設定は、閲覧者がクエリ所有者と同じクエリ結果を表示できることを意味します。 これは、スケジュールされたクエリ実行または手動クエリ実行に適用されます。
• ビューアーとして実行 (閲覧者の資格情報): この設定では、結果がビューアーに割り当てられたアクセス許可に制限されます。

「クエリのアクセス許可を構成する」を参照してください。

次のステップ

Azure Databricks UI を使用してクエリを操作する方法について、「保存されたクエリにアクセスして管理する」を参照してください。