Skip to main content

Documentation Index

Fetch the complete documentation index at: https://private-7c7dfe99-page-updates.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

All quickstarts
BeginnerReal-Time AnalyticsData WarehousingObservabilityAI/MLCloud

Prerequisites

To successfully follow this guide, you’ll need the following: You should also have completed the Create your first Cloud service quickstart, as you’ll need an existing ClickHouse Cloud service to retrieve connection details from.

What you’ll build

In this quickstart you’ll learn how to locate the connection details for your ClickHouse Cloud service - the hostname, port numbers, username, and password you need to connect from any external client, CLI tool, or application. By the end, you’ll know where to find these details in the Cloud console and how to verify connectivity using a simple curl command, so you’re ready to connect from tools like clickhouse-local, clickhouse-client, or any ClickHouse driver.
1

Open the Cloud console

Navigate to the ClickHouse Cloud console and sign in to your account.From the main dashboard, locate the service you want to connect to. If the service is idled, click on it and wait for it to wake up before proceeding - you’ll need it running to verify connectivity in a later step.
2

Find your connection details

Click on your service to open its details page, then click the Connect button in the left sidebar:Connect button in the ClickHouse Cloud console (light mode)The first time you click this button, you’ll see a dialogue showing your credentials:
DetailDescription
UsernameYour username (typically default)
PasswordThe generated password for your service
There is also a dropdown with preformatted example connection strings for different protocols and interfaces (e.g. clickhouse-client, HTTPS, JDBC, etc.), which you can copy directly.
Download the credentials file or copy your password and store it somewhere safe. Once you close this dialogue, you will not be able to see the password again.
You’ll also find your service hostname on the service details page (e.g. abc123.us-east-1.aws.clickhouse.cloud). Copy it along with your credentials - you’ll need both throughout the remaining steps and in subsequent quickstarts.
If you’ve lost your password, you can reset it from the Settings tab of your service in the Cloud console.
3

Understand the connection protocols

ClickHouse Cloud exposes two main network protocols, each on its own port:
  • Native protocol (port 9440) - A binary protocol used by clickhouse-client, clickhouse-local, and most language-specific drivers. It is the fastest option and supports all ClickHouse features. TLS is required on Cloud.
  • HTTPS protocol (port 8443) - An HTTP-based interface useful for REST clients, curl, web-based tools, and drivers that prefer HTTP. Also requires TLS on Cloud.
Both protocols require TLS encryption when connecting to ClickHouse Cloud - you cannot connect over plaintext. Most tools handle this automatically when you specify the correct port, but you may need to pass a --secure flag or set ssl=true depending on the client.For most quickstarts and CLI workflows in this series, you’ll use the native protocol on port 9440.
4

Save your connection details for reuse

You’ll use these connection details frequently across quickstarts. To avoid retyping them every time, you can export them as environment variables in your terminal session:
export CLICKHOUSE_HOST=YOUR_HOST.clickhouse.cloud
export CLICKHOUSE_USER=default
export CLICKHOUSE_PASSWORD=YOUR_PASSWORD
Replace the values with your actual hostname, username, and password. If you’ll be connecting to your Cloud service using clickhouse-client or clickhouse-local, obtain the hostname by selecting ‘Native’ from the dropdown next to “Connect with:”. Copy the hostname which appears after --host from the shown connection example.
These environment variables only persist for your current terminal session. Do not store passwords in shell profile files (.bashrc, .zshrc) or commit them to version control.

Next steps

You now have all the connection details needed to connect to your ClickHouse Cloud service from any external tool. The hostname, port, username, and password you found here are used throughout the rest of the quickstart series. Check out the following quickstarts next: Or go deeper with the reference documentation:
ClickHouse Academy — Master ClickHouse with expert-designed training for every skill level