Skip to main content

​
Getting Started with ClickHouse Server Destination Configuration

​
Requirements:

  • Active ClickHouse server instance.
  • Allow connections from Databrain to your ClickHouse server.
    • For details on setting up IP whitelisting and ensuring secure connectivity, refer to our guide on

Allow Access to our IP
  • Choose the Databrain Workspace to which you wish to connect the data.

​
Setup Guide

​
1. Ensure Server Accessibility:

  • Ensure your ClickHouse server is active and accessible from the machine running Databrain.
  • Accessibility is dependent on your ClickHouse user privileges and network settings. The easiest way to verify if Databrain can connect to your ClickHouse server is via the check connection tool in the UI. For detailed setup and permissions, refer to the ClickHouse documentation.

​
2. Fill Up Connection Info:

  • Provide the necessary information to connect to your ClickHouse server:
    • Destination Name: [Pick a name to help you identify this destination in Databrain]
    • ClickHouse Account Details:
      • Host: [Enter your ClickHouse account locator, e.g., https://ru7b3vwqoe.eu-west-1.aws.clickhouse.cloud]
      • Port: 8443 (This is the default port for ClickHouse servers)
    • Authentication Details:
      • Username: [Enter the name of the user you want to use to access the database]
      • Password: [Enter the password associated with the username]

​
Encryption:

  • Ensure you have SSL/TLS set up for your ClickHouse server if you require encrypted connections from Databrain for enhanced security.

​
Permissions:

  • Permission to read information_schema.
  • Whitelist the IP address.
  • Grant read access to the schema (usage) and tables, noting that access to only tables may not suffice in certain databases.
Replace the placeholders inside the square brackets with the actual values when filling in the details.

​
Locating the Configuration Details in ClickHouse

  1. Destination Name:
    • This is a custom name you decide for identification within Databrain. Choose a name that is relevant and descriptive of your ClickHouse server.
  2. Host:
    • For remote servers or cloud installations, it would be the IP address, domain name, or endpoint URL of the machine where ClickHouse is running.
    • For cloud installations like ClickHouse Cloud, you can find this information in the respective cloud dashboard or the connection details page.
  3. Port:
    • The default port for ClickHouse is 8123 for HTTP interface and 8443 for HTTPS. However, it might be different based on your setup, especially for cloud providers. Ensure you’re using the correct port based on your connection requirements and setup.
  4. Username:
    • If you’ve set up authentication for ClickHouse, this would be the username you use to access ClickHouse. Default installations might not have authentication enabled, but for production environments, it’s recommended to secure your ClickHouse instance.
    • If you’re unsure of the username, check the ClickHouse configuration files (users.xml or config.xml) or consult with the person who set up ClickHouse.
  5. Password:
    • This is the password associated with the username you provided. Again, you’d find this in the ClickHouse configuration if it’s set up or you’d need to know it if it was provided to you during setup.