新しい SQL エディターでクエリを記述し、データを探索する

Databricks UI には、クエリの作成、同僚との共同作業、使用可能なデータの参照、視覚化の作成に使用できる SQL エディターが含まれています。 このページでは、SQL エディターを使用してクエリの記述、実行、管理、共有を行う方法について説明します。

この記事では、新しい SQL エディターの使用方法について説明します。 従来の SQL エディターを使用する方法については、従来の SQL エディター でのクエリの記述とデータの探索に関するページを参照してください。

SQL エディターを開く

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

SQL エディターで最後に開いたクエリが表示されます。 クエリが存在しない場合、またはすべてのクエリが明示的に閉じられている場合は、SQL エディターのランディング ページが開きます。

新しい SQL エディターを有効にする

新しいエディターを有効にするには、カタログとスキーマのドロップダウン セレクターの右側にある [新しい SQL エディター] トグルを使用します。 狭い画面では、カタログとスキーマ セレクターの右側にある kebab メニューの をクリックすると、[Kebab menu icon.新しい SQL エディター] トグルが表示されます。

所有するすべてのクエリに対して新しいエディターを有効にします。

• [新しい SQL エディター: オフ] をクリックします。 [新しい SQL エディター] ポップオーバー メニューが開きます。
  • [すべてのクエリに適用する] チェック ボックスは既定でオンになっています。 自分が所有するすべてのクエリに対してエディターを有効にするには、この設定をそのままにします。
  • アクティブなクエリに対してのみ新しいエディターを有効にするには、[すべてのクエリに適用する] チェック ボックスをオフにします。
• [新しい SQL エディター] トグルを [オン] に設定します。

新しい SQL エディターをすべてのクエリに使用することはできません。 次のいずれかに該当する場合、クエリを新しい SQL エディターに切り替えることはできません。

• 自分が所有するクエリではありません。
• クエリには、サポートされていない クエリ ベースのドロップダウン リストが含まれています。 「クエリ パラメーターの操作」をご覧ください。

新しい SQL エディターを有効にすると、クエリが新しい UI で開き直されます。 クエリを実行するまで、結果セットは空です。

オリエンテーション

このセクションでは、UI の主な違いを明らかにし、利用できる機能を見つけて使う方法について説明します。

1. ワークスペースのファイル システムにアクセスする: SQL エディターからワークスペース オブジェクトに直接アクセスして整理できます。
2. 統合された Databricks Assistant を使用する: アシスタントとチャットして、クエリの作成、改善、理解に役立てます。 アシスタントによって生成されたコードをサイド パネルから実行します。
3. コードのセクションを折りたたむ: コード ブロックの左側にある折りたたみ矢印をクリックして、選んだコード セクションを非表示にするか展開します。 これにより、大きなファイルの処理がいっそう容易になります。
4. コマンド パレットを開く: コマンド パレットには、一般的な操作、キーボード ショートカット、カスタム テーマ、必要なものをすばやく見つけるのに役立つリンクが含まれています。 開いた後、検索バーを使って特定のツールとショートカットを探します。
5. コードにコメントする: コードにコメントを追加して共同作業を円滑にします。
6. バージョン履歴を確認する: クエリに対する最近の変更を確認します。

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

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

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

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

• 実行中
• 停止済み

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

資産を閲覧し、ヘルプを受ける

SQL エディターの左側のウィンドウを使用して、ワークスペース ファイルの参照、データ オブジェクトの表示、Databricks Assitant からのヘルプの取得を行います。

ワークスペース ファイルを参照する

フォルダー をクリックして、ワークスペース のユーザー フォルダーを開きます。 UI のこの部分からアクセスできるすべてのワークスペース ファイル間を移動できます。

データ オブジェクトを参照する

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

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

