Databricksノートブックのインターフェイスとコントロール

  • [アーティクル]

ノートブック ツール バーには、ノートブックの管理と編集に使用できるメニューとアイコンが含まれています。

ノートブックのツール バー

ノートブック名の横には、ノートブックの既定の言語を変更できるボタンがあり、ノートブックが Databricks Git フォルダーに含まれている場合は、Git ダイアログを開きます。

以前のバージョン のノートブックを表示するには、[最終編集]をクリックします。 メッセージをメニューの右側に表示します。

セルのデザインを更新

重要

この機能はパブリック プレビュー段階にあります。

更新されたセル デザインが利用可能です。 このページでは、セル デザインの両方のバージョンの使用方法に関する情報を示します。 新しい UI へのオリエンテーションと一般的な質問に対する回答については、「新しいセル UI へのオリエンテーション」を参照してください。

新しいセル デザインを有効または無効にするには、ワークスペースの [エディター設定] ページを開きます。 サイドバーで [開発者] をクリックします。 [試験的な機能] で、[新しいセル UI] のトグルを切り替えます。

ノートブック セル

ノートブックには、コード セルと Markdown セルの 2 種類のセルのコレクションが含まれています。 コード セルには、実行可能なコードが含まれています。 Markdown セルには、セルの実行時にテキストとグラフィックにレンダリングされる Markdown コードが含まれており、コードの文書化やイラスト化に使用できます。 ノートブックにセルを追加または削除して、作業を構成できます。

1 つのセル、セルのグループを実行することも、ノートブック全体を一度に実行することもできます。 ノートブック セルには、最大 10 MB を含めることができます。 ノートブック セルの出力は 20 MB までに制限されています。

Notebook のツール バーのアイコンとボタン

ツール バーの右側のアイコンとボタンを次の表に示します：

アイコン 説明
[すべてを実行] ボタン[Interrupt execution] (実行を中断) ボタン すべてのセルを実行するか、実行を停止します。 このボタンの名前は、ノートブックの状態によって変わります。
ノートブック ヘッダーのコンピューティング セレクター コンピューティング セレクターを開きます。 ノートブックがクラスターまたは SQL クラスターに接続されている場合、このボタンにはコンピューティング リソースの名前が表示されます。
ノートブック ヘッダーのジョブ スケジューラ [ジョブ スケジューラ]を開きます。
ノートブック ヘッダーの DLT セレクター [Delta Live Tables] を開きます。 このボタンは、ノートブックが Delta Live Tables パイプラインの一部である場合にのみ表示されます。
ノートブック ヘッダーの共有ボタン [アクセス許可ダイアログ] を開きます。

右サイドバーのアクション

次の表で説明するように、ノートブックの右サイドバーからいくつかのアクションを使用できます：

アイコン 説明
ノートブック ヘッダーのコメント アイコン [ノートブックのコメント] を開きます。
ノートブック ヘッダーの実験アイコン [MLflow ノートブックの実験] を開きます。
ノートブックのバージョン履歴アイコン ノートブックのバージョン履歴を開きます。
ノートブックの変数エクスプローラー 変数エクスプローラーを開きます。 (Databricks Runtime 12.2 LTS 以降で Python 変数に対して使用できます。)
ノートブック環境 Python 環境パネルを開きます。 このパネルには、ノートブック スコープのライブラリ、クラスター ライブラリ、Databricks Runtime に含まれるライブラリなど、ノートブックで使用できるすべての Python ライブラリが表示されます。 ノートブックがクラスターにアタッチされている場合にのみ使用できます。

データを参照する

重要

この機能はパブリック プレビュー段階にあります。

ノートブックで使用できるテーブルとボリュームを調べるには、ノートブックの左側にある ノートブックのデータ アイコン をクリックして、スキーマ ブラウザーを開きます。 詳しくは、「データを参照する」をご覧ください。

セルの操作メニュー

セルの操作メニューを使用すると、セルの切り取りとコピー、ノートブック内のセルの移動、コードや結果の非表示を行うことができます。 元の UI と新しい UI では、メニューの外観が異なります。 このセクションでは、両方のバージョンの手順を説明します。

