Skip to main content

Using Notebooks

SingleStoreDB Cloud supports Jupyter Notebooks for development using SQL and Python.

Import and Run Notebooks

Tip

Get Started Quickly: Notebooks in SingleStoreDB Cloud are Jupyter notebooks and if you are familiar with how to use them, you can jump right in and get started. In the Shared folder there is a subfolder called "sample", which contains sample notebooks. You can find how-to guides, tutorials, and getting started information there.

To get started with using a notebook, we recommend using the "getting started" notebook in the sample folder located in the Shared folder. This notebook provides an introduction to the basics of working with notebooks in SingleStoreDB. Learn about the different types of cells in a notebook and how to use them in the context of SingleStoreDB to write code and develop applications.

Manage Notebooks

How to perform the basic, non-development notebook tasks: find, share, create, open/edit, delete, and rename.

Shared and Personal Folders

Notebooks are stored in either Shared or Personal "folders" in SingleStoreDB Cloud. Notebooks stored in the Shared area are available to any other users who have access to the same workgroup.

Notebooks stored in the Personal area are only visible to the notebook creator and cannot be shared. To share a notebook that is in the Personal folder, duplicate the notebook and change the location to a Shared folder.

Create or Open/Edit a Notebook

To open or edit an existing notebook, select the notebook in the list of notebooks.

To create a notebook:

  1. Select the ‘+’ icon next to Notebooks.

    Left Nav, Query section, Notebook sub-section, showing two folders: Personal and Shared.

  2. Enter a name for the notebook.

  3. Choose a location (Personal or Shared) for the notebook.

  4. Select a template from the template list, or just use "Blank".

  5. Select Create.

  6. Select a Python kernel and select Submit.

The New Notebook dialog box, with Name, Location, and Template fields. Cancel and Create buttons.

Share a Notebook

All users with access to the same workgroup have access to the notebooks associated with that workspace that are in the Shared folder.

To share a notebook, select Copy Link from the (three-dot) More menu next to the desired notebook. Share the link with other users in the same Organization.

Menu items available after clicking the "three dot" menu (. . .): Rename, Duplicate, Copy Link, Delete.

Notebooks in the Personal folder cannot be shared. To share a notebook that is in the Personal folder, duplicate the notebook and change the location to a Shared folder.

Rename a Notebook

To rename a notebook, select Rename from the (three-dot) More menu next to the desired notebook.

Duplicate a Notebook

To duplicate a notebook, select Duplicate from the (three-dot) More menu next to the desired notebook.

Enter a name for the notebook and select a location. If you duplicate a notebook from the Personal folder to a Shared folder, the new notebook will not be private.

Delete a Notebook

To delete a notebook, select Delete from the (three-dot) More menu next to the desired notebook.

In this section: