User guide

The notebook editor

Tabs, the toolbar, choosing what your cells run on, and arranging the sidebars around your notebook.

A notebook runs its cells on one of two kinds of compute: a kernel, for Python and Scala code, powered by Apache Spark™; or a SQL warehouse, for interactive SQL queries, powered by Trino™. You choose which when you create the notebook, and you can switch later from the compute menu.

Tabs

Every notebook you open gets a tab above the editor. The tabs belong to your session, so they are the same in every browser window you have open.

ToDo this
Switch notebookClick its tab.
Close a tabClick its ×, middle-click the tab, or focus it and press Delete.
Reorder tabsDrag a tab to a new place. The order is kept.
Move between tabs with the keyboardFocus a tab, then use ← → Home End.

Closing the notebook you are looking at takes you to the tab beside it — the right-hand one, or the left if there is none. Closing the last tab takes you to the notebook list.

The open notebook's tab shows a red dot while it has unsaved changes. Renaming a notebook renames its tab straight away.

The toolbar

From left to right:

  • Run all cells (Ctrl+Shift+Enter) and Add cell below (B in command mode).
  • Save, the disk icon. It turns red while the notebook has changes that are not saved yet, or if the last save failed; hover it to see which. Notebooks also save automatically as you type, and Ctrl+S saves now.
  • Clear all outputs.
  • Interrupt and Restart. Restart applies to kernels, not SQL warehouses.
  • AI assistant, the sparkles icon. See AI assist.
  • Keyboard shortcuts. Press ? in command mode for the same list.
  • Mode: Command or Edit.
  • Compute status, a coloured pill naming the catalog your cells read from.
  • Editor settings, the cog, for the editor's font family and size.

The compute status pill

The pill shows the catalog that a table name without a catalog prefix resolves in — orders rather than sales_dev.analytics.orders. Its colour is the state of the compute behind it:

ColourMeans
GreenConnected and idle. Cells run now.
AmberStarting, or busy running a cell.
GreyDetached or disconnected. Cells cannot run until you attach compute.

A dashed outline means nobody chose that catalog: it is the default for the kernel's runtime or for the deployment, and unqualified names resolve there. Pick a catalog in the top bar, or when you start a kernel, to pin it.

Hover the pill for the full detail. Click it to open the compute menu.

Choosing compute

The Engine button at the top of the page shows what your cells run on:

  • Engine: kernel name for a notebook attached to a kernel. Hover it for the kernel's runtime version.
  • Engine: warehouse name for a SQL notebook. This is the warehouse your queries go to: the most recently started warehouse that is running.
  • Engine: detached when there is nothing to run on.

Click it, or the status pill, to open the compute menu. It lists:

  • Kernels that are running and can take the notebook, and kernels still starting, which are shown but cannot be attached yet.
  • SQL warehouses, each with its state. Only a running warehouse can be attached; a stopped or failed one shows its state beside a disabled Attach.

Detach compute at the bottom of the menu disconnects the notebook without stopping the kernel or warehouse.

The explorer on the left lists your notebooks and files. The panel on the right holds the catalog tree above and the pipeline builder below.

ToDo this
Resize a sidebarDrag its inner edge. A green line appears when you are on it.
Resize the catalog and pipeline panesDrag the line between them up or down.
Go back to the default sizeDouble-click the edge or line.
Resize with the keyboardTab to the edge, then use the arrow keys. Home resets.
Collapse a sidebarUse its round button, or drag it well past its narrowest size.

Sizes are remembered in your browser. The explorer can be 200–560 px wide and the right panel 240–720 px; neither grows past 45% of the window. On a narrow screen the right panel stays collapsed so the notebook keeps its width.