Create a notebook based on the analytics platform - Dataphin

Dataphin Notebook is a web-based interactive computing environment that enables the combination of SQL code and Markdown text to create rich media content in a notebook format. Execute SQL code and display results in real-time within the notebook.

Scenarios

Record analysis procedures: Dataphin Notebook allows you to document your analytical processes, including code, execution results, and conclusions. This documentation can serve as a comprehensive data analysis report, facilitating the review and sharing of the analysis process and outcomes with other Dataphin instance users.

Convenient data querying: Dataphin Notebook simplifies data queries and analysis. It allows for swift project transitions during execution. If not associated with a project, you can utilize the dedicated compute resource linked to the analytics platform for data analysis.

Feature introduction

Key features of Dataphin Notebook include:

Interactive programming environment: Directly write and execute SQL code in Dataphin Notebook, with the ability to view and retain each result.
Support for multiple unit widgets: Dataphin Notebook supports the addition of 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 features the Notebook folder, My Data Tables, the editor menu, the editing area, and the outline. Here, you can manage your Notebooks effectively.

Area	Description
①Notebook Folder	The Notebook folder contains two root directories: My and Shared With Me. My: Notebooks that you create are organized under this root directory, which allows for the creation of multiple subdirectories. You can manage your created Notebooks here. For instructions on creating a new Notebook, see Create a new Notebook. Shared with me: Notebooks shared with you are placed under this root directory. You can access and view Notebooks that others have shared with you here. Notebooks created by the current account allow for operations such as renaming, moving, and deleting.
②Notebook Editor Menu	The Notebook Editor Menu allows you to edit and manage your Notebook effectively. Utilize it to add various editing units such as Markdown, SQL code, and database SQL units, along with to save your work, execute the current code or all code, share your Notebook, configure parameters, collapse or expand all code units, refresh the content, navigate through the document, and switch between projects. Save: Click to save the content currently being edited. Run current: To execute a selected SQL code unit, click or use the (Cmd+Enter/Ctrl+Enter) shortcut key. Add unit: Enhance your Notebook by adding units such as Markdown units, SQL code units, and database SQL units. For more details, see Manage Notebook units. Run all: Click to execute all SQL code units in the Notebook. Share: Share the current Notebook with other users within the Dataphin instance. Parameter configuration: Click to set parameter values in the Notebook using the parameter configuration dialog box. For additional information, see Notebook parameter configuration. Collapse all code cells: Click to collapse all code cells in the current notebook. Expand all code cells: Click to expand all the code in the current notebook's code cells. Refresh: Click to refresh the Notebook's content. Locate: Click to find the Notebook within 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. Switching is supported only to the dev or basic project associated with the current account, which must have an offline engine bound. Additionally, the account requires ad hoc query execution privileges for the project. For further information, see Request, renew, and return table privileges.
③Editing Area	Once you have added editing units to the editor, you can proceed to create content within these units or manage them. For further details, see Manage Notebook units.
④Outline	An outline is automatically generated based on the title levels in the Markdown units, facilitating navigation to corresponding units within the notebook.