Skip to content

Commit a858c59

Browse files
authored
Merge branch 'ClickHouse:main' into update_clusters_tutorial
2 parents 20a03fb + 5b93a7b commit a858c59

File tree

92 files changed

+678
-465
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+678
-465
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,4 @@ docs/cloud/reference/release-notes-index.md
6868
docs/whats-new/changelog/index.md
6969
docs/cloud/manage/api/api-reference-index.md
7070
docs/getting-started/index.md
71+
docs/data-modeling/projections/index.md

docs/about-us/cloud.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: 'ClickHouse Cloud'
1111
ClickHouse Cloud is the cloud offering created by the original creators of the popular open-source OLAP database ClickHouse.
1212
You can experience ClickHouse Cloud by [starting a free trial](https://console.clickhouse.cloud/signUp).
1313

14-
### ClickHouse Cloud benefits: {#clickhouse-cloud-benefits}
14+
## ClickHouse Cloud benefits {#clickhouse-cloud-benefits}
1515

1616
Some of the benefits of using ClickHouse Cloud are described below:
1717

@@ -22,7 +22,28 @@ Some of the benefits of using ClickHouse Cloud are described below:
2222
- **Total cost of ownership**: Best price / performance ratio and low administrative overhead.
2323
- **Broad ecosystem**: Bring your favorite data connectors, visualization tools, SQL and language clients with you.
2424

25-
### What version of ClickHouse does ClickHouse Cloud use? {#what-version-of-clickhouse-does-clickhouse-cloud-use}
25+
<!--
26+
## OSS vs ClickHouse Cloud comparison {#oss-vs-clickhouse-cloud}
27+
28+
| Feature | Benefits | OSS ClickHouse | ClickHouse Cloud |
29+
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------------|
30+
| **Deployment modes** | ClickHouse provides flexibility to self-manage with open-source or deploy in the cloud. Use ClickHouse Local for local files without a server or chDB to embed ClickHouse directly into your application. | ✅ | ✅ |
31+
| **Storage** | As an open-source and cloud-hosted product, ClickHouse can be deployed in both shared-disk and shared-nothing architectures. | ✅ | ✅ |
32+
| **Monitoring and alerting** | Monitoring and alerting about the status of your services is critical to ensuring optimal performance and a proactive approach to detect and triage potential issues. | ✅ | ✅ |
33+
| **ClickPipes** | ClickPipes is ClickHouse's managed ingestion pipeline that allows you to seamlessly connect your external data sources like databases, APIs, and streaming services into ClickHouse Cloud, eliminating the need for managing pipelines, custom jobs, or ETL processes. It supports workloads of all sizes. | ❌ | ✅ |
34+
| **Pre-built integrations** | ClickHouse provides pre-built integrations that connect ClickHouse to popular tools and services such as data lakes, SQL and language clients, visualization libraries, and more. | ❌ | ✅ |
35+
| **SQL console** | The SQL console offers a fast, intuitive way to connect, explore, and query ClickHouse databases, featuring a slick caption, query interface, data import tools, visualizations, collaboration features, and GenAI-powered SQL assistance. | ❌ | ✅ |
36+
| **Compliance** | ClickHouse Cloud compliance includes CCPA, EU-US DPF, GDPR, HIPAA, ISO 27001, ISO 27001 SoA, PCI DSS, SOC2. ClickHouse Cloud's security, availability, processing integrity, and confidentiality processes are all independently audited. Details: trust.clickhouse.com. | ❌ | ✅ |
37+
| **Enterprise-grade security** | Support for advanced security features such as SSO, multi-factor authentication, role-based access control (RBAC), private and secure connections with support for Private Link and Private Service Connect, IP filtering, customer-managed encryption keys (CMEK), and more. | ❌ | ✅ |
38+
| **Scaling and optimization** | Seamlessly scales up or down based on workload, supporting both horizontal and vertical scaling. With automated backups, replication, and high availability, ClickHouse, it provides users with optimal resource allocation. | ❌ | ✅ |
39+
| **Support services** | Our best-in-class support services and open-source community resources provide coverage for whichever deployment model you choose. | ❌ | ✅ |
40+
| **Database upgrades** | Regular database upgrades are essential to establish a strong security posture and access the latest features and performance improvements. | ❌ | ✅ |
41+
| **Backups** | Backups and restore functionality ensures data durability and supports graceful recovery in the event of outages or other disruptions. | ❌ | ✅ |
42+
| **Compute-compute separation** | Users can scale compute resources independently of storage, so teams and workloads can share the same storage and maintain dedicated compute resources. This ensures that the performance of one workload doesn't interfere with another, enhancing flexibility, performance, and cost-efficiency. | ❌ | ✅ |
43+
| **Managed services** | With a cloud-managed service, teams can focus on business outcomes and accelerate time-to-market without having to worry about the operational overhead of sizing, setup, and maintenance of ClickHouse. | ❌ | ✅ |
44+
-->
45+
46+
## What version of ClickHouse does ClickHouse Cloud use? {#what-version-of-clickhouse-does-clickhouse-cloud-use}
2647

2748
Clickhouse Cloud continuously upgrades your service to a newer version. After publishing a core database version in the open source, we do additional validation in our cloud staging environment, which typically takes 6-8 weeks before rolling out to production. The rollout is phased out by cloud service provider, service type, and region.
2849

docs/best-practices/using_data_skipping_indices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ LIMIT 1
140140
A simple analysis shows that `ViewCount` is correlated with the `CreationDate` (a primary key) as one might expect - the longer a post exists, the more time it has to be viewed.
141141

142142
```sql
143-
SELECT toDate(CreationDate) as day, avg(ViewCount) as view_count FROM stackoverflow.posts WHERE day > '2009-01-01' GROUP BY day
143+
SELECT toDate(CreationDate) AS day, avg(ViewCount) AS view_count FROM stackoverflow.posts WHERE day > '2009-01-01' GROUP BY day
144144
```
145145

146146
This therefore makes a logical choice for a data skipping index. Given the numeric type, a min_max index makes sense. We add an index using the following `ALTER TABLE` commands - first adding it, then "materializing it".

docs/cloud/get-started/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Welcome to ClickHouse Cloud! Explore the pages below to learn more about what Cl
99

1010
| Page | Description |
1111
|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
12-
| [Overview](/cloud/overview) | Overview of the benefits of using ClickHouse Cloud and what version of ClickHouse is used for it. |
13-
| [Cloud Quick Start](/cloud/get-started/cloud-quick-start) | Quick start guide to get up and running with Cloud. |
12+
| [Overview](/cloud/overview) | Overview of the benefits of using ClickHouse Cloud and what version of ClickHouse is used for it. |
1413
| [SQL Console](/cloud/get-started/sql-console) | Learn about the interactive SQL console available in Cloud |
1514
| [Query Insights](/cloud/get-started/query-insights) | Learn about how Cloud's Query Insights feature makes ClickHouse's built-in query log easier to use through various visualizations and tables. |
1615
| [Query Endpoints](/cloud/get-started/query-endpoints) | Learn about the Query API Endpoints feature which allows you to create an API endpoint directly from any saved SQL query in the ClickHouse Cloud console. |

docs/cloud/get-started/query-endpoints.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ If you have a saved query, you can skip this step.
2929
Open a new query tab. For demonstration purposes, we'll use the [youtube dataset](/getting-started/example-datasets/youtube-dislikes), which contains approximately 4.5 billion records. As an example query, we'll return the top 10 uploaders by average views per video in a user-inputted `year` parameter:
3030

3131
```sql
32-
with sum(view_count) as view_sum,
33-
round(view_sum / num_uploads, 2) as per_upload
34-
select
32+
WITH sum(view_count) AS view_sum,
33+
round(view_sum / num_uploads, 2) AS per_upload
34+
SELECT
3535
uploader,
36-
count() as num_uploads,
37-
formatReadableQuantity(view_sum) as total_views,
38-
formatReadableQuantity(per_upload) as views_per_video
39-
from
36+
count() AS num_uploads,
37+
formatReadableQuantity(view_sum) AS total_views,
38+
formatReadableQuantity(per_upload) AS views_per_video
39+
FROM
4040
youtube
41-
where
41+
WHERE
4242
toYear(upload_date) = {year: UInt16}
4343
group by uploader
4444
order by per_upload desc
@@ -149,7 +149,7 @@ To upgrade the endpoint version from `v1` to `v2`, include the `x-clickhouse-end
149149
**Query API Endpoint SQL:**
150150

151151
```sql
152-
SELECT database, name as num_tables FROM system.tables limit 3;
152+
SELECT database, name AS num_tables FROM system.tables LIMIT 3;
153153
```
154154

155155
#### Version 1 {#version-1}
@@ -365,7 +365,7 @@ OK
365365
**Query API Endpoint SQL:**
366366

367367
```sql
368-
SELECT * from system.tables;
368+
SELECT * FROM system.tables;
369369
```
370370

371371
**cURL:**
@@ -401,7 +401,7 @@ fetch(
401401
**Query API Endpoint SQL:**
402402

403403
```sql
404-
SELECT name, database from system.tables;
404+
SELECT name, database FROM system.tables;
405405
```
406406

407407
**Typescript:**

docs/cloud/get-started/sql-console.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -251,17 +251,17 @@ Query result sets can be easily exported to CSV format directly from the SQL con
251251
Some data can be more easily interpreted in chart form. You can quickly create visualizations from query result data directly from the SQL console in just a few clicks. As an example, we'll use a query that calculates weekly statistics for NYC taxi trips:
252252

253253
```sql
254-
select
255-
toStartOfWeek(pickup_datetime) as week,
256-
sum(total_amount) as fare_total,
257-
sum(trip_distance) as distance_total,
258-
count(*) as trip_total
259-
from
254+
SELECT
255+
toStartOfWeek(pickup_datetime) AS week,
256+
sum(total_amount) AS fare_total,
257+
sum(trip_distance) AS distance_total,
258+
count(*) AS trip_total
259+
FROM
260260
nyc_taxi
261-
group by
261+
GROUP BY
262262
1
263-
order by
264-
1 asc
263+
ORDER BY
264+
1 ASC
265265
```
266266

267267
<Image img={tabular_query_results} size="md" alt='Tabular query results' />

docs/cloud/manage/upgrades.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,16 @@ You will not be charged for the time that the service is under maintenance. _Mai
3939

4040
## Release channels (upgrade schedule) {#release-channels-upgrade-schedule}
4141

42-
You are able to specify the upgrade schedule for your ClickHouse Cloud service by subscribing to a specific release channel.
42+
Users are able to specify the upgrade schedule for their ClickHouse Cloud service by subscribing to a specific release channel. There are three release channels, and the user has the ability to configure the day and time of the week for upgrades with the **scheduled upgrades** feature.
43+
44+
The three release channels are:
45+
- The [**fast release channel**](#fast-release-channel-early-upgrades) for early access to upgrades.
46+
- The [**regular release channel**](#regular-release-channel) is the default, and upgrades on this channel start two weeks after the fast release channel upgrades. If your service on the Scale and Enterprise tier does not have a release channel set, it is on the regular release channel by default.
47+
- The [**slow release channel**](#slow-release-channel-deferred-upgrades) is for deferred release. Upgrades on this channel occur two weeks after the regular release channel upgrades.
48+
49+
:::note
50+
Basic tier services are automatically enlisted to the fast release channel
51+
:::
4352

4453
### Fast release channel (early upgrades) {#fast-release-channel-early-upgrades}
4554

@@ -76,6 +85,18 @@ Upgrades to the regular release channel are typically performed two weeks after
7685
Basic tier services are upgraded soon after the Fast release channel.
7786
:::
7887

88+
### Slow release channel (deferred upgrades) {#slow-release-channel-deferred-upgrades}
89+
90+
<EnterprisePlanFeatureBadge feature="The slow release channel"/>
91+
92+
We offer a **Slow release** channel if you would like your services to receive upgrades after the regular release schedule.
93+
94+
Specifically, services will:
95+
96+
- Be upgraded after the Fast and Regular release channels roll-outs are complete
97+
- Receive ClickHouse releases ~ 2 weeks after the regular release
98+
- Be meant for customers that want additional time to test ClickHouse releases on their non-production environments before the production upgrade. Non-production environments can either get upgrades on the Fast or the Regular release channel for testing and validation.
99+
79100
## Scheduled upgrades {#scheduled-upgrades}
80101

81102
<EnterprisePlanFeatureBadge feature="Scheduled upgrades" linking_verb_are="true"/>

docs/cloud/reference/changelog.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,21 @@ import query_endpoints from '@site/static/images/cloud/reference/may-17-query-en
3030
import dashboards from '@site/static/images/cloud/reference/may-30-dashboards.png';
3131

3232
In addition to this ClickHouse Cloud changelog, please see the [Cloud Compatibility](/cloud/reference/cloud-compatibility.md) page.
33-
## June 13, 2025 {#june-13-2025}
3433

35-
- We're excited to announce that ClickHouse Cloud Dashboards are now generally available. Dashboards allow users to visualize queries on dashboards, interact with data via filters and query parameters, and manage sharing.
34+
## June 27, 2025 {#june-27-2025}
35+
36+
- We now officially support a Terraform provider for managing database privileges
37+
which is also compatible with self-managed deployments. Please refer to the
38+
[blog](https://clickhouse.com/blog/new-terraform-provider-manage-clickhouse-database-users-roles-and-privileges-with-code)
39+
and our [docs](https://registry.terraform.io/providers/ClickHouse/clickhousedbops/latest/docs)
40+
for more information.
41+
- Enterprise tier services can now enlist in the [slow release channel](/manage/updates/#slow-release-channel-deferred-upgrades) to defer
42+
upgrades by two weeks after the regular release to permit additional time for
43+
testing.
44+
45+
## June 13, 2025 {#june-13-2025}
3646

47+
- We're excited to announce that ClickHouse Cloud Dashboards are now generally available. Dashboards allow users to visualize queries on dashboards, interact with data via filters and query parameters, and manage sharing.
3748
- API key IP filters: we are introducing an additional layer of protection for your interactions with ClickHouse Cloud. When generating an API key, you may setup an IP allow list to limit where the API key may be used. Please refer to the [documentation](https://clickhouse.com/docs/cloud/security/setting-ip-filters) for details.
3849

3950
## May 30, 2025 {#may-30-2025}

docs/cloud/reference/warehouses.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ Once compute-compute is enabled for a service (at least one secondary service wa
135135
6. **CREATE/RENAME/DROP DATABASE queries could be blocked by idled/stopped services by default.** These queries can hang. To bypass this, you can run database management queries with `settings distributed_ddl_task_timeout=0` at the session or per query level. For example:
136136

137137
```sql
138-
create database db_test_ddl_single_query_setting
139-
settings distributed_ddl_task_timeout=0
138+
CREATE DATABASE db_test_ddl_single_query_setting
139+
SETTINGS distributed_ddl_task_timeout=0
140140
```
141141

142142
6. **In very rare cases, secondary services that are idled or stopped for a long time (days) without waking/starting up can cause performance degradation to other services in the same warehouse.** This issue will be resolved soon and is connected to mutations running in the background. If you think you are experiencing this issue, please contact ClickHouse [Support](https://clickhouse.com/support/program).

docs/data-modeling/backfilling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ While we can add the target table, prior to adding the materialized view we modi
371371
```sql
372372
CREATE MATERIALIZED VIEW pypi_downloads_per_day_mv TO pypi_downloads_per_day
373373
AS SELECT
374-
toStartOfHour(timestamp) as hour,
374+
toStartOfHour(timestamp) AS hour,
375375
project, count() AS count
376376
FROM pypi WHERE timestamp >= '2024-12-17 09:00:00'
377377
GROUP BY hour, project

0 commit comments

Comments
 (0)