ワークスペースで Databricks アシスタントが有効になっている場合は、コード セルで使用して、コードのヘルプや提案を取得できます。 セルで Databricks アシスタント テキスト ボックスを開くには、セルの右上隅にある Databricks アシスタント アイコン Databricks Assistant アイコン をクリックします。

セルの右上隅の近くにあるセル言語ボタンを使用すると、セルをコードまたはマークダウンに簡単に変更したり、コード セルの言語を変更したりできます。

セルの言語ボタン

セルの操作メニュー (元の UI)

セルの操作メニュー

このメニューから、次のコード セルを実行することもできます。

セルの操作メニュー - 実行

セルの操作メニューには、セルを非表示にするボタン セルの最小化 や、セルを削除するボタン 削除アイコン も含まれています。

Markdown セルの場合、ダッシュボードにセルを追加するオプションも表示されます。 詳細については、「ノートブック内のダッシュボード」を参照してください。

ダッシュボード​

新しい UI でセルを操作する

次のスクリーンショットは、ノートブック セルの右上に表示されるアイコンを示しています。

右上のセル アイコン - 新しい UI

言語セレクター: セルの言語を選択します。

Databricks アシスタント: Databricks アシスタントのセル内のコードの提案を有効または無効にします。

セルのフォーカス: セルを拡大して編集しやすくします。

セルの操作メニューの表示: セルの操作メニューを開きます。 このメニューのオプションは、コード セルと Markdown セルで若干異なります。

セルの操作メニュー - 新しい UI

新しい UI でコード セルを実行するには、コード セルの左上にある下矢印をクリックします。

セルの実行メニュー - 新しい UI

セルが実行されると、セルの実行メニューの右側に通知が表示され、最後にセルが実行された時刻と実行時間が表示されます。 通知にカーソルを合わせると、詳細が表示されます。

最後の実行の画像

Markdown セルまたは表形式の結果を含むセルをダッシュボードに追加するには、セルの操作メニューから [ダッシュボードに追加] を選択します。 詳細については、「ノートブック内のダッシュボード」を参照してください。

セルを削除するには、セルの右側にあるごみ箱アイコンをクリックします。 このアイコンは、セルにカーソルを合わせると表示されます。

セルのごみ箱アイコン

セル内のコードにコメントを追加するには、コードを強調表示します。 セルの右側に、コメント アイコンが表示されます。 アイコンをクリックしてコメント ボックスを開きます。

コメント アイコン

セルを上下に移動するには、セルの左上隅の外側にある セルの移動アイコン をクリックしたままにして、セルを新しい場所にドラッグします。 セルの操作メニューから [上へ移動] または [下へ移動] を選択することもできます。

セルを作成する

ノートブックには、コードと Markdown の 2 種類のセルがあります。 Markdown セルのコンテンツは HTML にレンダリングされます。 たとえば、このスニペットの中にあるマークアップはレベル 1 の見出しを表します。

%md ### Libraries
Import the necessary libraries.

次のようにレンダリングされます。

レンダリングされた Markdown の例

セルを作成する (元の UI)

元の UI で新しいセルを作成するには、上部または下部にあるセルにカーソルを合わせ、セルの追加 アイコンをクリックします。 ノートブックのセル メニューを使用することもできます。下キャレット をクリックし、[Add Cell Above] (上にセルを追加) または [Add Cell Below] (下にセルを追加) を選びます。

コード セルの場合は、セルに「コード」と入力します。 Markdown セルを作成するには、セルの言語ボタンから [Markdown] を選択するか、セルの上部に %md と入力します。

セルを作成する (新しい UI)

新しい UI で新しいセルを作成するには、上部または下部にあるセルにカーソルを合わせます。 [コード] または [テキスト] をクリックします。それぞれコード セルまたは Markdown セルを作成します。

新しいセルを作成するためのボタン

セルの切り取り、コピー、貼り付け

