Skip to content

Commit 7135450

Browse files
authored
Merge pull request #79 from ClickHouse/ppv2_proofread
PPV2 Docs Proofread
2 parents 25721bf + c1491c5 commit 7135450

File tree

12 files changed

+119
-105
lines changed

12 files changed

+119
-105
lines changed

docs/en/about-us/cloud.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,10 @@ Some of the benefits of using ClickHouse Cloud are described below:
2121
- **Total cost of ownership**: Best price / performance ratio and low administrative overhead.
2222
- **Broad ecosystem**: Bring your favorite data connectors, visualization tools, SQL and language clients with you.
2323

24-
You can see a walkthrough of how to get started in the video below:
25-
26-
<div class='vimeo-container'>
27-
28-
<iframe width="640" height="360" src="https://www.youtube.com/embed/uWNY0GLUkqc?si=xzj59FEuNxRY7wAb" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
29-
30-
</div>
31-
3224
### What version of ClickHouse does ClickHouse Cloud use?
3325

3426
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.
3527

36-
We offer a "Fast" Release Channel for subscribing to updates ahead of the regular release schedule. Access to early upgrades is recommended only for non-production environments and can be requested by logging a support ticket.
28+
We offer a "Fast" Release Channel for subscribing to updates ahead of the regular release schedule. For more details, see ["Fast Release Channel"](../cloud/manage/upgrades.md/#fast-release-channel-early-upgrades).
3729

3830
If you rely on functionality in the earlier version, you can, in some cases, revert to the previous behavior using your service's compatibility setting.

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

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ You can upload data using the following methods:
130130

131131
### Add data using the SQL Console
132132

133-
Like most database management systems, ClickHouse logically groups tables into **databases**. Use the `CREATE DATABASE` command to create a new database in ClickHouse:
133+
Like most database management systems, ClickHouse logically groups tables into **databases**. Use the [`CREATE DATABASE`](../../sql-reference/statements/create/database.md) command to create a new database in ClickHouse:
134134

135135
```sql
136136
CREATE DATABASE IF NOT EXISTS helloworld
@@ -150,20 +150,20 @@ ENGINE = MergeTree()
150150
PRIMARY KEY (user_id, timestamp)
151151
```
152152

153-
In the example above, `my_first_table` is a MergeTree table with four columns:
153+
In the example above, `my_first_table` is a [`MergeTree`](../../engines/table-engines/mergetree-family/mergetree.md) table with four columns:
154154

155-
- `user_id`: a 32-bit unsigned integer
156-
- `message`: a String data type, which replaces types like VARCHAR, BLOB, CLOB and others from other database systems
157-
- `timestamp`: a DateTime value, which represents an instant in time
158-
- `metric`: a 32-bit floating point number
155+
- `user_id`: a 32-bit unsigned integer ([UInt32](../../sql-reference/data-types/int-uint.md))
156+
- `message`: a [String](../../sql-reference/data-types/string.md) data type, which replaces types like `VARCHAR`, `BLOB`, `CLOB` and others from other database systems
157+
- `timestamp`: a [DateTime](../../sql-reference/data-types/datetime.md) value, which represents an instant in time
158+
- `metric`: a 32-bit floating point number ([Float32](../../sql-reference/data-types/float.md))
159159

160-
:::note table engines
161-
The table engine determines:
162-
- How and where the data is stored
160+
:::note Table engines
161+
Table engines determine:
162+
- How and where data is stored
163163
- Which queries are supported
164164
- Whether or not the data is replicated
165-
166-
There are many engines to choose from, but for a simple table on a single-node ClickHouse server, [MergeTree](/en/engines/table-engines/mergetree-family/mergetree.md) is your likely choice.
165+
<br/>
166+
There are many table engines to choose from, but for a simple table on a single-node ClickHouse server, [`MergeTree`](/en/engines/table-engines/mergetree-family/mergetree.md) is your likely choice.
167167
:::
168168

169169
#### A Brief Intro to Primary Keys
@@ -184,9 +184,14 @@ then the key becomes the tuple specified in the `ORDER BY` clause. If you specif
184184
The primary key is also the sorting key, which is a tuple of `(user_id, timestamp)`. Therefore, the data stored in each
185185
column file will be sorted by `user_id`, then `timestamp`.
186186

187+
For a deep dive into core ClickHouse concepts, see ["Core Concepts"](../../managing-data/core-concepts/index.md).
188+
189+
## 4. Insert Data
190+
187191
#### Insert data into your table
188192

189-
You can use the familiar `INSERT INTO TABLE` command with ClickHouse, but it is important to understand that each insert into a `MergeTree` table causes a **part** to be created in storage.
193+
194+
You can use the familiar [`INSERT INTO TABLE`](../../sql-reference/statements/insert-into.md) command with ClickHouse, but it is important to understand that each insert into a [`MergeTree`](/en/engines/table-engines/mergetree-family/mergetree.md) table causes a **part** to be created in storage.
190195

191196
:::tip ClickHouse best practice
192197
Insert a large number of rows per batch - tens of thousands or even millions of
@@ -206,7 +211,7 @@ INSERT INTO helloworld.my_first_table (user_id, message, timestamp, metric) VALU
206211
```
207212

208213
:::note
209-
Notice the `timestamp` column is populated using various **Date** and **DateTime** functions. ClickHouse has hundreds of useful functions that you can [view in the **Functions** section](/docs/en/sql-reference/functions/).
214+
Notice the `timestamp` column is populated using various [**Date**](../../sql-reference/data-types/date.md) and [**DateTime**](../../sql-reference/data-types/datetime.md) functions. ClickHouse has hundreds of useful functions that you can [view in the **Functions** section](/docs/en/sql-reference/functions/).
210215
:::
211216

212217
Let's verify it worked:
@@ -262,7 +267,7 @@ Notice the response comes back in a nice table format:
262267
4 rows in set. Elapsed: 0.008 sec.
263268
```
264269

265-
4. Add a `FORMAT` clause to specify one of the [many supported output formats of ClickHouse](/en/interfaces/formats/):
270+
4. Add a [`FORMAT`](../../sql-reference/statements/select/format.md) clause to specify one of the [many supported output formats of ClickHouse](/en/interfaces/formats/):
266271

267272
<br/>
268273

@@ -300,7 +305,7 @@ the timestamp of the event.
300305

301306
Suppose we have the following text in a CSV file named `data.csv`:
302307

303-
```bash
308+
```bash title="data.csv"
304309
102,This is data in a file,2022-02-22 10:43:28,123.45
305310
101,It is comma-separated,2022-02-23 00:00:00,456.78
306311
103,Use FORMAT to specify the format,2022-02-21 10:43:30,678.90

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,15 @@ The Cell Inspector tool can be used to view large amounts of data contained with
4242

4343
### Sorting a table
4444

45-
To sort a table in the SQL console, open a table and select the ‘Sort’ button in the toolbar. This button will open a menu that will allow you to configure your sort. You can choose a column by which to sort and configure the ordering of the sort (ascending or descending). Select ‘Apply’ or press Enter to sort your table
45+
To sort a table in the SQL console, open a table and select the ‘Sort’ button in the toolbar. This button will open a menu that will allow you to configure your sort. You can choose a column by which you want to sort and configure the ordering of the sort (ascending or descending). Select ‘Apply’ or press Enter to sort your table
4646

4747
![sort descending on a column](@site/docs/en/cloud/images/sqlconsole/sort-descending-on-column.png)
4848

49-
The SQL console also allows you to add multiple sorts to a table. Click the ‘Sort’ button again to add another sort. Note: sorts are applied in the order that they appear in the sort pane (top to bottom). To remove a sort, simply click the ‘x’ button next to the sort.
49+
The SQL console also allows you to add multiple sorts to a table. Click the ‘Sort’ button again to add another sort.
50+
51+
:::note
52+
Sorts are applied in the order that they appear in the sort pane (top to bottom). To remove a sort, simply click the ‘x’ button next to the sort.
53+
:::
5054

5155
### Filtering a table
5256

docs/en/cloud/manage/_snippets/_network_transfer_rates.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The table below shows how data transfer charges for egress vary across public in
99
<th>Region</th>
1010
<th>Public Internet Egress</th>
1111
<th>Same region</th>
12-
<th>Cross-region (all Tier 1)</th>
12+
<th>Cross-region <br/>(all Tier 1)</th>
1313
</tr>
1414
</thead>
1515
<tbody>
@@ -112,40 +112,40 @@ $^*$Data transfer charges are in $ per GB of data transferred
112112
<td>`us-central1`</td>
113113
<td>`$0.1140`</td>
114114
<td>`$0.0000`</td>
115-
<td>`$0.0360 (Tier 1)`</td>
116-
<td>`$0.0720 (Tier 2)`</td>
117-
<td>`$0.1200 (Tier 3)`</td>
118-
<td>`$0.1620 (Tier 4)`</td>
115+
<td>`$0.0360` (Tier 1)</td>
116+
<td>`$0.0720` (Tier 2)</td>
117+
<td>`$0.1200` (Tier 3)</td>
118+
<td>`$0.1620` (Tier 4)</td>
119119
</tr>
120120
<tr>
121121
<td>`GCP`</td>
122122
<td>`us-east1`</td>
123123
<td>`$0.1140`</td>
124124
<td>`$0.0000`</td>
125-
<td>`$0.0360 (Tier 1)`</td>
126-
<td>`$0.0720 (Tier 2)`</td>
127-
<td>`$0.1200 (Tier 3)`</td>
128-
<td>`$0.1620 (Tier 4)`</td>
125+
<td>`$0.0360` (Tier 1)</td>
126+
<td>`$0.0720` (Tier 2)</td>
127+
<td>`$0.1200` (Tier 3)</td>
128+
<td>`$0.1620` (Tier 4)</td>
129129
</tr>
130130
<tr>
131131
<td>`GCP`</td>
132132
<td>`europe-west4`</td>
133133
<td>`$0.1140`</td>
134134
<td>`$0.0000`</td>
135-
<td>`$0.0720 (Tier 2)`</td>
136-
<td>`$0.0360 (Tier 1)`</td>
137-
<td>`$0.1200 (Tier 3)`</td>
138-
<td>`$0.1620 (Tier 4)`</td>
135+
<td>`$0.0720` (Tier 2)</td>
136+
<td>`$0.0360` (Tier 1)</td>
137+
<td>`$0.1200` (Tier 3)</td>
138+
<td>`$0.1620` (Tier 4)</td>
139139
</tr>
140140
<tr>
141141
<td>`GCP`</td>
142142
<td>`asia-southeast1`</td>
143143
<td>`$0.1440`</td>
144144
<td>`$0.0000`</td>
145-
<td>`$0.1200 (Tier 3)`</td>
146-
<td>`$0.1200 (Tier 3)`</td>
147-
<td>`$0.1200 (Tier 3)`</td>
148-
<td>`$0.1620 (Tier 4)`</td>
145+
<td>`$0.1200` (Tier 3)</td>
146+
<td>`$0.1200` (Tier 3)</td>
147+
<td>`$0.1200` (Tier 3)</td>
148+
<td>`$0.1620` (Tier 4)</td>
149149
</tr>
150150
</tbody>
151151
</table>
@@ -176,30 +176,30 @@ $^*$Data transfer charges are in $ per GB of data transferred
176176
<td>`eastus2`</td>
177177
<td>`$0.1020`</td>
178178
<td>`$0.0000`</td>
179-
<td>`$0.0300 (Tier 1)`</td>
180-
<td>`$0.0660 (Tier 2)`</td>
181-
<td>`$0.0660 (Tier 2)`</td>
182-
<td>`$0.0660 (Tier 2)`</td>
179+
<td>`$0.0300` (Tier 1)</td>
180+
<td>`$0.0660` (Tier 2)</td>
181+
<td>`$0.0660` (Tier 2)</td>
182+
<td>`$0.0660` (Tier 2)</td>
183183
</tr>
184184
<tr>
185185
<td>`Azure`</td>
186186
<td>`westus3`</td>
187187
<td>`$0.1020`</td>
188188
<td>`$0.0000`</td>
189-
<td>`$0.0300 (Tier 1)`</td>
190-
<td>`$0.0660 (Tier 2)`</td>
191-
<td>`$0.0660 (Tier 2)`</td>
192-
<td>`$0.0660 (Tier 2)`</td>
189+
<td>`$0.0300` (Tier 1)</td>
190+
<td>`$0.0660` (Tier 2)</td>
191+
<td>`$0.0660` (Tier 2)</td>
192+
<td>`$0.0660` (Tier 2)</td>
193193
</tr>
194194
<tr>
195195
<td>`Azure`</td>
196196
<td>`germanywestcentral`</td>
197197
<td>`$0.1020`</td>
198198
<td>`$0.0000`</td>
199-
<td>`$0.0660 (Tier 2)`</td>
200-
<td>`$0.0300 (Tier 1)`</td>
201-
<td>`$0.0660 (Tier 2)`</td>
202-
<td>`$0.0660 (Tier 2)`</td>
199+
<td>`$0.0660` (Tier 2)</td>
200+
<td>`$0.0300` (Tier 1)</td>
201+
<td>`$0.0660` (Tier 2)</td>
202+
<td>`$0.0660` (Tier 2)</td>
203203
</tr>
204204
</tbody>
205205
</table>

0 commit comments

Comments
 (0)