Skip to main content

Connect ClickHouse to Deepnote

Deepnote is a collaborative data notebook built for teams to discover and share insights. In addition to being Jupyter-compatible, it works in the cloud and provides you with one central place to collaborate and work on data science projects efficiently.

This guide assumes you already have a Deepnote account and that you have a running ClickHouse instance.

Interactive example

If you would like to explore an interactive example of querying ClickHouse from Deepnote data notebooks, click the button below to launch a template project connected to the ClickHouse playground.

Connect to ClickHouse

  1. Within Deepnote, select the "Integrations" overview and click on the ClickHouse tile.
ClickHouse integration tile
  1. Provide the connection details for your ClickHouse instance:

    1. Hostname - The hostname of your ClickHouse server. Check out this section for more information about ClickHouse hostname.
    2. Port - The HTTPS port of your ClickHouse instance.
    3. Username - Your ClickHouse username.
    4. Password - Your ClickHouse password.
    5. Database - The name of the database you would like to connect to.ClickHouse details dialog

    NOTE: If your connection is protected, you might need to allow Deepnote's IP addresses. Read more about it in Deepnote's docs.

  2. Congratulations! You have now integrated ClickHouse into Deepnote.

Using ClickHouse integration.

  1. Start by connecting to the ClickHouse integration on the right of your notebook.

    ClickHouse details dialog
  2. Now create a new ClickHouse query block and query your database. The query results will be saved as a dataframe and stored in the variable specified in the SQL block.

  3. You can also convert any existing SQL block to a ClickHouse block.