Databricks ノートブックとファイル エディターを移動する

この記事では、キーボード ショートカット、コードの提案とオートコンプリート、変数検査、コード フォールディングなど、Databricks ノートブックとファイル エディターの操作に役立つ関数について説明します。 ノートブックまたはファイル エディターを使用するときは、コードの生成、説明、デバッグに役立つ Databricks Assistant を使用できます。 詳細については、「Databricks Assistant からコーディングのヘルプを取得する」を参照してください。

選りすぐりのエディター テーマの中から選択することができます。 [表示] > [エディター テーマ] の順に選択し、メニューから選びます。

コマンド パレット

コマンド パレットを使用すると、ノートブックでアクションをすばやく実行できます。 ノートブックアクションのパネルを開くには、ワークスペースの右下隅にある をクリックするか、MacOS の 場合は Cmd + Shift + P 、Windows では Ctrl + Shift + P のショートカットを使用します。

セル実行ミニマップ

ノートブックの実行状態の視覚的な概要を取得するには、セル実行ミニマップを使用します。 ミニマップが右余白に表示され、各実行可能セルのステータス バーが表示されます。

ステータス バーは、次の実行状態を示します。

• 薄い灰色: セルは静的です。
• 濃い灰色: セルはスキップされるか、実行のためにキューに入れられます。
• バーが動いている明るい灰色: セルは現在実行中です。
• 緑: セルはエラーなしで正常に実行されました。
• 赤: セルがエラーで失敗しました。

ミニマップを操作するには:

• ミニマップの上にマウス ポインターを置くと、実行可能セル、タイトル、実行状態の一覧が表示されます。
• エントリをクリックして、ノートブック内のそのセルに直接ジャンプします。
• [ 最後の実行セルに移動 ] をクリックするか、[ 最初に失敗したセルに移動 ] をクリックして、最後に実行されたセルまたは最初に失敗したセルに移動します。

ミニマップを使用すると、一目で実行の進行状況を追跡し、デバッグ中や開発中にすばやく移動できます。

テキストの検索と置換

ノートブック内のテキストを検索して置換するには、キーボード ショートカット、 Cmd + F (Mac) または Ctrl + F (Windows) を使用するか、[ 検索] > 編集 ] をクリックして [ 検索 ] ダイアログ ボックスを開きます。 検索するテキストを入力します。 現在の一致はオレンジ色で強調表示され、他のすべての一致は黄色で強調表示されます。 ネイティブ ブラウザー検索にアクセスするには、 Cmd + F (Mac) または Ctrl + F (Windows) をもう一度押します。

をクリックします。[置換] オプションを開きます。 代わりに使用するテキストを入力します。 現在の一致を置き換えるには、[置換] をクリックします。 ノートブック内のすべての一致を置換するには、[すべて置換] をクリックします。

一致する結果を移動するには、（前の一致）または（次の一致）をクリックします。 Shift + Enter キーを押して前の一致に移動したり、Enter キーを押して次の一致に移動したりできます。

