Skip to content

Commit 9fe3ae5

Browse files
authored
Merge pull request #4167 from Blargian/poc_onboarding
Restructure of docs Cloud section
2 parents 9fb490b + c4f107f commit 9fe3ae5

File tree

215 files changed

+3178
-1897
lines changed

Some content is hidden

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

215 files changed

+3178
-1897
lines changed

docs/_snippets/_users-and-roles-common.md

Lines changed: 55 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -42,64 +42,73 @@ Create these tables and users to be used in the examples.
4242

4343
#### Creating a sample database, table, and rows {#creating-a-sample-database-table-and-rows}
4444

45-
1. Create a test database
45+
<VerticalStepper headerLevel="h5">
4646

47-
```sql
48-
CREATE DATABASE db1;
49-
```
47+
##### Create a test database {#create-a-test-database}
5048

51-
2. Create a table
49+
```sql
50+
CREATE DATABASE db1;
51+
```
5252

53-
```sql
54-
CREATE TABLE db1.table1 (
55-
id UInt64,
56-
column1 String,
57-
column2 String
58-
)
59-
ENGINE MergeTree
60-
ORDER BY id;
61-
```
53+
##### Create a table {#create-a-table}
6254

63-
3. Populate the table with sample rows
55+
```sql
56+
CREATE TABLE db1.table1 (
57+
id UInt64,
58+
column1 String,
59+
column2 String
60+
)
61+
ENGINE MergeTree
62+
ORDER BY id;
63+
```
6464

65-
```sql
66-
INSERT INTO db1.table1
67-
(id, column1, column2)
68-
VALUES
69-
(1, 'A', 'abc'),
70-
(2, 'A', 'def'),
71-
(3, 'B', 'abc'),
72-
(4, 'B', 'def');
73-
```
65+
##### Populate the table with sample rows {#populate}
7466

75-
4. Verify the table:
67+
```sql
68+
INSERT INTO db1.table1
69+
(id, column1, column2)
70+
VALUES
71+
(1, 'A', 'abc'),
72+
(2, 'A', 'def'),
73+
(3, 'B', 'abc'),
74+
(4, 'B', 'def');
75+
```
7676

77-
```sql
78-
SELECT *
79-
FROM db1.table1
80-
```
77+
##### Verify the table {#verify}
8178

82-
```response
83-
Query id: 475015cc-6f51-4b20-bda2-3c9c41404e49
79+
```sql title="Query"
80+
SELECT *
81+
FROM db1.table1
82+
```
8483

85-
┌─id─┬─column1─┬─column2─┐
86-
│ 1 │ A │ abc │
87-
│ 2 │ A │ def │
88-
│ 3 │ B │ abc │
89-
│ 4 │ B │ def │
90-
└────┴─────────┴─────────┘
91-
```
84+
```response title="Response"
85+
Query id: 475015cc-6f51-4b20-bda2-3c9c41404e49
9286
93-
5. Create a regular user that will be used to demonstrate restrict access to certain columns:
87+
┌─id─┬─column1─┬─column2─┐
88+
│ 1 │ A │ abc │
89+
│ 2 │ A │ def │
90+
│ 3 │ B │ abc │
91+
│ 4 │ B │ def │
92+
└────┴─────────┴─────────┘
93+
```
9494

95-
```sql
96-
CREATE USER column_user IDENTIFIED BY 'password';
97-
```
95+
##### Create `column_user` {#create-a-user-with-restricted-access-to-columns}
9896

99-
6. Create a regular user that will be used to demonstrate restricting access to rows with certain values:
100-
```sql
101-
CREATE USER row_user IDENTIFIED BY 'password';
102-
```
97+
Create a regular user that will be used to demonstrate restrict access to certain columns:
98+
99+
```sql
100+
CREATE USER column_user IDENTIFIED BY 'password';
101+
```
102+
103+
##### Create `row_user` {#create-a-user-with-restricted-access-to-rows-with-certain-values}
104+
105+
Create a regular user that will be used to demonstrate restricting access to rows with certain values:
106+
107+
```sql
108+
CREATE USER row_user IDENTIFIED BY 'password';
109+
```
110+
111+
</VerticalStepper>
103112

104113
#### Creating roles {#creating-roles}
105114

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
| Page | Description |
2+
|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
3+
| [Choosing a Primary Key](/best-practices/choosing-a-primary-key) | How to select primary keys that maximize query performance and minimize storage overhead. |
4+
| [Select Data Types](/best-practices/select-data-types) | Choose optimal data types to reduce memory usage, improve compression, and accelerate queries. |
5+
| [Use Materialized Views](/best-practices/use-materialized-views) | Leverage materialized views to pre-aggregate data and dramatically speed up analytical queries. |
6+
| [Minimize and Optimize JOINs](/best-practices/minimize-optimize-joins) | Best practices for using ClickHouse's `JOIN` capabilities efficiently. |
7+
| [Choosing a Partitioning Key](/best-practices/choosing-a-partitioning-key) | Select partitioning strategies that enable efficient data pruning and faster query execution. |
8+
| [Selecting an Insert Strategy](/best-practices/selecting-an-insert-strategy) | Optimize data ingestion throughput and reduce resource consumption with proper insert patterns. |
9+
| [Data Skipping Indices](/best-practices/use-data-skipping-indices-where-appropriate) | Apply secondary indices strategically to skip irrelevant data blocks and accelerate filtered queries. |
10+
| [Avoid Mutations](/best-practices/avoid-mutations) | Design schemas and workflows that eliminate costly `UPDATE`/`DELETE` operations for better performance. |
11+
| [Avoid OPTIMIZE FINAL](/best-practices/avoid-optimize-final) | Prevent performance bottlenecks by understanding when `OPTIMIZE FINAL` hurts more than it helps. |
12+
| [Use JSON where appropriate](/best-practices/use-json-where-appropriate) | Balance flexibility and performance when working with semi-structured JSON data in ClickHouse. |

