Skip to content

Commit 133e547

Browse files
committed
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs into autogenerate_global_server_settings
2 parents 819abea + 6fa7bf0 commit 133e547

File tree

21 files changed

+137
-128
lines changed

21 files changed

+137
-128
lines changed

.github/workflows/build-search.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
node-version: '20'
2929

3030
- name: Run Prep from Master
31-
run: yarn copy-clickhouse-repo-docs
31+
run: yarn copy-clickhouse-repo-docs -f
3232

3333
- name: Run Auto Generate Settings
3434
run: yarn autogenerate-settings

contribute/style-guide.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,21 +76,31 @@ keywords: [chdb, clickhouse-local]
7676
import clickhouse-local-1 from '@site/static/images/chdb/guides/clickhouse-local-1.png'
7777
import clickhouse-local-2 from '@site/static/images/chdb/guides/clickhouse-local-2.png'
7878
import clickhouse-local-3 from '@site/static/images/chdb/guides/clickhouse-local-3.png'
79+
import Image from '@theme/IdealImage';
7980
```
8081

81-
Use the `<img/>` tag to place your image in the appropriate place:
82+
To render images we use a fork of the IdealImage plugin. This generates multiple variants of an image, [asynchronously loading them as well as selecting the most appropriate based on the network connection](https://github.com/stereobooster/react-ideal-image/blob/master/introduction.md).
83+
84+
Ensure you import the `Image` component as shown above.
85+
86+
Use the `<Image/>` tag to place your image in the appropriate place:
8287

8388
```markdown
8489
Here is some example text which refers to the image below:
8590

86-
<img src={clickhouse-local-1}
87-
alt='DESCRIPTION OF THE IMAGE'
88-
style={{width: '800px'}} // optional
89-
/>
91+
<Image img={clickhouse-local-1} alt='DESCRIPTION OF THE IMAGE' size="md" border background="black"/>
9092

