All Products
Search
Document Center

Dataphin:Create a notebook based on the analytics platform

Last Updated:Jun 23, 2026

Dataphin Notebook is a web-based interactive computing environment that combines SQL code and Markdown text in a notebook format. You can execute SQL code and view results in real time.

Scenarios

Record analysis procedures: Document your analytical processes, including code, execution results, and conclusions. The resulting data analysis report can be reviewed and shared with other Dataphin instance users.

Convenient data querying: Simplify data queries and analysis with swift project transitions. If no project is associated, you can use the dedicated compute resource of the analytics platform.

Feature introduction

Dataphin Notebook provides the following key features:

  • Interactive programming environment: Write and execute SQL code directly, and view and retain each result.

  • Support for multiple unit widgets: Add Markdown unit widgets for text content and SQL units, including database SQL unit widgets, for data query code.

Notebook development page overview

The Notebook development page consists of the Notebook folder, My Data Tables, the editor menu, the editing area, and the outline.

image.png

Area

Description

Notebook Folder

The Notebook folder has two root directories: My and Shared With Me.

  • My: Notebooks you create are organized under this root directory, which supports multiple subdirectories. For instructions on creating a new Notebook, see Create a new Notebook.

  • Shared with me: Notebooks shared with you appear under this root directory.

Notebooks created by the current account support renaming, moving, and deleting.

Notebook Editor Menu

The Notebook Editor Menu provides options to add editing units (Markdown, SQL code, and database SQL), save your work, execute code, share your Notebook, configure parameters, collapse or expand code units, refresh content, navigate through the document, and switch between projects.

  • Save: Click image..png to save your current edits.

  • Run current: Click image..png or press Cmd+Enter/Ctrl+Enter to execute the selected SQL code unit.

  • Add unit: Add Markdown units, SQL code units, or database SQL units to your Notebook. For more details, see Manage Notebook units.

  • Run all: Click image..png to execute all SQL code units in the Notebook.

  • Share: Share the current Notebook with other users within the Dataphin instance.

  • Parameter configuration: Click image.png to set parameter values in the parameter configuration dialog box. For additional information, see Notebook parameter configuration.

  • Collapse all code cells: Click image..png to collapse all code cells in the current notebook.

  • Expand all code cells: Click image..png to expand all code cells in the current notebook.

  • Refresh: Click image..png to refresh the Notebook content.

  • Locate: Click image..png to locate the Notebook in the Notebook folder.

  • Project switch: Use the directory switch dropdown to change the running project of the Notebook, including the analytics platform compute source.

    Note
    • The compute engine's AccessKey for the selected project must have access privileges to the project containing the queried table; otherwise, the query will fail.

    • If the analytics platform has no default compute source, a dedicated compute source can be bound by super administrators or system administrators. For instructions, see Analytics platform settings.

    • You can switch only to a dev or basic project associated with the current account that has an offline engine bound. The account also requires ad hoc query execution privileges for the project. For further information, see Request, renew, and return table privileges.

③Editing Area

After adding editing units to the editor, you can create content or manage the units. For further details, see Manage Notebook units.

Outline

An outline is automatically generated from the heading levels in Markdown units, enabling quick navigation to specific units in the notebook.