セルを切り取ってコピーするには、いくつかのオプションがあります。 Safari ブラウザーを使用している場合は、キーボード ショートカットのみを使用できます。

  • 元の UI または新しい UI のセルの操作メニューから、[セルの切り取り] または [セルのコピー] を選択します。
  • キーボード ショートカットを使用します。Command-X または Ctrl-X で切り取り、Command-C または Ctrl-C でコピーします。
  • ノートブックの上部にある [編集] メニューを使用します。 [切り取り] または [コピー] を選択します。

セルを切り取ったりコピーしたりした後は、ノートブック内の別の場所、別のノートブック、または別のブラウザー タブまたはウィンドウ内のノートブックに、それらのセルを貼り付けることができます。 セルを貼り付けるには、キーボード ショートカット Command-V または Ctrl-V を使用します。 セルは現在のセルの下に貼り付けられます。

切り取りまたは貼り付け操作を元に戻すには、キーボード ショートカットの Command-Z または Ctrl-Z を使用するか、メニュー オプション [編集] > [セルの切り取りを元に戻す] または [編集] > [セルの貼り付けを元に戻す] を使用します。

隣接するセルを選択するには、Markdown セルをクリックし、[Shift] + [Up] または [Down] を使用してその上または下のセルを選択します。 選択したセルをグループとしてコピー、切り取り、貼り付け、または削除するには、編集メニューを使用します。 すべてのセルを選択するには、[編集] > [すべてのセルを選択] を選択するか、コマンド モード ショートカット Cmd + A を使用します。

Notebookの目次

自動的に生成された目次を表示するには、ノートブックの左上にあるアイコン (サイド バーと一番上のセルの間) をクリックします。 目次は、ノートブック内で使用されている Markdown 見出しから生成されます。 新しい UI を使用している場合は、タイトルを含むセルも目次に表示されます。

TOC を開く

セルの表示オプション

ノートブックの表示方法は 3 つあります。 [表示] メニューを使用して、表示オプションを変更します。

  • 標準ビュー: 結果はコード セルの直後に表示されます。
  • 結果のみ: 結果だけが表示されます。
  • 並べて表示: コードのセルが左、結果のセルが右となるように並べて表示されます

新しい UI では、セルの余白 (セルの左右の領域) のアイコンから操作を実行できます。 たとえば、セルを上下に移動するには、左側の余白にあるグリップドット セルの移動アイコン を使用します。 セルを削除するには、右側の余白にあるごみ箱アイコンを使用します。

簡単に編集するには、フォーカス モード アイコン セルのフォーカス アイコン をクリックして、セルを全幅で表示します。 フォーカス モードを終了するには、セルのフォーカスの終了アイコン をクリックします。 また、[表示] > [中央揃えのレイアウト] をオフにして、セルの表示幅拡大することもできます。

ノートブック内のすべてのセルを業界標準の行の長さと間隔に自動的に書式設定するには、[編集] > [ノートブックを書式設定する] を選択します。

行番号とコマンド番号

行番号またはコマンド番号を表示または非表示にするには、[表示] メニューから [行番号] または [コマンド番号] を選択します。 行番号を表示するには、キーボード ショートカット Control + L を使用することもできます。

行番号やコマンド番号を有効にすると、その設定が Databricks に保存され、そのブラウザーの他のすべてのノートブックでも表示されるようになります。

行番号とコマンド番号 (元の UI)

セルの上のコマンド番号は、その特定のコマンドにリンクしています。 セルのコマンド番号をクリックすると、URL がそのコマンドへのアンカーに更新されます。 ノートブック内の特定のコマンドへのリンクを取得するには、そのコマンド番号を右クリックして [リンク アドレスをコピー] を選択します。

行番号とコマンド番号 (新しい UI)

新しい UI では、行番号が既定でオフになっています。 オンにするには、[表示] > [行番号] を選択します。 セルがエラー状態の場合、選択内容に関係なく行番号が表示されます。

コマンド番号を切り替えるには、[表示] > [コマンド番号] を選択します。

新しい UI には、セル コマンド番号のリンクは含まれません。 ノートブック内の特定のコマンドへの URL リンクを取得するには、セルのフォーカス アイコン をクリックしてフォーカス モードを開き、ブラウザーのアドレス バーから URL をコピーします。 フォーカス モードを終了するには、セルのフォーカスの終了アイコン をクリックします。