docs/best-practices/index.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,10 @@ hide_title: true
66
description: 'Landing page for Best Practices section in ClickHouse'
77
---
88

9+
import TableOfContents from '@site/docs/best-practices/_snippets/_table_of_contents.md';
10+
911
# Best Practices in ClickHouse {#best-practices-in-clickhouse}
1012

1113
This section provides the best practices you will want to follow to get the most out of ClickHouse.
1214

13-
| Page | Description |
14-
|----------------------------------------------------------------------|--------------------------------------------------------------------------|
15-
| [Choosing a Primary Key](/best-practices/choosing-a-primary-key) | Guidance on selecting an effective Primary Key in ClickHouse. |
16-
| [Select Data Types](/best-practices/select-data-types) | Recommendations for choosing appropriate data types. |
17-
| [Use Materialized Views](/best-practices/use-materialized-views) | When and how to benefit from materialized views. |
18-
| [Minimize and Optimize JOINs](/best-practices/minimize-optimize-joins)| Best practices for minimizing and optimizing JOIN operations. |
19-
| [Choosing a Partitioning Key](/best-practices/choosing-a-partitioning-key) | How to choose and apply partitioning keys effectively. |
20-
| [Selecting an Insert Strategy](/best-practices/selecting-an-insert-strategy) | Strategies for efficient data insertion in ClickHouse. |
21-
| [Data Skipping Indices](/best-practices/use-data-skipping-indices-where-appropriate) | When to apply data skipping indices for performance gains. |
22-
| [Avoid Mutations](/best-practices/avoid-mutations) | Reasons to avoid mutations and how to design without them. |
23-
| [Avoid OPTIMIZE FINAL](/best-practices/avoid-optimize-final) | Why `OPTIMIZE FINAL` can be costly and how to work around it. |
24-
| [Use JSON where appropriate](/best-practices/use-json-where-appropriate) | Considerations for using JSON columns in ClickHouse. |
15+
<TableOfContents/>

docs/chdb/guides/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,13 @@ in the table of contents, please edit the frontmatter of the files directly.
1414
-->
1515

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

docs/cloud-index.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/cloud/_snippets/_clickpipes_faq.md

Whitespace-only changes.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
| Page | Description |
2+
|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
3+
| [Shared Responsibility Model](/cloud/security/shared-responsibility-model) | Understand how security responsibilities are divided between ClickHouse Cloud and your organization for different service types. |
4+
| [Cloud Access Management](/cloud/security/cloud-access-management) | Manage user access with authentication, single sign-on (SSO), role-based permissions, and team invitations. |
5+
| [Connectivity](/cloud/security/connectivity) | Configure secure network access including IP allow-lists, private networking, S3 data access, and Cloud IP address management. |
6+
| [Enhanced Encryption](/cloud/security/cmek) | Learn about default AES 256 encryption and how to enable Transparent Data Encryption (TDE) for additional data protection at rest. |
7+
| [Audit Logging](/cloud/security/audit-logging) | Set up and use audit logging to track and monitor activities in your ClickHouse Cloud environment. |
8+
| [Privacy and Compliance](/cloud/security/privacy-compliance-overview) | Review security certifications, compliance standards, and learn how to manage your personal information and data rights. |

docs/cloud/bestpractices/index.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/cloud/bestpractices/usagelimits.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/cloud/manage/cloud-tiers.md renamed to docs/cloud/features/01_cloud_tiers.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -164,17 +164,18 @@ This page discusses which tiers are right for your specific use case.
164164

165165
:::note
166166
Services in the basic tier are meant to be fixed in size and do not allow scaling, both automatic and manual.
167-
Users can upgrade to the Scale or Enterprise tier to scale their services.
167+
You can upgrade to the Scale or Enterprise tier to scale their services.
168168
:::
169169

170170
## Scale {#scale}
171171

172172
Designed for workloads requiring enhanced SLAs (2+ replica deployments), scalability, and advanced security.
173173

174174
- Offers support for features such as:
175-
- [Private networking support](../security/private-link-overview.md).
175+
- [Private networking support](/cloud/security/private-link-overview).
176176
- [Compute-compute separation](../reference/warehouses#what-is-compute-compute-separation).
177-
- [Flexible scaling](../manage/scaling.md) options (scale up/down, in/out).
177+
- [Flexible scaling](/manage/scaling) options (scale up/down, in/out).
178+
- [Configurable backups](/cloud/manage/backups/configurable-backups)
178179

179180
## Enterprise {#enterprise}
180181

@@ -186,8 +187,8 @@ Caters to large-scale, mission critical deployments that have stringent security
186187
- Supports enterprise-grade security:
187188
- Single Sign On (SSO)
188189
- Enhanced Encryption: For AWS and GCP services. Services are encrypted by our key by default and can be rotated to their key to enable Customer Managed Encryption Keys (CMEK).
189-
- Allows Scheduled upgrades: Users can select the day of the week/time window for upgrades, both database and cloud releases.
190-
- Offers [HIPAA](../security/compliance-overview.md/#hipaa-since-2024) Compliance.
190+
- Allows Scheduled upgrades: you can select the day of the week/time window for upgrades, both database and cloud releases.
191+
- Offers [HIPAA](/cloud/security/compliance-overview#hipaa-since-2024) and PCI compliance.
191192
- Exports Backups to the user's account.
192193

193194
:::note

0 commit comments

Comments
 (0)