Skip to main content
Skip to main content
Edit this page

Connecting Retool to ClickHouse

Partner Integration

1. Gather your connection details​

To connect to ClickHouse with HTTP(S) you need this information:

Parameter(s)Description
HOST and PORTTypically, the port is 8443 when using TLS or 8123 when not using TLS.
DATABASE NAMEOut of the box, there is a database named default, use the name of the database that you want to connect to.
USERNAME and PASSWORDOut of the box, the username is default. Use the username appropriate for your use case.

The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select a service and click Connect:

Choose HTTPS. Connection details are displayed in an example curl command.

If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

2. Create a ClickHouse resource​

Login to your Retool account and navigate to the Resources tab. Choose "Create New" -> "Resource":


Select "JDBC" from the list of available connectors:


In the setup wizard, make sure you select com.clickhouse.jdbc.ClickHouseDriver as the "Driver name":


Fill in your ClickHouse credentials in the following format: jdbc:clickhouse://HOST:PORT/DATABASE?user=USERNAME&password=PASSWORD. If your instance requires SSL or you are using ClickHouse Cloud, add &ssl=true to the connection string, so it looks like jdbc:clickhouse://HOST:PORT/DATABASE?user=USERNAME&password=PASSWORD&ssl=true


After that, test your connection:


Now, you should be able to proceed to your app using your ClickHouse resource.