General Destination Setup Guide
Prerequisites
- A CloudQuery Platform account with admin access
- Connection credentials for your destination (hostname, port, username, password, or connection string)
CloudQuery Platform includes a default ClickHouse database destination. All platform features — including SQL Console and Asset Inventory — depend on this destination. If you add another destination, keep the default ClickHouse destination as your primary. Additional destinations should serve as auxiliary targets.
Creating the destination
Go to Data Pipelines → Destinations and click Create Destination:
Search for the name of your destination. In the example below, the search is for PostgreSQL. Click the destination card in the search results.
On the next screen, enter a Destination Name to identify the destination later (if unsure, use the name of the destination).
Fill in the required configuration fields for the destination. Most destinations present a guided form with fields for connection details and credentials.
Some destinations use a YAML specification field instead of a guided form. For those, store sensitive values as secrets in the Secrets section and reference them using placeholders such as ${MY_SECRET_VALUE}. See the destination’s documentation for the required format.
Testing your connection
To save the destination, click the Test and Save button. The platform validates your configuration by attempting to connect to the destination.
During the test:
- A progress bar shows the test is running (tests can take up to 60 seconds)
- If the test succeeds, the destination is saved
- If the test fails, an error message and logs are displayed below the form
Common test connection failures
| Issue | Cause | Fix |
|---|---|---|
| Connection refused | Destination is not reachable | Verify the hostname, port, and network connectivity from the platform to the destination |
| Authentication error | Invalid credentials | Check the username, password, or connection string in the Secrets section |
| Permission denied | User lacks write permissions | Verify the database user has permissions to create tables and insert data |
| SSL/TLS error | Certificate or encryption mismatch | Check SSL mode settings in the destination configuration and verify the destination’s TLS configuration |
| Invalid configuration | Syntax error or missing required field | Check that all required fields are filled in correctly — refer to the destination’s documentation for the expected format |
You can re-run the test after making changes without leaving the page.
After your first sync
Once a sync completes, verify data is arriving at your destination. If you are using the default ClickHouse destination, open the SQL Console and run a query to confirm tables were created:
SHOW TABLESYou can also browse synced resources in the Asset Inventory.
Next steps
- Set up a sync to schedule when your data is fetched and from which integration
- Browse synced resources in the Asset Inventory
- Run advanced queries in the SQL Console
- Find destination-specific configuration options in the CloudQuery Hub
Last updated on