# ClickHouse ### Overview HockeyStack's ClickHouse integration enables you to seamlessly connect your ClickHouse instance to our platform. This custom-built connector is designed to import data from ClickHouse based on your specific infrastructure and analytics requirements. Typical use cases include: * Enriching your analytics with specific user profile or behavioral data * Mapping offline revenue opportunities to your CRM activities * Incorporating additional custom data points to unify your customer data story * Ingesting large volumes of historical data to enhance your analytics If you're uncertain about which data is most valuable to import, we're happy to schedule a call to help you determine which tables and fields will best support your use cases. ### Prerequisites Before we begin, please ensure you have: * Access to your ClickHouse instance with the ability to manage users, permissions, and network policies * Clear information on which ClickHouse tables, databases, and columns contain the data you'd like HockeyStack to ingest * An understanding of whether HockeyStack should have read-only access, or if write permissions are also needed ### Connecting to ClickHouse To establish a secure connection between HockeyStack and ClickHouse, follow these steps: **1. IP Whitelisting (if applicable)** If you have IP restrictions in place, whitelist the following IP addresses to allow HockeyStack's workers to communicate with ClickHouse: * \`18.184.228.143\` * \`18.192.106.69\` * \`35.157.54.242\` * \`3.69.98.171\` **2. Assigning Permissions** Decide whether HockeyStack should have read-only or read-write permissions, depending on your use case. Create a user with access to the necessary databases and tables. For read-only access: `CREATE USER hockeystack_user IDENTIFIED BY 'your_secure_password';` `GRANT SELECT ON your_database.* TO hockeystack_user;` For read-write access: `CREATE USER hockeystack_user IDENTIFIED BY 'your_secure_password';` `GRANT SELECT, INSERT, ALTER, CREATE ON your_database.* TO hockeystack_user;` Additional Resources: [ClickHouse Access Rights Documentation](https://clickhouse.com/docs/en/operations/access-rights), [Managing Users and Roles](https://clickhouse.com/docs/en/sql-reference/statements/create/user) **3. Connection Details** Once you've configured the user and permissions, provide us with the following details using a secure method of your choice. Popular choices are: * One Time Secret: or * 1Password:
FieldDescriptionExamp
HostYour ClickHouse server hostname or IPclickhouse.yourcompany.com
PortConnection port
(default: `8123` for HTTP, `8443` for HTTPS)

Note: Port 8443 will automatically enable HTTPS connections for secure data transfer.		8123
DatabaseThe database containing your dataanalytics
UsernameThe user created for HockeyStackhockeystack_user
PasswordThe password for the HockeyStack user(securely shared)
TableThe specific table to import data fromevents
**4. Integration Details** We connect using Node.js workers with the official ClickHouse client to ensure a stable and efficient integration. For more technical details on how the connector works, refer to ClickHouse's official documentation: ) ### Pulling Data from ClickHouse HockeyStack runs scheduled workers (typically daily, though this can be customized) to pull data from your ClickHouse instance. The process is as follows: **Initial Historical Backfill** We start by running a full backfill of your historical data. This ensures that HockeyStack has all necessary historical records before moving on to incremental updates. Depending on the size of your dataset, this process may take some time. **Incremental Data Syncs** After the initial backfill, we perform incremental data syncs at the scheduled frequency. These syncs pull in new or updated records since the last sync, ensuring your HockeyStack analytics remain up-to-date.To enable incremental syncs, your table should have a timestamp column (such as \`updated\_at\` or \`created\_at\`) that we can use to identify new or modified records. ### Troubleshooting If you encounter connection issues, please verify: 1\. The ClickHouse server is accessible from HockeyStack's IP addresses 2\. The user has the correct permissions on the specified database and table 3\. The connection details (host, port, credentials) are accurate 4\. Any firewall rules allow incoming connections on the specified port ### Support If you have any questions or need assistance during the integration process, please reach out to our support team at . --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.hockeystack.com/integrations/analytics-and-data-warehouse/clickhouse.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.