Skip to content

Commit 1bafb12

Browse files
committed
Merge remote-tracking branch 'origin/add-dataflow-docs' into add-dataflow-docs
2 parents fc9a448 + 7b2d278 commit 1bafb12

File tree

119 files changed

+4356
-518
lines changed

Some content is hidden

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

119 files changed

+4356
-518
lines changed

.github/workflows/build-search.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ jobs:
2121

2222
steps:
2323
- name: Checkout Repository
24-
uses: actions/checkout@v3
24+
uses: actions/checkout@v4
2525

2626
- name: Set up Node.js
27-
uses: actions/setup-node@v3
27+
uses: actions/setup-node@v4
2828
with:
2929
node-version: '20'
3030

.github/workflows/check-build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
steps:
1919
# Step 1: Check out the repository
2020
- name: Check out repository
21-
uses: actions/checkout@v3
21+
uses: actions/checkout@v4
2222

2323
# Step 2: Set up environment if required (e.g., installing Aspell)
2424
- name: Install Aspell
@@ -33,7 +33,7 @@ jobs:
3333

3434
# Step 4: Setup Python and dependencies for KB checker
3535
- name: Set up Python
36-
uses: actions/setup-python@v3
36+
uses: actions/setup-python@v5
3737
with:
3838
python-version: '3.x'
3939

.github/workflows/table_of_contents.yml

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,38 +20,43 @@ jobs:
2020
generate_toc_formats:
2121
runs-on: ubuntu-latest
2222
steps:
23-
# Step 1: Check out the repository
23+
24+
# Step 1 - Check out the repository
2425
- name: Check out repository
25-
uses: actions/checkout@v3
26-
27-
# Step 2 - Setup Python
28-
- name: Set up Python
29-
uses: actions/setup-python@v3
26+
uses: actions/checkout@v4
27+
28+
# Step 2 - Pull changes
29+
- name: Pull remote Changes
30+
run: git pull
31+
32+
# Step 3 - Setup python
33+
- name: Set up python
34+
uses: actions/setup-python@v5
3035
with:
3136
python-version: '3.x'
3237

33-
# Step 3: Install Python dependencies
38+
# Step 4 - Install python dependencies
3439
- name: Install dependencies
3540
run: |
3641
python -m pip install --upgrade pip
3742
pip install -r 'scripts/table-of-contents-generator/requirements.txt'
3843
39-
# Step 4 - Pull main repo docs, run script to generate TOCs:
40-
- name: Generate TOCs
44+
# Step 5 - Pull main repo docs, run script to generate TOCs:
45+
- name: Generate table of contents files
4146
run: |
4247
yarn prep-from-master
4348
python -u ./scripts/table-of-contents-generator/toc_gen.py --dir="docs/en/interfaces/formats" --single-toc --out="table-of-contents-files" --ignore "_snippets"
4449
45-
# Step 5 - Fail the workflow if script returns exit code 1
50+
# Step 6 - Fail the workflow if script returns exit code 1
4651
- name: Check exit code
4752
run: |
4853
if [[ "${{ steps.toc_gen.outcome }}" == "failure" ]]; then
4954
echo "Ran into trouble generating a table of contents. See the logs for details."
5055
exit 1
5156
fi
5257
53-
# Step 6 - Check if anything was actually updated
54-
- name: Check for Changes
58+
# Step 7 - Check if anything was actually updated
59+
- name: Check for changes
5560
id: check_changes
5661
run: |
5762
git status -u
@@ -63,7 +68,7 @@ jobs:
6368
echo "has_changes=false" >> $GITHUB_OUTPUT
6469
fi
6570
66-
# Step 7 - Commit and Push generated Table Of Contents files
71+
# Step 8 - Commit and Push generated Table Of Contents files
6772
- uses: stefanzweifel/git-auto-commit-action@v5
6873
env:
6974
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ clickhouse-docs.code-workspace
2828
yarn.lock
2929
yarn.error-log
3030
.comments
31+
yarn-error.log
3132

3233
# Output files used by scripts to verify links
3334
sidebar_links.txt

docs/en/about-us/cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: ClickHouse Cloud
88
# ClickHouse Cloud
99

