ClickHouse/clickhouse-docs-embeddings huggingface dataset:
Gather your connection details

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/guides/SQL_console/connection_details.md)

To connect to ClickHouse with HTTP(S) you need this information:

|  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- |
| Parameter(s) Description|  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | | `HOST` and `PORT` Typically, the port is 8443 when using TLS or 8123 when not using TLS.|  |  |  |  | | --- | --- | --- | --- | | `DATABASE NAME` Out of the box, there is a database named `default`, use the name of the database that you want to connect to.| `USERNAME` and `PASSWORD` Out of the box, the username is `default`. Use the username appropriate for your use case. | | | | | | | |

The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console.
Select a service and click **Connect**:

Choose **HTTPS**. Connection details are displayed in an example `curl` command.

If you're using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

Was this page helpful?
ClickHouse Private

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/guides/infrastructure/01_deployment_options/02_clickhouse-private.md)

## Overview[​](#overview "Direct link to Overview")

ClickHouse Private is a self-deployed package consisting of the same proprietary version of ClickHouse that runs on ClickHouse Cloud and our ClickHouse Operator, configured for separation of compute and storage.

Note

ClickHouse Private is designed for large enterprises deploying > 2 TB memory requiring full control over their dedicated infrastructure. Customers are responsible for managing all infrastructure and should be knowledgeable on operating ClickHouse at scale. This option is only available by [contacting us](https://clickhouse.com/company/contact?loc=nav).

## Benefits over open-source[​](#benefits-over-os "Direct link to Benefits over open-source")

The following features differentiate ClickHouse Private from self-managed open source deployments:

- Native separation of compute and storage
- Proprietary cloud features such as [shared merge tree](/docs/cloud/reference/shared-merge-tree) and [warehouse](/docs/cloud/reference/warehouses) functionality
- ClickHouse database and operator versions fully tested and validated in ClickHouse Cloud
- API for prgrammatic operations, including backups and scaling operations

## Architecture[​](#architecture "Direct link to Architecture")

ClickHouse Private is fully self-contained within your deployment environment, offering our cloud native separation of compute and storage.

  
  

## Supported configurations[​](#supported-configurations "Direct link to Supported configurations")

ClickHouse Private is currently supported in the following configurations:

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Environment Orchestration Storage Status|  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | AWS Elastic Kubernetes Service (EKS) Simple Storage Service (S3) Available|  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | | GCP Google Kubernetes Service (GKS) Google Cloud Storage (GCS) Preview|  |  |  |  | | --- | --- | --- | --- | | Bare metal Kubernetes AIStor (NVMe required) Preview | | | | | | | | | | | | | | | |

## Onboarding process[​](#onboarding-process "Direct link to Onboarding process")

Customers may [contact us](https://clickhouse.com/company/contact?loc=nav) to request a call to review ClickHouse Private for their use case. Use cases meeting minimum size requirements and deployed to supported configurations will be reviewed. Onboarding is limited. The installation process involves following an install guide for the specific environment where ClickHouse will be deployed using images and Helm charts downloaded from AWS ECR.

- [Overview](#overview)- [Benefits over open-source](#benefits-over-os)- [Architecture](#architecture)- [Supported configurations](#supported-configurations)- [Onboarding process](#onboarding-process)

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/guides/backups/index.md)

|  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- |
| Page Description|  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | | [Overview](/docs/cloud/manage/backups/overview) Overview page for backups.|  |  |  |  | | --- | --- | --- | --- | | [Configurable Backups](/docs/cloud/manage/backups/configurable-backups) Learn about how you can customize your backup schedules according to your specific business needs with the Scale and Enterprise tiers|  |  | | --- | --- | | [Export Backups to your Own Cloud Account](/docs/cloud/manage/backups/export-backups-to-own-cloud-account) Learn about an Enterprise tier feature that gives you the ability to export backups to your own cloud account. | | | | | | | |

Was this page helpful?
Backup / restore via user-interface

Get SQL command used to restore backup

##### Get SQL command used to restore backup[​](#azure-obtain-sql-command-to-restore-backup "Direct link to Get SQL command used to restore backup")

Click on the `access or restore a backup` link above the list of backups in the
UI to obtain the SQL command to restore the backup. The command should look like
this, and you can pick the appropriate backup from the dropdown to get the
restore command for that specific backup. You will need to add your Azure
storage account connection string to the command.

Moving backups to another location

If you move the backups to another location, you will need to customize the restore command to reference the new location.

ASYNC command

For the Restore command you can also optionally add an `ASYNC` command at the end for large restores.
This allows the restores to happen asynchronously, so that if connection is lost, the restore keeps running.
It is important to note that the ASYNC command immediately returns a status of success.
This doesn't mean the restore was successful.
You will need to monitor the `system.backups` table to see if the restore has finished and if it succeeded or failed.

Run SQL command to restore backup

##### Run SQL command to restore backup[​](#azure-run-sql-command-to-restore-backup "Direct link to Run SQL command to restore backup")

Run the restore command from the SQL console in the newly created service to
restore the backup.

- [AWS](#AWS)
  - [Taking backups to AWS](#taking-backups-to-aws)- [Restoring backups from AWS](#restoring-backups-from-aws)- [GCP](#gcp)
    - [Taking backups to GCP](#taking-backups-to-gcp)- [Restoring backups from GCP](#gcp-restoring-backups-from-gcp)- [Azure](#azure)
      - [Taking backups to Azure](#taking-backups-to-azure)- [Restoring backups from Azure](#azure-restore-steps)

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/guides/backups/02_configurable-backups.md)

Scale plan feature

Configurable Backups are available in the Scale and Enterprise plans. To upgrade, visit the plans page in the cloud console.

To configure the backup schedule for a service, go to the **Settings** tab in the console and click on **Change backup configuration**.

This opens a tab to the right where you can choose values for retention, frequency, and start time. You will need to save the chosen settings for them to take effect.

Note

Start time and frequency are mutually exclusive. Start time takes precedence.

Note

Changing the backup schedule can cause higher monthly charges for storage as some of the backups might not be covered in the default backups for the service. See ["Understanding backup cost"](/docs/cloud/manage/backups/overview#understanding-backup-cost) section below.

Was this page helpful?
Review and restore backups

In our testing, we have seen that smaller backups of ~1 TB could take around 10-15 minutes or longer to back up.
Backups less than 20 TB should complete within an hour, and backing up 50 TB of data should take about 2-3 hours.
Backups get economies of scale at larger sizes, and we have seen backups of up to 1 PB for some internal services complete in about 10 hours.

Note

Backups to external buckets may be slower than backups to ClickHouse buckets

Restore durations are about the same as the backup durations.

We recommend testing with your own database or sample data to get better estimates as the actual duration depends on several factors as outlined above.

## Configurable backups[​](#configurable-backups "Direct link to Configurable backups")

If you want to set up a backups schedule different from the default backup schedule, take a look at [Configurable Backups](/docs/cloud/manage/backups/configurable-backups).

## Export backups to your own cloud account[​](#export-backups-to-your-own-cloud-account "Direct link to Export backups to your own cloud account")

For users wanting to export backups to their own cloud account, see [here](/docs/cloud/manage/backups/export-backups-to-own-cloud-account).

- [Backup status list](#backup-status-list)- [Understanding backup cost](#understanding-backup-cost)- [Restore a backup](#restore-a-backup)- [Working with your restored service](#working-with-your-restored-service)
        - [Use the **new restored service**](#use-the-new-restored-service)- [Migrate data from the **newly restored service** back to the **original service**](#migrate-data-from-the-newly-restored-service-back-to-the-original-service)- [Undeleting or undropping tables](#undeleting-or-undropping-tables)- [Backup durations](#backup-durations)- [Configurable backups](#configurable-backups)- [Export backups to your own cloud account](#export-backups-to-your-own-cloud-account)

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/reference/03_billing/index.md)

This section of the documentation covers topics related to billing, and contains the following pages:

|  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Page Description|  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | | [Overview](/docs/cloud/manage/billing/overview) Pricing examples and FAQs for billing.|  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | | [Payment Thresholds](/docs/cloud/billing/payment-thresholds) Learn more about how payment thresholds work and how to adjust them.|  |  |  |  | | --- | --- | --- | --- | | [Troubleshooting Billing Issues](/docs/manage/clickhouse-cloud-billing-compliance) Troubleshoot common billing issues.|  |  | | --- | --- | | [Marketplace](/docs/cloud/manage/marketplace) Landing page for further marketplace related topics. | | | | | | | | | |

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/reference/03_billing/02_marketplace/index.md)

This section details billing related topics for Marketplace.

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Page Description|  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | [Marketplace Billing](/docs/cloud/marketplace/marketplace-billing) FAQ on Marketplace billing.|  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | [AWS Marketplace PAYG](/docs/cloud/billing/marketplace/aws-marketplace-payg) Get started with ClickHouse Cloud on the AWS Marketplace via a PAYG (Pay-as-you-go) Public Offer.|  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | [AWS Marketplace Committed Contract](/docs/cloud/billing/marketplace/aws-marketplace-committed-contract) Get started with ClickHouse Cloud on the AWS Marketplace via a committed contract. A committed contract, also known as a a Private Offer, allows customers to commit to spending a certain amount on ClickHouse Cloud over a period of time.|  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | | [GCP Marketplace PAYG](/docs/cloud/billing/marketplace/gcp-marketplace-payg) Get started with ClickHouse Cloud on the GCP Marketplace via a PAYG (Pay-as-you-go) Public Offer.|  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | | [GCP Marketplace Committed Contract](/docs/cloud/billing/marketplace/gcp-marketplace-committed-contract) Get started with ClickHouse Cloud on the GCP Marketplace via a committed contract. A committed contract, also known as a a Private Offer, allows customers to commit to spending a certain amount on ClickHouse Cloud over a period of time.|  |  |  |  | | --- | --- | --- | --- | | [Azure Marketplace PAYG](/docs/cloud/billing/marketplace/azure-marketplace-payg) Get started with ClickHouse Cloud on the Azure Marketplace via a PAYG (Pay-as-you-go) Public Offer.|  |  | | --- | --- | | [Azure Marketplace Committed Contract](/docs/cloud/billing/marketplace/azure-marketplace-committed-contract) Get started with ClickHouse Cloud on the Azure Marketplace via a committed contract. A committed contract, also known as a a Private Offer, allows customers to commit to spending a certain amount on ClickHouse Cloud over a period of time. | | | | | | | | | | | | | | | |

Was this page helpful?
Migrating between self-managed ClickHouse and ClickHouse Cloud using remoteSecure

```
  CREATE TABLE db.table ...
  ```

#### Allow remote access to the source service[​](#allow-remote-access-to-the-source-service "Direct link to Allow remote access to the source service")

In order to pull data from the source to the destination the source service must allow connections. Temporarily disable the "IP Access List" functionality on the source service.

Tip

If you will continue to use the source ClickHouse Cloud service then export the existing IP Access list to a JSON file before switching to allow access from anywhere; this will allow you to import the access list after the data is migrated.

Modify the allow list and allow access from **Anywhere** temporarily. See the [IP Access List](/docs/cloud/security/setting-ip-filters) docs for details.

#### Copy the data from source to destination[​](#copy-the-data-from-source-to-destination "Direct link to Copy the data from source to destination")

- Use the `remoteSecure` function to pull the data from the source ClickHouse Cloud service
  Connect to the destination. Run this command on the destination ClickHouse Cloud service:

  ```
  INSERT INTO db.table SELECT * FROM
  remoteSecure('source-hostname', db, table, 'exporter', 'password-here')
  ```
- Verify the data in the destination service

#### Re-establish the IP access list on the source[​](#re-establish-the-ip-access-list-on-the-source "Direct link to Re-establish the IP access list on the source")

If you exported the access list earlier, then you can re-import it using **Share**, otherwise re-add your entries to the access list.

#### Remove the read-only `exporter` user[​](#remove-the-read-only-exporter-user "Direct link to remove-the-read-only-exporter-user")

```
DROP USER exporter
```

- Switch the service IP Access List to limit access

- [Migrating from self-managed ClickHouse to ClickHouse Cloud](#migrating-from-self-managed-clickhouse-to-clickhouse-cloud)
  - [Overview](#overview)- [Migration of tables from one system to another:](#migration-of-tables-from-one-system-to-another)- [On the source ClickHouse system (the system that currently hosts the data)](#on-the-source-clickhouse-system-the-system-that-currently-hosts-the-data)- [On the destination ClickHouse Cloud system:](#on-the-destination-clickhouse-cloud-system)- [Migrating between ClickHouse Cloud services](#migrating-between-clickhouse-cloud-services)

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/02_etl-tool-to-clickhouse.md)

A great option for moving data from an external data source into ClickHouse is to use one of the many popular ETL and ELT. We have docs that cover the following:

- [Airbyte](/docs/integrations/airbyte)
- [dbt](/docs/integrations/dbt)
- [Vector](/docs/integrations/vector)

But there are many other ETL/ELT tools that integrate with ClickHouse, so check your favorite tool's documentation for details.

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/reference/index.md)

This section acts as a reference guide for some of the more technical details of ClickHouse Cloud and contains the following pages:

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Page Description|  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | [Architecture](/docs/cloud/reference/architecture) Discusses the architecture of ClickHouse Cloud, including storage, compute, administration, and security.|  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | [SharedMergeTree](/docs/cloud/reference/shared-merge-tree) Explainer on SharedMergeTree, the cloud-native replacement for the ReplicatedMergeTree and analogues.|  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | [Warehouses](/docs/cloud/reference/warehouses) Explainer on what Warehouses and compute-compute separation are in ClickHouse Cloud.|  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | | [BYOC (Bring Your Own Cloud)](/docs/cloud/reference/byoc/overview) Explainer on the Bring Your Own Cloud (BYOC) service available with ClickHouse Cloud.|  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | | [Changelogs](/docs/cloud/reference/changelogs) Cloud Changelogs and Release Notes.|  |  |  |  | | --- | --- | --- | --- | | [Cloud Compatibility](/docs/whats-new/cloud-compatibility) A guide to what to expect functionally and operationally in ClickHouse Cloud.|  |  | | --- | --- | | [Supported Cloud Regions](/docs/cloud/reference/supported-regions) A list of the supported cloud regions for AWS, Google and Azure. | | | | | | | | | | | | | | | |

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/reference/03_billing/03_clickpipes/index.md)

Note

Usage is free for MySQL and MongoDB CDC ClickPipes before reaching General Availability (GA). Customers will be notified ahead of GA launches to review and optimize their ClickPipes usage.

[ClickPipes](/docs/integrations/clickpipes) billing is based on **compute usage** and **ingested data**. For more information on the pricing model for each category, see the dedicated billing pages:

|  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- |
| Page Description|  |  |  |  | | --- | --- | --- | --- | | [ClickPipes for Postgres CDC](/docs/cloud/reference/billing/clickpipes/postgres-cdc) Pricing for PostgreSQL CDC ClickPipes.|  |  | | --- | --- | | [ClickPipes for streaming and object storage](/docs/cloud/reference/billing/clickpipes/streaming-and-object-storage) Pricing for streaming and object storage ClickPipes. | | | | | |

Was this page helpful?
ClickPipes for streaming and object storage

What are the ClickPipes public prices?

- Compute: $0.20 per unit per hour ($0.05 per replica per hour)
- Ingested data: $0.04 per GB

How does it look in an illustrative example?

For example, ingesting 1 TB of data over 24 hours using the Kafka connector using a single replica (0.25 compute unit) costs:

(0.25×0.20×24)+(0.04×1000)=$41.2(0.25 \times 0.20 \times 24) + (0.04 \times 1000) = \$41.2(0.25×0.20×24)+(0.04×1000)=$41.2  

For object storage connectors (S3 and GCS),
only the ClickPipes compute cost is incurred since the ClickPipes pod isn't processing data
but only orchestrating the transfer which is operated by the underlying ClickHouse service:

0.25×0,20×24=$1.20.25 \times 0,20 \times 24 = \$1.20.25×0,20×24=$1.2

How does ClickPipes pricing compare to the market?

The philosophy behind ClickPipes pricing is
to cover the operating costs of the platform while offering an easy and reliable way to move data to ClickHouse Cloud.
From that angle, our market analysis revealed that we're positioned competitively.

- [What does the ClickPipes pricing structure look like?](#what-does-the-clickpipes-pricing-structure-look-like)- [What are ClickPipes replicas?](#what-are-clickpipes-replicas)- [What is the default number of replicas and their size?](#what-is-the-default-number-of-replicas-and-their-size)- [What are the ClickPipes public prices?](#what-are-the-clickpipes-public-prices)- [How does it look in an illustrative example?](#how-does-it-look-in-an-illustrative-example)- [FAQ for streaming and object storage ClickPipes](#faq-streaming-and-object-storage)

Was this page helpful?
Connect to ClickHouse

## Troubleshooting Connection Issues[​](#troubleshooting "Direct link to Troubleshooting Connection Issues")

If you're experiencing connection issues:

1. **Verify endpoint accessibility**: Ensure you're using the correct endpoint (public vs. private)
2. **Check IP filters**: For public load balancers, verify your IP address is in the allow list
3. **Verify network connectivity**: For private connections, ensure VPC peering or PrivateLink is properly configured
4. **Check security groups**: For private load balancers, verify security group rules allow traffic from your source network
5. **Check security groups**: For PrivateLink or Private Service Connect, verify the endpoint ID has been added to the allowlist of the ClickHouse service
6. **Review authentication**: Ensure you're using correct credentials (username and password)
7. **Contact Support**: If issues persist, contact ClickHouse Support

- [Public Load Balancer](#public-load-balancer)
  - [Overview](#public-load-balancer-overview)- [Connecting via Public Load Balancer](#connecting-via-public-load-balancer)- [IP Filtering](#public-ip-filtering)- [Private Load Balancer](#private-load-balancer)
    - [Overview](#private-load-balancer-overview)- [Connecting via Private Load Balancer](#connecting-via-private-load-balancer)- [IP Filtering](#private-ip-filtering)- [Security Group Configuration](#security-group-configuration)- [PrivateLink or Private Service Connect](#privatelink-or-private-service-connect)
      - [Overview](#privatelink-overview)- [Connecting via PrivateLink/Private Service Connect](#connecting-via-privatelink)- [Endpoint ID Allowlist](#endpoint-id-allowlist)- [Choosing the Right Connection Method](#choosing-connection-method)- [Troubleshooting Connection Issues](#troubleshooting)

Was this page helpful?
title_wip

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/04_setup_a_new_region.md)

After completing the initial onboarding, you may wish to deploy additional BYOC infrastructure in a different region or in another AWS account or GCP project.

To add a new BYOC deployment:

Navigate to your organization's "Infrastructure" page in the ClickHouse Cloud console.

Navigate to your organization's "Infrastructure" page in the ClickHouse Cloud console.

Select "Add new account" or "Add new infrastructure" and follow the guided interface to complete the setup process.

Select "Add new account" or "Add new infrastructure" and follow the guided interface to complete the setup process.

Was this page helpful?