Skip to main content

Connect with a database client

You can browse and query the data lake from database clients like DBeaver or DataGrip using the ClickHouse JDBC driver. The connection goes through the nullplatform API proxy, so the same authentication, authorization, and tenant isolation rules apply.

Connection parameters

Every database client needs the same set of parameters:

ParameterValue
JDBC URLjdbc:clickhouse://api.nullplatform.com:443/customers_lake?ssl=true&sslmode=strict
Hostapi.nullplatform.com
Port443 (HTTPS)
Databasecustomers_lake
SSLRequired (ssl=true, sslmode=strict)
AuthenticationCustom HTTP header: Authorization: Bearer <token>

The token is a short-lived JWT. If you receive a 401 Unauthorized error, the token has expired and you need to obtain a new one. See API keys for how to generate tokens.

DBeaver

  1. Open DBeaver and go to Database > New Database Connection.
  2. Search for ClickHouse in the driver list and select it. If prompted, let DBeaver download the JDBC driver automatically.
  3. In the Main tab, fill in the connection settings:
    • Host: api.nullplatform.com
    • Port: 443
    • Database: customers_lake
  4. Switch to the Driver Properties tab and set:
    • ssl = true
    • sslmode = strict
    • custom_http_headers = Authorization: Bearer <token>
  5. Click Test Connection to verify, then Finish.

DataGrip

  1. Open DataGrip and go to Database > + > Data Source > ClickHouse.
  2. In the General tab, fill in the connection settings:
    • Host: api.nullplatform.com
    • Port: 443
    • Database: customers_lake
  3. Switch to the Advanced tab and set:
    • ssl = true
    • sslmode = strict
    • custom_http_headers = Authorization: Bearer <token>
  4. Click Test Connection to verify, then OK.

Other JDBC-compatible tools

Any tool that supports a JDBC connection string (BI dashboards, SQL editors) can connect using this URL:

jdbc:clickhouse://api.nullplatform.com:443/customers_lake?ssl=true&sslmode=strict

Pass authentication as a connection property, not in the URL. Set the custom_http_headers property to Authorization: Bearer <token>.

Next steps