Creating a notebook - Amazon Redshift

Creating a notebook

You can create a notebook to organize, annotate, and share multiple SQL queries in a single document.

To create a notebook

  1. From the navigator menu, choose the Editor icon ( Horizontal lines representing redacted or censored text. ).

  2. Choose the plus icon ( Plus sign icon representing an addition or new item action. ), and then choose Notebook.

    By default, a SQL query cell appears in the notebook.

  3. In the SQL query cell, do one of the following:

    • Enter a query.

    • Paste a query that you copied.

  4. (Optionally) Choose the plus icon ( Plus sign icon representing an addition or new item action. ), then choose Markdown to add a Markdown cell where you can provide descriptive or explanatory text using standard Markdown syntax.

  5. (Optionally) Choose the plus icon ( Plus sign icon representing an addition or new item action. ), then choose SQL to insert a SQL cell.

You can rename notebooks using the pencil icon ( Pencil icon representing an editing or writing function. ).

From the menu icon ( Three dots arranged horizontally, representing an ellipsis or "more" menu icon. ), you can also perform the following operations on a notebook:

  • Share Share with my team – To share the notebook with your team as defined by tags. To share a notebook with your team, make sure that you have the principal tag sqlworkbench-team set to the same value as the rest of your team members in your account. For example, an administrator might set the value to accounting-team for everyone in the accounting department. For an example, see Permissions required to use the query editor v2 .

  • Export Export – To export the notebook to a local file with the .ipynb extension.

  • Import query Import query – To import a query from a local file into a cell in the notebook. You can import files with .sql and .txt extensions.

  • Save Save version – To create a version of the notebook. To see versions of a notebook, navigate to your saved notebooks and open Version history.

  • Duplicate Duplicate – To create a copy of the notebook and open it in a new notebook tab.

  • Shortcuts Shortcuts – To display the shortcuts available when authoring a notebook.