9193
Here is another paragraph...
9294
```
9395

96+
This component takes a number of props:
97+
98+
1. `img` - the imported image
99+
2. `alt` - mandatory alternate text specified
100+
3. `size` - either `lg` (width 1024px), `md` (width 600px), `sm` (width 300px) or `logo` (48x). This sets the maximum image size. Lower resolutions maybe used on smaller screens or slower connections.
101+
4. `border` - Applies a border. **Use for screenshots only.**
102+
5. `background` - either `white` or `black`. Applicable if your image is transparent. All new images must use `black`.
103+
94104
## Codeblocks
95105

96106
Codeblocks are defined using backticks. For example:

docs/chdb/guides/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ in the table of contents, please edit the frontmatter of the files directly.
1515

1616
| Page | Description |
1717
|-----|-----|
18-
| [How to query Parquet files](/docs/chdb/guides/querying-parquet) | Learn how to query Parquet files with chDB. |
19-
| [How to query data in an S3 bucket](/docs/chdb/guides/querying-s3) | Learn how to query data in an S3 bucket with chDB. |
20-
| [Using a clickhouse-local database](/docs/chdb/guides/clickhouse-local) | Learn how to use a clickhouse-local database with chDB |
21-
| [How to query Pandas DataFrames with chDB](/docs/chdb/guides/pandas) | Learn how to query Pandas DataFrames with chDB |
22-
| [JupySQL and chDB](/docs/chdb/guides/jupysql) | How to install chDB for Bun |
23-
| [How to query a remote ClickHouse server](/docs/chdb/guides/query-remote-clickhouse) | In this guide, we'll learn how to query a remote ClickHouse server from chDB. |
24-
| [How to query Apache Arrow with chDB](/docs/chdb/guides/apache-arrow) | In this guide, we'll learn how to query Apache Arrow tables with chDB |
18+
| [How to query Parquet files](/chdb/guides/querying-parquet) | Learn how to query Parquet files with chDB. |
19+
| [How to query data in an S3 bucket](/chdb/guides/querying-s3) | Learn how to query data in an S3 bucket with chDB. |
20+
| [Using a clickhouse-local database](/chdb/guides/clickhouse-local) | Learn how to use a clickhouse-local database with chDB |
21+
| [How to query Pandas DataFrames with chDB](/chdb/guides/pandas) | Learn how to query Pandas DataFrames with chDB |
22+
| [JupySQL and chDB](/chdb/guides/jupysql) | How to install chDB for Bun |
23+
| [How to query a remote ClickHouse server](/chdb/guides/query-remote-clickhouse) | In this guide, we'll learn how to query a remote ClickHouse server from chDB. |
24+
| [How to query Apache Arrow with chDB](/chdb/guides/apache-arrow) | In this guide, we'll learn how to query Apache Arrow tables with chDB |

docs/cloud/manage/billing/payment-thresholds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ This payment threshold does not apply to customers who have a committed spend co
1616

1717
If your organization reaches 90% of the payment threshold and is on-track to exceed the payment threshold mid-period, the billing email associated with the organization will receive an email notification. You will also receive an email notification as well as an invoice when you exceed the payment threshold.
1818

19-
These payment thresholds can be adjusted. If you have any questions, please contact support@clickhouse.com for more details.
19+
These payment thresholds can be adjusted below $10,000 as requested by customers or by the ClickHouse Finance team. If you have any questions, please contact support@clickhouse.com for more details.

docs/cloud/manage/notifications.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,30 @@ ClickHouse Cloud sends notifications about critical events related to your servi
1919

2020
## Receiving Notifications {#receiving-notifications}
2121

22-
Notifications can be received via various channels. For now, ClickHouse Cloud supports receiving notifications through email and ClickHouse Cloud UI. You can click on the bell icon in the top left menu to view current notifications, which opens a flyout. Clicking the button **View All** the bottom of the flyout will take you to a page that shows an activity log of all notifications.
23-
24-
<br />
22+
Notifications can be received via various channels. For now, ClickHouse Cloud supports receiving notifications through email, ClickHouse Cloud UI, and Slack. You can click on the bell icon in the top left menu to view current notifications, which opens a flyout. Clicking the button **View All** the bottom of the flyout will take you to a page that shows an activity log of all notifications.
2523

2624
<Image img={notifications_1} size="md" alt="ClickHouse Cloud notifications flyout" border/>
2725

28-
<br />
2926

3027
<Image img={notifications_2} size="md" alt="ClickHouse Cloud notifications activity log" border/>
3128

29+
3230
## Customizing Notifications {#customizing-notifications}
3331

3432
For each notification, you can customize how you receive the notification. You can access the settings screen from the notifications flyout or from the second tab on the notifications activity log.
3533

36-
To configure delivery for a specific notification, click on the pencil icon to modify the notification delivery channels.
34+
Cloud users can customize notifications delivered via the Cloud UI, and these customizations are reflected for each individual user. Cloud users can also customize notifications delivered to their own emails, but only users with admin permissions can customize notifications delivered to custom emails and notifications delivered to Slack channels.
3735

38-
<br />
36+
To configure delivery for a specific notification, click on the pencil icon to modify the notification delivery channels.
3937

4038
<Image img={notifications_3} size="md" alt="ClickHouse Cloud notifications settings screen" border/>
4139

42-
<br />
43-
4440
<Image img={notifications_4} size="md" alt="ClickHouse Cloud notification delivery settings" border/>
4541

46-
<br />
47-
4842
:::note
4943
Certain **required** notifications such as **Payment failed** are not configurable.
5044
:::
5145

5246
## Supported Notifications {#supported-notifications}
5347

54-
Currently, we send out notifications related to billing (payment failure, usage exceeded ascertain threshold, etc.) as well as notifications related to scaling events (scaling completed, scaling blocked etc.). In future, we will add notifications for backups, ClickPipes, and other relevant categories.
48+
Currently, we send out notifications related to billing (payment failure, usage exceeded ascertain threshold, etc.) as well as notifications related to scaling events (scaling completed, scaling blocked etc.).

docs/cloud/reference/shared-merge-tree.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ CREATE TABLE default.myFirstReplacingMT
9898
( `key` Int64, `someCol` String, `eventTime` DateTime )
9999
ENGINE = SharedReplacingMergeTree('/clickhouse/tables/{uuid}/{shard}', '{replica}')
100100
ORDER BY key
101-
SETTINGS index_granularity = 8192
102101
```
103102

104103
## Settings {#settings}

docs/cloud/reference/warehouses.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ settings distributed_ddl_task_timeout=0
140140

141141
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).
142142

143+
7. **Currently there is a soft limit of 5 services per warehouse.** Contact the support team if you need more than 5 services in a single warehouse.
144+
143145

144146
## Pricing {#pricing}
145147

docs/cloud/security/compliance-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The Health Insurance Portability and Accountability Act (HIPAA) of 1996 is a Uni
3333

3434
### PCI Service Provider (Since 2025) {#pci-service-provider-since-2025}
3535

36-
<EnterprisePlanFeatureBadge feature="HIPAA" support="true"/>
36+
<EnterprisePlanFeatureBadge feature="PCI compliance" support="true"/>
3737

3838
Customers must contact sales or support to onboard services to PCI compliant regions to load cardholder data. Additionally, customers should review our PCI responsibility overview available in our [Trust Center](https://trust.clickhouse.com), select and implement appropriate controls for their use case.
3939

0 commit comments

Comments
 (0)