Deepnote

This guide walks you through the steps required to use the collaborative data notebook Deepnote with Materialize.

Create an integration

1. Sign in to Deepnote.
2. Go to the Workspace integrations page.
   NOTE: If you are inside a workspace, in the Menu, click Integrations
3. Click in the + Add Integration button.
4. Search and click the Materialize option.
5. Enter the connection fields as follows:

   Field	Value
   Integration name	Materialize.
   Host name	Materialize host name.
   Port	6875
   Username	Materialize user.
   Password	App-specific password.
   Database	materialize
   Cluster	Your preferred cluster.

6. Click the Create Integration button.
7. After a successful test, in the popup dialog, you can either select an existing project or create a new one to continue.

Configure a custom cluster

To direct queries to a specific cluster, set the cluster at the role level using the following SQL statement:

ALTER ROLE <your_user> SET CLUSTER = <custom_cluster>;

Replace <your_user> with the name of your Materialize role and <custom_cluster> with the name of the cluster you want to use.

Once set, all new sessions for that user will automatically run in the specified cluster, eliminating the need to manually specify it in each query or connection.

Execute and visualize a query

1. Create a new SQL block.

2. Inside the block, select the new Materialize integration and paste the following query:

   SELECT
       number,
       row_num
   FROM (
       SELECT
           power(series_number, 2) AS number,
           row_number()
               OVER
               (ORDER BY series_number ASC, series_number DESC)
           AS row_num
       FROM (
           SELECT generate_series(0, 1000) AS series_number
       ) AS subquery
   );
   

   This query generates a series of 1000 numbers squared and assigns row numbers to each.

3. Click the Run Notebook button.

4. Inside the block, click the Visualize button and configure as follows:

   1. In the Y Axis options, select the number column and set the aggregation to None.
   2. In the X Axis options, select the row_num column and set the aggregation to None.
   

Related pages

For more information about Deepnote and the integration, visit their documentation.