セルのタイトルを追加する

元の UI を使用してセルにタイトルを追加するには、セルの操作メニューから [タイトルの表示] を選択します。

新しい UI を使用してセルにタイトルを追加するには、次のいずれかを行います。

  • セルの上部の中央に表示されているセル番号をクリックし、タイトルを入力します。
  • セルの操作メニューから [タイトルの追加] を選択します。

新しい UI では、タイトルを持つセルはノートブックの目次に表示されます。

セルのタイトルを追加する

ノートブックをダーク モードで表示する

ノートブックをダーク モードで表示することもできます。 ダーク モードのオンとオフを切り替えるには、[表示] > [テーマ] を選択し、[ライト テーマ] または [ダーク テーマ] を選択します。

セルの内容の非表示と表示

セルの内容は、セル コードと、そのセルを実行した結果で構成されます。 セルのコードと結果の非表示と表示を切り替えるには、そのセルの右上にあるセルの操作メニューを使用します。

関連する機能については、「折りたたみ可能な見出し」をご覧ください。

セルの内容の非表示と表示 (元の UI)

セルのコードまたは結果を非表示にするには、[ダウンキャレット] をクリックし、[コードの非表示] または [結果の非表示] を選択します。 セルの最小化 を選択して、セルの最初の行のみを表示することもできます。

非表示のセル コードまたは結果を表示するには、表示のリンクをクリックします。

非表示のコードと結果を表示する

セルの内容の非表示と表示 (新しい UI)

セルのコードまたは結果を非表示にするには、セルの右上にあるケバブ メニュー セルのケバブ アイコン をクリックし、[コードの非表示] または [結果の非表示] を選択します。 [セルを折りたたむ] を選択して、セルの最初の行のみを表示することもできます。 折りたたんだセルを展開するには、[セルの展開] を選択します。

非表示のセルのコードまたは結果を表示するには、表示アイコンをクリックします: 表示アイコン。

折りたたみ可能な見出し

セルの中に Markdown 見出しがある場合に、その後に表示されるセルを折りたたんで見出しセルに入れることができます。 Markdown 見出しが含まれているセルに続くセルの展開または折りたたみをノートブック全体で同時に行うには、[表示] メニューで [すべての見出しを展開] を選択します。 このセクションの残りの部分では、セルのサブセットを展開または折りたたむ方法について説明します。

関連する機能については、「セルの内容の非表示と表示」をご覧ください。

見出しの展開と折りたたみ (元の UI)

次の図は、レベル 2 の見出し MLflow setup と、その中に折りたたまれた次の 2 つのセルを示しています。

元の UI で折りたたまれたセル

見出しを展開するには + をクリックし、折りたたむには - をクリックします。

見出しの展開と折りたたみ (新しい UI)

次の図は、レベル 2 の見出し MLflow setup と、その中に折りたたまれた次の 2 つのセルを示しています。

新しい UI で折りたたまれたセル

見出しを展開または折りたたむには、Markdown セルにカーソルを合わせます。 セルの左側に表示される矢印をクリックします。

ノートブックのコンピューティング リソース

このセクションでは、ノートブック コンピューティング リソースのオプションについて説明します。 ノートブックは Databricks クラスターに対して実行でき、SQL コマンドの場合は、SQL 分析用に最適化されたコンピューティングの一種である SQL ウェアハウスを使用するという選択肢もあります。

クラスターにノートブックをアタッチする

ノートブックをクラスターにアタッチするには、アタッチ可能クラスター レベルのアクセス許可が必要です。

重要

ノートブックがクラスターにアタッチされている限り、ノートブックに対する実行可能アクセス許可を持つすべてのユーザーには、クラスターにアクセスするための暗黙的なアクセス許可があります。

ノートブックをクラスターにアタッチするには、ノートブック ツール バーのコンピューティング セレクターをクリックし、ドロップダウン メニューからクラスターを選択します。

メニューには、最近使用したクラスターまたは現在実行中のクラスターの選択が表示されます。

ノートブックをアタッチする