検索と置換ツールを閉じるには、[ をクリックするか、Esc キーを押 します。

可変検査

SQL または Python のノートブックで定義されている変数に関する情報を表示するには、変数名にカーソルを合わせます。 Python の変数を検査するには、Databricks Runtime 12.2 LTS 以降が必要です。

変数エクスプローラー を参照してください。

定義へ移動

Python ノートブックがコンピューティング リソースにアタッチされている場合、変数、関数、または %run ステートメントの背後にあるコードの定義にすばやく移動できます。 これを行うには、変数または関数の名前を右クリックしてから、[定義に移動] または [定義をここに表示] をクリックします。

macOS では Cmd キーを、Windows では Ctrl キーを押しながら、変数または関数の名前の上にマウス ポインターを合わせます。 定義が見つかると、名前がハイパーリンクに変わります。

[定義に移動] 機能は、Databricks Runtime 12.2 LTS 以降で使用できます。

コードの折りたたみ

コードの折りたたみを使用すると、コードのセクションを一時的に非表示にすることができます。 これは、長いコード ブロックを操作する場合に役立ちます。作業する特定のコード セクションにフォーカスすることができるからです。

コードを非表示にするには、セルの左端にカーソルを置きます。 コードのセクションを非表示にできる論理ポイントには、下向きの矢印が表示されます。 その矢印をクリックすると、コード セクションが非表示になります。 もう一度矢印をクリックすると (右を指すようになります)、コードが表示されます。

キーボード ショートカットを含む詳細については、VS Code に関するドキュメントを参照してください。

Multicursor のサポート

ビデオに示すように、複数のカーソルを作成すれば、同時編集を簡単に行うことができます。

セル内で複数のカーソルを作成するには:

• macOS の場合、Option キーを押しながら、カーソルを追加する各場所をクリックします。
• Windows の場合、Alt キーを押しながら、カーソルを追加する各場所をクリックします。
• ショートカットを変更するという選択肢もあります。 「マルチカーソルと列の選択のショートカットを変更する」をご覧ください。

macOS では、キーボード ショートカット Option+Command キー + 上方向キーまたは下方向キーを使用して、垂直に配置された複数のカーソルを作成できます。

列 (ボックス) の選択

列内の複数の項目を選択するには、キャプチャする領域の左上をクリックします。 Then:

• macOS の場合、Shift + Option を押して右下にドラッグし、1 つまたは複数の列をキャプチャします。
• Windows の場合、Shift + Alt を押して右下にドラッグし、1 つまたは複数の列をキャプチャします。
• ショートカットを変更するという選択肢もあります。 「マルチカーソルと列の選択のショートカットを変更する」をご覧ください。

マルチカーソルと列の選択のショートカットを変更する

マルチカーソルと列 (ボックス) の選択に代替ショートカットを使用できます。 代替選択では、ショートカットは次のように変更されます。

• セル内で複数のカーソルを作成するには:
  • macOS の場合、Cmd キーを押しながら、カーソルを追加する各場所をクリックします。
  • Windows の場合、Ctrl キーを押しながら、カーソルを追加する各場所をクリックします。
• 列内の複数の項目を選択するには、キャプチャする領域の左上をクリックします。 Then:
  • macOS の場合、Option を押しながら右下にドラッグし、1 つまたは複数の列をキャプチャします。
  • Windows の場合、Alt を押しながら右下にドラッグし、1 つまたは複数の列をキャプチャします。

代替ショートカットを有効にするには、次の操作を行います。

1. ワークスペースの右上にあるユーザー名をクリックし、ドロップダウン リストで [設定] をクリックします。
2. [設定] サイド バーで、[Developer] を選択します。
3. [コード エディター] セクションの [マルチカーソル クリックのキー修飾子] 設定を、macOS の場合は [Cmd] に、Windows の場合は [Ctrl] に変更します。

代替ショートカットを有効にしても、垂直方向に配置された複数のカーソルを作成するためのキーボード ショートカットは変更されません。

データの参照

スキーマ ブラウザーを使用して、ノートブックで使用できる Unity カタログ オブジェクトを調べる。 ノートブックの左側にある [ をクリックして、スキーマ ブラウザーを開きます。

[ For you ] ボタンには、現在のセッションで使用したオブジェクト、または以前にお気に入りとしてマークされたオブジェクトのみが表示されます。

フィルター ボックスにテキストを入力すると、入力したテキストを含むオブジェクトのみが表示されます。 現在開いているオブジェクト、または現在のセッションで開かれているオブジェクトのみが表示されます。 [フィルター] ボックスでは、ノートブックで使用できるカタログ、スキーマ、テーブル、ボリュームの完全な検索は行われません。

を開くには、次のように、オブジェクトの名前の上にカーソルを置きます。

オブジェクトがテーブルの場合は、次の操作を実行できます。

• セルを自動的に作成して実行し、テーブル内のデータのプレビューを表示します。 テーブルのケバブ メニューから [新しいセルでプレビュー] を選択します。
• カタログ エクスプローラーでカタログ、スキーマ、またはテーブルを表示します。 ケバブ メニューの [カタログ エクスプローラーで開く] を選択します。 選択したオブジェクトを示す新しいタブが開きます。
• カタログ、スキーマ、またはテーブルへのパスを取得します。 オブジェクトのケバブ メニューの [... のパスをコピー] を選択します。
• お気に入りにテーブルを追加します。 テーブルのケバブ メニューの [お気に入りに追加] を選択します。

オブジェクトがカタログ、スキーマ、またはボリュームの場合は、オブジェクトのパスをコピーするか、カタログ エクスプローラーで開くことができます。

テーブルまたは列名をセルに直接挿入するには:

1. 名前を入力する位置にあるセル内のカーソルをクリックします。
2. スキーマ ブラウザーのテーブル名または列名の上にカーソルを移動します。
3. オブジェクトの名前の右側に表示される二重矢印 をクリックします。

Web ターミナルと Databricks CLI を使用する

ノートブックで Web ターミナルを開くには、ターミナル アイコンの をクリックします。右側のサイドバーの下部にあります。

Databricks Runtime 15.0 以降では、ノートブックの Web ターミナルから Databricks CLI を使用できます。 要件と使用方法については、 Azure Databricks Web ターミナルでのシェル コマンドの実行 に関するページを参照してください。

ノートブック セルから CLI を使用することはできません。 ノートブックでは、%sh databricks ... などのコマンドは Databricks Runtime 15.0 以降では機能しません。

パーソナライズされたオートコンプリート

オートコンプリートでは、コード セグメントの入力時に自動的に補完されます。 完了可能なオブジェクトには、型、クラス、オブジェクトのほか、SQL データベース、テーブル名、構造体、マップ、配列、 クエリ スニペットが含まれます。 SELECT *を使用する共通テーブル式 (CTE) を参照する場合、オートコンプリートでは、基になるテーブル構造に基づいて列の推奨事項が提供されます。 Databricks では、Unity Catalog のメタデータと使用状況を使用して、候補をパーソナライズします。

• Python セルの場合、オートコンプリートを機能させるにはノートブック をコンピューティング リソースにアタッチ し、完了可能なオブジェクトを定義 するすべてのセルを実行 する必要があります。
• SQL セルでは、ノートブックがコンピューティング リソースにアタッチされていない場合でも、オートコンプリートでキーワードと基本的な構文の候補が表示されます。
  • ワークスペースが Unity Catalog に対して有効になっている場合、オートコンプリートでは Unity Catalog のテーブルのカタログ、スキーマ、テーブル、列の名前についても候補が表示されます。
  • ワークスペースで Unity カタログが有効になっていない場合は、テーブル名または列名を提案するために、ノートブックを汎用コンピューティング リソースまたは SQL ウェアハウス にアタッチする必要があります。

オートコンプリートの候補は、セルに入力すると自動的に表示されます。 上下の方向キーまたはマウスを使用して候補を選択し、Tab キーまたは Enter キーを押して、セルに選択範囲を挿入します。

オートコンプリートは既定で有効になっていますが、 ユーザー設定では無効にすることができます。

• オートコンプリート候補をオフにするには、[入力時のオートコンプリート] を切り替えます。 オートコンプリートがオフになっている場合は、Ctrl + Space キーを押すとオートコンプリート候補を表示できます。
• Enter キーを押すことでオートコンプリート候補が挿入されないようにするには、[Enter キーでオートコンプリート候補を受け入れる] を切り替えます。

角かっこの一致

かっこ、角かっこ、または中かっこの近くをクリックすると、エディターによって、その文字と、それに対応する角かっこが強調表示されます。

Python エラーの強調表示

パートナーを利用する AI 機能が有効になっているワークスペースでは、AI 支援型の提案に対して [アシスタントを使用して修正] を選択することもできます。

Databricks ノートブックでは、次のエラー強調表示がサポートされています。

• Python 構文エラーの強調表示: Python コード セルの構文エラーは赤で強調表示されます。 可能であれば、アシスタントから迅速な修正が提案されます。 これは、Databricks Runtime 12.1 以降またはサーバーレス コンピューティングを実行するコンピューティングでサポートされています。 pyproject.toml ファイルで構文エラーの強調表示を構成できます。 Python シンタックスハイライトの設定を参照してください。
• Python 形式エラーの強調表示: Python コードの書式設定エラーと警告は、重大度に応じて黄色または赤で下線が引かれます。 これは、予期しないインデント、長い行の長さなどの書式設定の問題を特定するのに役立ちます。 構文の警告にカーソルを合わせると、詳細情報が表示されます。 これは、Databricks Runtime 12.1 以降またはサーバーレス コンピューティングを実行するコンピューティングでサポートされています。
• Python 型エラーの強調表示: 型チェックにより、Python および PySpark プロジェクトのコードの品質、読みやすさ、保守性が向上します。 型チェッカーは、コード実行前の関数呼び出しで、存在しない属性、不足している引数、および不一致の引数に関連するエラーにフラグを設定できます。 強調表示された警告にカーソルを合わせると、詳細情報が表示されます。 これは、Databricks Runtime 16.0 以降またはサーバーレス環境 2 を実行するコンピューティングでサポートされています。

Python エラーの強調表示を有効にする

エラーの強調表示を有効または無効にするには、次の操作を行います。

1. ワークスペースの右上にあるユーザー名をクリックし、ドロップダウン リストで [設定] をクリックします。
2. [設定] サイド バーで、[Developer] を選択します。
3. Python 構文エラーの強調表示 ([コード エディター] の下)、Python 形式エラーの強調表示 ([試験段階の機能] の下)、Python の種類のエラーの強調表示 ([試験段階の機能] の下) の設定を切り替えます。

Python 構文の強調表示を構成する

ノートブックが Databricks Runtime 16.4 以降またはサーバーレス環境バージョン 3 以降を実行している コンピューティングに接続 されている場合は、 pyproject.toml ファイルを作成して構文の強調表示の動作をカスタマイズできます。 特定のノートブックでは、ワークスペース ファイル システム内の直接の先祖パスに最も近い pyproject.toml ファイルが使用されます。 先祖パスに見つからない場合は、現在のユーザーのホーム フォルダー内の pyproject.toml ファイルが使用されます。

たとえば、a/b/c/d/notebook.pyパスを持つノートブックがあり、pyproject.tomlとa/b/pyproject.tomlにa/b/c/pyproject.tomlファイルがある場合、2 つ目のファイルは近いため使用されます。 pyproject.tomlの/a/b/c/e/pyproject.tomlファイルは、直接の先祖のパス内にないため検討されません。

Azure Databricks では、 pyproject.toml ファイルに標準構文が使用されます。 たとえば、 Ruff ドキュメント を参照して、 pyproject.toml ファイルを使用して Ruff リンターを構成する方法を確認できます。

現在、Azure Databricks では、ruffを介してリンティングするためのpylint、pyright、flake8、およびpyproject.tomlの構成のみがサポートされています。

リンターを有効にするには、 pyproject.toml ファイルに [tool.<name-of-linter>] ブロックが必要です。

リンターを明示的に無効にするには、次のブロックを追加します。

[tool.<name-of-linter>]
disabled=true

次のようなブロックを使用して、Azure Databricks で記述された構文強調表示ルールを無効にすることもできます。

[tool.databricks]
disabled_rules = ['DB01', 'DB03']

Flake8 は別の形式の構成を想定しているため、次のように、文字列として、Flake8 の構成を渡す必要があります。

[tool.flake8]
config = """ \
[flake8] \
extend_ignore = E303 \
"""

SQL の書式設定をカスタマイズする

SQL 書式設定の設定は、新しい SQL エディターとノートブック エディターでカスタマイズできます。 [ 開発者設定 > 表示] をクリックします。 [ SQL 形式] まで下にスクロールし、設定を指定します。

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

キーボード ショートカットを表示するには、[ヘルプ] > [キーボード ショートカット] 選択します。 使用できるキーボード ショートカットは、カーソルがコード セル (編集モード) にあるかどうか (コマンド モード) によって異なります。

次の表は、使用可能なキーボード ショートカットを示しています。

編集モードのショートカット

コマンド モードのショートカット

共有ショートカット