Search
⌃K

ClickHouse

ClickHouse is a column-oriented database that enables its users to generate powerful analytics, using SQL queries, in real-time. This article will cover how to connect to ClickHouse from Noteable.

Prepare

You will need the following information to create the connection:
  • Host
  • Port (default: 8443)
  • Username (default: default)
  • Password
  • Database (default: default)
Noteable supports connecting to ClickHouse over the HTTPS/HTTP interface and not over the native (TCP) interface.
By default, Noteable uses an HTTPS interface without verifying the server certificate. The options available under “Secure Connection” are:
  • Yes, HTTPS: Uses an HTTPS interface and does not verify the server certificate. This is the default.
  • Yes, HTTPS and verify server certificate: Uses an HTTPS interface and verifies the server certificate using a pre-configured TLS CA certificate bundle available.
  • No, HTTP: Uses an insecure HTTP interface.
If your data source is behind a firewall, you will need to ensure your firewall accepts incoming connections from Noteable. Read more here: Data Connections​

Create connections

To create a data connection:
  1. 1.
    Pick connection type.
  2. 2.
    Store credentials.
  3. 3.
    Start or restart the kernel.
There are multiple places you can create data connections:
Notebook
Resources page
To add a data connection from the notebook:
  1. 1.
    Open the Data Connections panel by clicking on the database icon (
    ) in the left sidebar.
  2. 2.
    Click on the
    sign to launch the Create a data connection modal.
  3. 3.
    Select ClickHouse for the connection type.
  4. 4.
    Provide a Name for the data connection and a description, if desired.
  5. 5.
    Provide your database server as the Host.
  6. 6.
    Configure the port value, if necessary.
  7. 7.
    Provide your username (default: default) & password.
  8. 8.
    Provide the database name (default: default).
  9. 9.
    Choose the type of Secure Connection (as described above), if desired.
  10. 10.
    Choose the connection's Visibility - this cannot be changed later:
    • Private connections can only be seen, managed, or accessed by the user who created the connections, and can be used in any space.
    • Space-level connections can be seen and managed by all users who have Contributor or Owner access for the space but can only be used in notebooks within the designated space.
  11. 11.
    Click Create.
  12. 12.
    Restart the kernel, if prompted.
To add a data connection from the resources page:
  1. 1.
    Click on the Data Connections link in the main sidebar. This sidebar is visible from all space or project pages.
  2. 2.
    Click on the +Create a data connection button to launch the Add data connection modal.
  3. 3.
    Select ClickHouse for the connection type.
  4. 4.
    Provide a Name for the data connection and a description, if desired.
  5. 5.
    Provide your database server as the Host.
  6. 6.
    Configure the port value, if necessary.
  7. 7.
    Provide your username (default: default) & password.
  8. 8.
    Provide the database name (default: default).
  9. 9.
    Choose the type of Secure Connection (as described above), if desired.
  10. 10.
    Choose the connection's Visibility - this cannot be changed later:
    • Private connections can only be seen, managed, or accessed by the user who created the connections, and can be used in any space.
    • Space-level connections can be seen and managed by all users who have Contributor or Owner access for the space but can only be used in notebooks within the designated space.
  11. 11.
    Click Create.
  12. 12.
    Restart any running kernels to use this connection.

Use connections

Learn more about how to use SQL cells here.