​
Connect to ClickHouse

Galaxy makes it easy to connect to your ClickHouse database for high-performance analytics on large datasets.

​
Quick Start

  1. Click Add Source in Galaxy
  2. Select ClickHouse from the list
  3. Fill in your connection details
  4. Test the connection
  5. Start querying!

​
Connection Details

Create ClickHouse Source When creating a ClickHouse connection, you’ll need:
​
name
string
required
A friendly name for your connection Example: Analytics ClickHouse or Data Warehouse
​
host
string
required
Your ClickHouse server address Example: localhost or clickhouse.example.com
​
port
number
default:"8443"
required
The port number (usually 8443 for HTTPS, 8123 for HTTP)
​
ssl
boolean
default:"false"
Enable SSL/TLS encryption for the connection
​
username
string
required
Your database username Example: default
​
password
string
Your database password (optional for some configurations)
​
database
string
required
The database name to connect to Example: default

​
Testing Your Connection

Before saving, Galaxy will test your connection to make sure everything works. Click Test Connection to verify your settings.

​
Success

Connection Successful When successful, you’ll see a green confirmation message and can save your connection.

​
Error

Connection Error If there’s an issue, you’ll see an error message with details about what went wrong.

​
Common Issues

​
Connection Failed

  • Double-check your host and port
  • Verify your username and password (if required)
  • Make sure your database allows external connections
  • Check if you’re behind a VPN or firewall
  • Ensure SSL is configured correctly if enabled

​
Authentication Error

  • Confirm your username has access to the database
  • Verify your password is correct (if authentication is enabled)
  • Check if your ClickHouse server uses a different authentication method
  • Some ClickHouse setups allow passwordless access for default user

​
Port Issues

  • HTTPS port is typically 8443
  • HTTP port is typically 8123
  • Native protocol uses port 9000 (not currently supported)
  • Verify which port your ClickHouse server is configured to use

​
SSL/TLS Issues

  • If SSL is enabled, ensure your ClickHouse server has valid certificates
  • Try disabling SSL if you’re connecting to a local or development instance
  • Check if your ClickHouse server requires specific SSL settings

​
Next Steps

Once connected, you can:
  • Browse your tables and schemas in the sidebar
  • Write SQL queries with ClickHouse-specific functions
  • Use the AI agent to help write complex analytical queries
  • Leverage ClickHouse’s powerful aggregation capabilities
  • Save and share your queries with your team