1010
ClickHouse Cloud is the cloud offering created by the original creators of the popular open-source OLAP database ClickHouse.
11-
You can experience ClickHouse Cloud by [starting a free trial](https://clickhouse.cloud/signUp).
11+
You can experience ClickHouse Cloud by [starting a free trial](https://console.clickhouse.cloud/signUp).
1212

1313
### ClickHouse Cloud benefits:
1414

docs/en/about-us/support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 30
77

88
ClickHouse provides Support Services for our ClickHouse Cloud users and customers. Our objective is a Support Services team that represents the ClickHouse product – unparalleled performance, ease of use, and exceptionally fast, high-quality results. For details, [visit our Support Services](https://clickhouse.com/support/program/) page.
99

10-
[Login to the Cloud console](https://clickhouse.cloud/support) and select **Help -> Support** from the menu options to open a new support case and view the status of your submitted cases.
10+
[Login to the Cloud console](https://console.clickhouse.cloud/support) and select **Help -> Support** from the menu options to open a new support case and view the status of your submitted cases.
1111

1212
**Service level agreements ("SLA")**
1313
Classification of severity levels for issues reported and response times.

docs/en/cloud/bestpractices/usagelimits.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,26 @@ sidebar_label: Usage Limits
44
title: Usage Limits
55
---
66

7-
8-
## Database Limits
9-
Clickhouse is very fast and reliable, but any database has its limits. For example, having too many tables or databases could negatively affect performance. To avoid that, Clickhouse Cloud has guardrails for several types of items.
7+
While ClickHouse is known for its speed and reliability, optimal performance is achieved within certain operating parameters. For example, having too many tables, databases or parts could negatively impact performance. To avoid this, Clickhouse Cloud has guardrails set up for several types of items. You can find details of these guardrails below.
108

119
:::tip
12-
If you've reached one of those limits, it may mean that you are implementing your use case in an unoptimized way. You can contact our support so we can help you refine your use case to avoid going through the limits or to increase the limits in a guided way.
10+
If you've run up against one of these guardrails, it's possible that you are implementing your use case in an unoptimized way. Contact our support team and we will gladly help you refine your use case to avoid exceeding the guardrails or look together at how we can increase them in a controlled manner.
1311
:::
1412

15-
# Tables
16-
Clickhouse Cloud have a limit of **5000** tables per instance
17-
18-
# Databases
19-
Clickhouse Cloud have a limit of **1000** databases per instance
20-
21-
# Partitions
22-
Clickhouse Cloud have a limit of **50000** [partitions](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/custom-partitioning-key) per instance
23-
24-
# Parts
25-
Clickhouse Cloud have a limit of **100000** [parts](https://clickhouse.com/docs/en/operations/system-tables/parts) per instance
13+
- **Databases**: 1000
14+
- **Tables**: 5000-10k
15+
- **Columns**: ∼1000 (wide format is preferred to compact)
16+
- **Partitions**: 50k
17+
- **Parts**: 100k across the entire instance
18+
- **Part size**: 150gb
19+
- **Services**: 20 (soft)
20+
- **Low cardinality**: 10k or less
21+
- **Primary keys in a table**: 4-5 that sufficiently filter down the data
22+
- **Concurrency**: default 100, can be increased to 1000 per node
23+
- **Batch ingest**: anything > 1M will be split by the system in 1M row blocks
2624

2725
:::note
28-
For Single Replica Services, the maximum number of Databases is restricted to 100, and the maximum number of Tables is restricted to 500. In addition, Storage for Basic Tier Services is limited to 1 TB.
26+
For Single Replica Services, the maximum number of databases is restricted to 100, and the maximum number of tables is restricted to 500. In addition, storage for Basic Tier Services is limited to 1 TB.
2927
:::
3028

3129

docs/en/cloud/get-started/cloud-quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ import SQLConsoleDetail from '@site/docs/en/_snippets/_launch_sql_console.md';
1010
# ClickHouse Cloud Quick Start
1111

1212
The quickest and easiest way to get up and running with ClickHouse is to create a new
13-
service in [ClickHouse Cloud](https://clickhouse.cloud).
13+
service in [ClickHouse Cloud](https://console.clickhouse.cloud).
1414

1515
## 1. Create a ClickHouse service
1616

17-
To create a free ClickHouse service in [ClickHouse Cloud](https://clickhouse.cloud), you just need to sign up by completing the following steps:
17+
To create a free ClickHouse service in [ClickHouse Cloud](https://console.clickhouse.cloud), you just need to sign up by completing the following steps:
1818

19-
- Create an account on the [sign-up page](https://clickhouse.cloud/signUp)
19+
- Create an account on the [sign-up page](https://console.clickhouse.cloud/signUp)
2020
- You can choose to sign up using your email or via Google SSO, Microsoft SSO, AWS Marketplace, Google Cloud or Microsoft Azure
2121
- If you sign up using an email and password, remember to verify your email address within the next 24h via the link you receive in your email
2222
- Login using the username and password you just created

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,8 @@ description: Easily spin up REST API endpoints from your saved queries
55
keywords: [api, query api endpoints, query endpoints, query rest api]
66
---
77

8-
import BetaBadge from '@theme/badges/BetaBadge';
9-
108
# Query API Endpoints
119

12-
<BetaBadge />
13-
1410
The **Query API Endpoints** feature allows you to create an API endpoint directly from any saved SQL query in the ClickHouse Cloud console. You'll be able to access API endpoints via HTTP to execute your saved queries without needing to connect to your ClickHouse Cloud service via a native driver.
1511

1612
## Quick-start Guide

docs/en/cloud/manage/api/api-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ The ClickHouse Cloud API is built on the open-source [OpenAPI specification](htt
2929

3030
## Support
3131

32-
We recommend visiting [our Slack channel](https://clickhouse.com/slack) first to get quick support. If you'd like additional help or more info about our API and its capabilities, please contact ClickHouse Support at https://clickhouse.cloud/support
32+
We recommend visiting [our Slack channel](https://clickhouse.com/slack) first to get quick support. If you'd like additional help or more info about our API and its capabilities, please contact ClickHouse Support at https://console.clickhouse.cloud/support

0 commit comments

Comments
 (0)