スキーマを更新するには、スキーマ ブラウザーの上部近くにある をクリックします。 検索バーに入力すると、アセットを名前でフィルター処理できます。 [ をクリックします。フィルター アイコンをクリックして、種類別にオブジェクトをフィルター処理します。

ブラウザーでオブジェクトの名前をクリックすると、オブジェクトの詳細が表示されます。 たとえば、スキーマ名をクリックすると、そのスキーマ内のテーブルが表示されます。 テーブル名をクリックすると、そのテーブル内の列が表示されます。

Databricks Assistant からヘルプを取得する

[ をクリックします。アシスタント アイコンをクリックして、Databricks Assistant でチャット ウィンドウを開きます。 提案された質問をクリックするか、独自の質問を入力して Databricks Assistant と対話します。

クエリを作成する

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で並べ替えられた結果が返されます。 ワークスペースで同様のメトリック ビューを作成するには、「 メトリック ビューの作成」を参照してください。

すべてのメジャー評価は MEASURE 関数にラップされる必要があります。 集計関数measure参照してください。

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;

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

エディターの右側にあるアシスタントアイコンで、クエリを書く際にインラインのヘルプや提案を得ることができます。 /optimizeスラッシュ コマンドは、クエリの評価と最適化をアシスタントに求めます。 詳細については、「 Python、PySpark、SQL コードの最適化」を参照してください。

複数のクエリ タブを編集する

既定では、SQL エディターではタブが使用されるため、複数のクエリを同時に開いて編集できます。 新しいタブを開く場合は、+ をクリックし、[Create new query]\(新しいクエリの作成\) または [Open existing query]\(既存のクエリを開く\) を選択します。 [ 既存のクエリを開く ] をクリックすると、クエリの一覧が表示されます。 [ For you ] タブには、使用状況に基づいて厳選された一覧が表示されます。 [ すべて ] タブを使用して、アクセスできるクエリを検索します。

1 つのクエリまたは複数ステートメントのクエリを実行する

複数ステートメントのクエリを 1 つのエディター タブに記述できます。1 つのタブで複数のクエリ ステートメントを使用するには、各ステートメントをセミコロン (;) で終えます。

1 つのクエリを実行するには:

1. SQL ウェアハウスを選択します。
2. SQL エディターでクエリを強調表示にします (クエリ ペインに複数のクエリがある場合)。
3. Ctrl/Cmd + Enter キーを押すか、[Run (1000)](実行 (1000)) をクリックして、結果を結果ペインにテーブルとして表示します。

クエリを終了する

実行中にクエリを終了するには、[ キャンセル] をクリックします。 管理者は、実行中のクエリの終了を表示することで、別のユーザーが開始した 実行中のクエリを停止できます。

クエリを共有する

新しい SQL エディターでは、2 つの部分でアクセス許可が処理されます。

対話形式の実行: 新しい SQL エディターのクエリは、常に閲覧者として実行の資格情報を使って実行されます。 クエリにアクセスできるすべてのユーザーが、クエリ結果にアクセスできます。 CAN EDIT アクセス許可以上を持つユーザーは、共有されているクエリの下書きを変更できます。 また、CAN VIEW アクセス許可以上を持つユーザーは、保存されていない編集を見ることができます。 クエリを実行するには、ユーザーは関連付けられたウェアハウスに対する少なくとも CAN USE アクセス許可が必要です。

資格情報の設定: 従来のアラート、 ワークフロー、およびレガシ ダッシュボードのアクセス許可設定は、従来の SQL エディターのアクセス許可設定と同じです。 これらの資産は、設定に応じて、所有者またはビューアーの資格情報を使用して実行できます。

所有者として実行および閲覧者として実行の資格情報の設定については、「クエリのアクセス許可を構成する」をご覧ください。 クエリ オブジェクトへのアクセスを管理する方法については、「クエリ ACL」をご覧ください。

リアルタイムでクエリの共同作業を行う

クエリを共有した後は、共同編集機能を使って、クエリの共同作成またはデバッグをリアルタイムで行うことができます。 エディターでは、個々のコード行にコメントを付けて、質問したり、提案を追加したりすることもできます。

クエリをソース管理する

Databricks SQL クエリ ファイル (拡張子: .dbquery.ipynb) は Databricks Git フォルダーでサポートされています。 Git フォルダーを使用すると、クエリ ファイルをソース管理したり、同じ Git リポジトリにアクセスする Git フォルダーを使用して他のワークスペースで共有したりできます。 Databricks Git フォルダー内のクエリをコミットまたは複製した後に新しい SQL エディターをオプトアウトする場合は、予期しない動作を回避するために、その Git フォルダーを削除して再度使用します。

クエリを保存する

新しい SQL エディターでは、クエリの内容が継続して自動的に保存されます。 [保存] ボタンは、下書きのクエリ コンテンツを、従来のダッシュボード、ワークフロー、レガシ アラートなどの関連資産に適用するかどうかを制御します。 クエリが所有者として実行の資格情報を使って共有されている場合は、クエリの所有者のみが [保存] ボタンを使って変更を反映できます。 資格情報が [ビューアーとして実行] に設定されている場合、少なくとも CAN MANAGE アクセス許可を持つユーザーはクエリを保存できます。

クエリの結果を表示する

各ステートメントからの出力を複数の結果ステートメントと比較できます。 1 つの編集ウィンドウから複数の SQL ステートメントを実行しているときは、画面下部の [出力] パネルの UI を使って、異なる結果セットをスクロールできます。

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

視覚化

をクリックして視覚エフェクトを追加します。 視覚化は、結果セットを調べるのに役立ちます。 使用できるすべての視覚化の種類については、「視覚化の種類」をご覧ください。

[視覚化] タブで ] をクリックすると、追加のオプションが表示されます。

• [ ダウンロード ] をクリックして、視覚化で表されるデータを CSV、TSV、または Excel ファイルとしてダウンロードします。
• [ 削除 ] をクリックして視覚化を削除します。
• 結果のタブを複製するには、[複製] をクリックします。
• [ 名前の変更 ] をクリックして視覚化を再タイトルします。

1. [ 編集] をクリックして視覚エフェクトを編集します。

2. [ ダッシュボードに追加] をクリックして、クエリと視覚化を新しい AI/BI ダッシュボードにコピーします。

3. [新しいダッシュボードの作成] または [既存のダッシュボードに追加] を選択します。

   • 新しいダッシュボードを作成します。 クエリに関連付けられているすべての視覚エフェクトを含む新しいダッシュボードを作成します。 新しいダッシュボードの名前の選択を求められます。 新しいダッシュボードはホーム フォルダーに保存されます。
   • 既存のダッシュボードに追加する: クエリと関連する視覚化を既存のダッシュボードに追加します。 ドロップダウン メニューを使用して、データセットと視覚化を追加するダッシュボードを選択します。

結果のダウンロード

結果は CSV または Excel ファイルとしてダウンロードできます。 CSV ダウンロードでは、最大約 5 GB のデータがサポートされます。 ダウンロードオプションを表示するには、結果タブのをクリックしてください。 最終的なファイルのダウンロード サイズは、5 GB の制限が最終的なファイルダウンロードよりも前の手順に適用されるため、5 GB より少し大きいか小さい場合があります。

フィルター

フィルターを使用すると、クエリの実行後に結果セットを制限できます。 フィルターを適用し、データの異なるサブセットを選んで表示できます。 アシスタントを使用すると、結果のフィルターを追加できます。

フィルターを追加するには:

1. [] をクリックします。
2. 適用するフィルターの種類を説明するテキストを入力します。 名前付きフィルターが結果セットに適用されます。

フィルターを編集するには:

1. フィルターの名前をクリックします。
2. ドロップダウン メニューとテキスト フィールドを使用して、フィルター設定を調整します。
3. (省略可能) フィルターで大文字と小文字を区別するには、[大文字と小文字を区別] を選びます。
4. (省略可能)[ OR 条件の追加] をクリックして、フィルターを追加します。

パラメーターを追加する

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

パラメーター構文の変更点

パラメーターをマークするために二重中かっこ ({{}}) を使用する従来の SQL エディターで記述されたクエリは、新しい SQL エディターで実行するように変更する必要があります。 新しい SQL エディターでは、AI/BI ダッシュボード、AI/BI Genie、ノートブックなどの他の Databricks ツールと同じパラメーター構文が使われます。

新しい SQL エディターでは、名前付きパラメーター構文を使ってパラメーターを定義します。 名前付きパラメーターは、クエリ内でコロン (:) が前に付いているパラメーターです (例: :parameter_name)。

SQL リファレンス ドキュメントについては、「名前付きパラメーター マーカー」をご覧ください。 クラシック SQL エディターから名前付きパラメーター マーカーにパラメーター構文を変換する例については、「名前付きパラメーターの構文例」をご覧ください。

サポートされているフィルターの種類

次の表は、新しい SQL エディターでサポートされているフィルターの種類を示しています。 2 番目の列は、従来の SQL エディターでもフィルターが機能するかどうかを示します。

キーボード ショートカットを使用する

新しい SQL エディターには、すばやく作業するのに役立つ多くの組み込みのキーボード ショートカットが含まれています。 次の表は、一般的に使用されるキーボード ショートカットを示しています。

新しい SQL エディターを無効にする

新しい SQL エディターを無効にするには、次の手順のようにします。

• [新しい SQL エディター: オン] をクリックします。 [新しい SQL エディター] ポップオーバー メニューが開きます。
• [新しい SQL エディター] トグルを [オフ] に設定します。
• 確認ダイアログで、アクティブなクエリのみ、またはすべての対象クエリに対して、新しいエディターを無効にすることを選びます。
  • [対象となるすべてのクエリで無効にする] はオフになっています。 アクティブなクエリについてのみ新しいエディターを無効にする場合は、この設定をそのままにします。
  • すべてのクエリで新しい SQL エディターを無効にするには、[対象となるすべてのクエリで無効にする] チェック ボックスをオンにします。

ワークスペース管理者は、プレビュー ポータルにアクセスして SQL エディターを検索することで、ワークスペース レベルでこの機能をオフにすることができます。 「Azure Databricks のプレビューを管理する」を参照してください。