使用可能なすべてのクラスターから選択するには、[その他] をクリックします。 クラスター名をクリックしてドロップダウン メニューを表示し、既存のクラスターを選択します。

その他のクラスターのダイアログ

ドロップダウン メニューから [新しいリソースの作成...] を選択して [新しいクラスターの作成] を選択することもできます。

重要

アタッチされたノートブックには、次の Apache Spark 変数が定義されています。

クラス 変数名
SparkContext sc
SQLContext/HiveContext sqlContext
SparkSession (Spark 2.x) spark

SparkSession、SparkContext、SQLContext を作成しないでください。 これを行うと、一貫性のない動作につながります。

SQL ウェアハウスを使用してノートブックを使用する

ノートブックが SQL ウェアハウスにアタッチされている場合は、SQL と Markdown セルを実行できます。 他の言語 (Python や R など) でセルを実行すると、エラーがスローされます。 SQL ウェアハウスで実行される SQL セルは、SQL ウェアハウスのクエリ履歴に表示されます。 クエリを実行したユーザーは、出力の下部にある経過時間をクリックして、ノートブックからクエリ プロファイルを表示できます。

ノートブックを実行するには、Pro またはサーバーレス SQL ウェアハウスが必要です。 ワークスペースと SQL ウェアハウスへのアクセス権を持っている必要があります。

ノートブックが SQL ウェアハウスにアタッチされている場合、ウィジェットの動作は異なります。 詳細については、「SQL ウェアハウスで Databricks ウィジェットを使用する」を参照してください。

SQL ウェアハウスにノートブックをアタッチするには、次の操作を行います。

  1. ノートブック のツール バーでコンピューティング セレクターをクリックします。 ドロップダウン メニューには、現在実行中の、または最近使用したコンピューティング リソースが表示されます。 SQL ウェアハウスには、SQL ウェアハウス ラベル のマークが付いています。

  2. メニューから SQL ウェアハウスを選択します。

    使用可能なすべての SQL ウェアハウスを表示するには、ドロップダウン メニューから [その他] を選択します。 ノートブックで使用できるコンピューティング リソースを示すダイアログが表示されます。 [SQL Warehouse] (SQL ウェアハウス) を選択し、使用するウェアハウスを選択して、[アタッチ] をクリックします。

    その他のクラスターのダイアログで SQL ウェアハウスが選択されている

ワークフローまたはスケジュールされたジョブを作成するときに、SQL ノートブックのコンピューティング リソースとして SQL ウェアハウスを選択することもできます。

SQL ウェアハウスの制限事項は次のとおりです。

  • SQL ウェアハウスにアタッチすると、実行コンテキストのアイドル タイムアウトは 8 時間になります。
  • 返される結果の最大サイズは、10,000 行または 2 MB のいずれか小さい方です。

ノートブックをデタッチする

コンピューティング リソースからノートブックをデタッチするには、ノートブック ツール バーでコンピューティング セレクターをクリックし、一覧内のアタッチされたクラスターまたは SQL ウェアハウスの上にマウス ポインターを合わせてサイド メニューを表示します。 サイド メニューから、 [デタッチ] を選択します。

ノートブックをデタッチする

クラスターの詳細ページの [ノートブック] タブを使用することでも、クラスターからノートブックをデタッチできます。

ノートブックをデタッチすると、実行コンテキストが削除され、計算された変数値はすべてノートブックからクリアされます。

ヒント

Azure Databricks では、使用されていないノートブックをクラスターからデタッチすることをお勧めします。 これにより、ドライバーのメモリ領域が解放されます。

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

ノートブックで Web ターミナルを開くには、右側のサイドバーの下部にある [下部パネルを再度開く] をクリックします。

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

Databricks Runtime 15.0 以降では、ノートブックの Web ターミナルから Databricks CLI を使用できます。

要件

  • ノートブックは、シングル ユーザーまたは非分離共有アクセス モードでクラスターに接続する必要があります。
  • CLI は、Private Link に対して有効になっているワークスペースでは使用できません。

インストールされている CLI は常に最新バージョンです。 認証は現在のユーザーに基づいています。

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