Skip to content

Commit fe8aaac

Browse files
committed
Merge branch 'image_component' of https://github.com/clickhouse/clickhouse-docs into image_component
2 parents 4627dd5 + 40ed2ff commit fe8aaac

Some content is hidden

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

50 files changed

+346
-816
lines changed

docs/cloud/bestpractices/asyncinserts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ title: 'Asynchronous Inserts (async_insert)'
55
description: 'Describes how to use asynchronous inserts into ClickHouse as an alternative best practice to batching'
66
---
77

8+
import Image from '@theme/IdealImage';
89
import asyncInsert01 from '@site/static/images/cloud/bestpractices/async-01.png';
910
import asyncInsert02 from '@site/static/images/cloud/bestpractices/async-02.png';
1011
import asyncInsert03 from '@site/static/images/cloud/bestpractices/async-03.png';
11-
import Image from '@theme/IdealImage';
1212

1313
Inserting data into ClickHouse in large batches is a best practice. It saves compute cycles and disk I/O, and therefore it saves money. If your use case allows you to batch your inserts external to ClickHouse, then that is one option. If you would like ClickHouse to create the batches, then you can use the asynchronous INSERT mode described here.
1414

docs/cloud/bestpractices/partitioningkey.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import Image from '@theme/IdealImage';
99
import partitioning01 from '@site/static/images/cloud/bestpractices/partitioning-01.png';
1010
import partitioning02 from '@site/static/images/cloud/bestpractices/partitioning-02.png';
1111

12+
# Choose a Low Cardinality Partitioning Key
13+
1214
When you send an insert statement (that should contain many rows - see [section above](/optimize/bulk-inserts)) to a table in ClickHouse Cloud, and that
1315
table is not using a [partitioning key](/engines/table-engines/mergetree-family/custom-partitioning-key.md) then all row data from that insert is written into a new part on storage:
1416

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

Lines changed: 13 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ title: 'ClickHouse Cloud Quick Start'
88
description: 'Quick start guide for ClickHouse Cloud'
99
---
1010

11+
import Image from '@theme/IdealImage';
1112
import signup_page from '@site/static/images/_snippets/signup_page.png';
1213
import select_plan from '@site/static/images/_snippets/select_plan.png';
1314
import createservice1 from '@site/static/images/_snippets/createservice1.png';
@@ -35,16 +36,12 @@ To create a free ClickHouse service in [ClickHouse Cloud](https://console.clickh
3536
- 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
3637
- Login using the username and password you just created
3738

38-
<div class="eighty-percent">
39-
<img src={signup_page} class="image" alt="Select Plan" />
40-
</div>
39+
<Image img={signup_page} size="md" alt='Select Plan' border/>
4140
<br/>
4241

4342
Once you are logged in, ClickHouse Cloud starts the onboarding wizard which walks you through creating a new ClickHouse service. You will initially be requested to [select a plan](/cloud/manage/cloud-tiers):
4443

45-
<div class="eighty-percent">
46-
<img src={select_plan} class="image" alt="Select Plan" />
47-
</div>
44+
<Image img={select_plan} size="md" alt='Select Plan' border/>
4845
<br/>
4946

5047
:::tip
@@ -58,18 +55,14 @@ In the step below, we assume that the user has opted for the recommended Scale t
5855

5956
Select your desired region for deploying the service, and give your new service a name:
6057

61-
<div class="eighty-percent">
62-
<img src={createservice1} class="image" alt="New ClickHouse Service" />
63-
</div>
58+
<Image img={createservice1} size="md" alt='New ClickHouse Service' border/>
6459
<br/>
6560

6661
By default, the scale tier will create 3 replicas each with 4 VCPUs and 16 GiB RAM. [Vertical autoscaling](/manage/scaling#vertical-auto-scaling) will be enabled by default in the Scale tier.
6762

6863
Users can customize the service resources if required, specifying a minimum and maximum size for replicas to scale between. When ready, select `Create service`.
6964

70-
<div class="eighty-percent">
71-
<img src={scaling_limits} class="image" alt="Scaling Limits" />
72-
</div>
65+
<Image img={scaling_limits} size="md" alt='Scaling Limits' border/>
7366
<br/>
7467

7568
Congratulations! Your ClickHouse Cloud service is up and running and onboarding is complete. Keep reading for details on how to start ingesting and querying your data.
@@ -83,9 +76,7 @@ There are 2 ways to connect to ClickHouse:
8376

8477
For getting started quickly, ClickHouse provides a web-based SQL console to which you will be redirected on completing onboarding.
8578

86-
<div class="eighty-percent">
87-
<img src={createservice8} class="image" alt="SQL Console" />
88-
</div>
79+
<Image img={createservice8} size="md" alt='SQL Console' border/>
8980
<br/>
9081

9182

@@ -98,9 +89,7 @@ SHOW databases
9889

9990
You should see 4 databases in the list, plus any that you may have added.
10091

101-
<div class="eighty-percent">
102-
<img src={show_databases} class="image" alt="SQL Console" />
103-
</div>
92+
<Image img={show_databases} size="md" alt='SQL Console' border/>
10493
<br/>
10594

10695

@@ -110,20 +99,16 @@ That's it - you are ready to start using your new ClickHouse service!
11099

111100
Press the connect button from the navigation menu. A modal will open offering the credentials to your service and offering you a set of instructions on how to connect with your interface or language clients.
112101

113-
<div class="eighty-percent">
114-
<img src={service_connect} class="image" alt="Service Connect" />
115-
</div>
102+
<Image img={service_connect} size="md" alt='Service Connect' border/>
116103
<br/>
117104

118-
If you cant see your language client, you may want to check our list of [Integrations](/integrations).
105+
If you can't see your language client, you may want to check our list of [Integrations](/integrations).
119106

120107
## 3. Add data {#3-add-data}
121108

122109
ClickHouse is better with data! There are multiple ways to add data and most of them are available on the Data Sources page, which can be accessed in the navigation menu.
123110

124-
<div class="eighty-percent">
125-
<img src={data_sources} class="image" alt="Data sources" />
126-
</div>
111+
<Image img={data_sources} size="md" alt='Data sources' border/>
127112
<br/>
128113

129114
You can upload data using the following methods:
@@ -137,9 +122,7 @@ You can upload data using the following methods:
137122

138123
[ClickPipes](http://clickhouse.com/docs/integrations/clickpipes) is a managed integration platform that makes ingesting data from a diverse set of sources as simple as clicking a few buttons. Designed for the most demanding workloads, ClickPipes's robust and scalable architecture ensures consistent performance and reliability. ClickPipes can be used for long-term streaming needs or one-time data loading job.
139124

140-
<div class="eighty-percent">
141-
<img src={select_data_source} class="image" alt="Select data source" />
142-
</div>
125+
<Image img={select_data_source} size="md" alt='Select data source' border/>
143126
<br/>
144127

145128
### Add data using the SQL Console {#add-data-using-the-sql-console}
@@ -202,7 +185,6 @@ For a deep dive into core ClickHouse concepts, see ["Core Concepts"](../../manag
202185

203186
#### Insert data into your table {#insert-data-into-your-table}
204187

205-
206188
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`](/engines/table-engines/mergetree-family/mergetree.md) table causes a **part** to be created in storage.
207189

208190
:::tip ClickHouse best practice
@@ -236,9 +218,7 @@ SELECT * FROM helloworld.my_first_table
236218

237219
You can also connect to your ClickHouse Cloud service using a command-line tool named [**clickhouse client**](/interfaces/cli). Click `Connect` on the left menu to access these details. From the dialog select `Native` from the drop-down:
238220

239-
<div class="eighty-percent">
240-
<img src={client_details} class="image" alt="clickhouse client connection details" />
241-
</div>
221+
<Image img={client_details} size="md" alt='clickhouse client connection details' border/>
242222
<br/>
243223

244224
1. Install [ClickHouse](/interfaces/cli).
@@ -339,9 +319,7 @@ Suppose we have the following text in a CSV file named `data.csv`:
339319

340320
<br/>
341321

342-
<div class="eighty-percent">
343-
<img src={new_rows_from_csv} class="image" alt="New rows from CSV file" />
344-
</div>
322+
<Image img={new_rows_from_csv} size="md" alt='New rows from CSV file' />
345323
<br/>
346324

347325
## What's Next? {#whats-next}

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ keywords: ['api', 'query api endpoints', 'query endpoints', 'query rest api']
66
title: 'Query API Endpoints'
77
---
88

9+
import Image from '@theme/IdealImage';
910
import endpoints_testquery from '@site/static/images/cloud/sqlconsole/endpoints-testquery.png';
1011
import endpoints_savequery from '@site/static/images/cloud/sqlconsole/endpoints-savequery.png';
1112
import endpoints_configure from '@site/static/images/cloud/sqlconsole/endpoints-configure.png';
@@ -46,23 +47,23 @@ limit 10
4647

4748
Note that this query contains a parameter (`year`). The SQL console query editor automatically detects ClickHouse query parameter expressions and provides an input for each parameter. Let's quickly run this query to make sure that it works:
4849

49-
<img src={endpoints_testquery} alt="Test the example query"/>
50+
<Image img={endpoints_testquery} size="md" alt="Test the example query" />
5051

5152
Next step, we'll go ahead and save the query:
5253

53-
<img src={endpoints_savequery} alt="Save example query"/>
54+
<Image img={endpoints_savequery} size="md" alt="Save example query" />
5455

5556
More documentation around saved queries can be found [here](/cloud/get-started/sql-console#saving-a-query).
5657

5758
### Configuring the Query API Endpoint {#configuring-the-query-api-endpoint}
5859

5960
Query API endpoints can be configured directly from query view by clicking the **Share** button and selecting `API Endpoint`. You'll be prompted to specify which API key(s) should be able to access the endpoint:
6061

61-
<img src={endpoints_configure} alt="Configure query endpoint"/>
62+
<Image img={endpoints_configure} size="md" alt="Configure query endpoint" />
6263

6364
After selecting an API key, the query API endpoint will automatically be provisioned. An example `curl` command will be displayed so you can send a test request:
6465

65-
<img src={endpoints_completed} alt="Endpoint curl command"/>
66+
<Image img={endpoints_completed} size="md" alt="Endpoint curl command" />
6667

6768
### Query API parameters {#query-api-parameters}
6869

@@ -72,13 +73,11 @@ Query parameters in a query can be specified with the syntax `{parameter_name: t
7273

7374
Once a Query API endpoint is created, you can test that it works by using `curl` or any other HTTP client:
7475

75-
76-
<img src={endpoints_curltest} class="image" alt="endpoint curl test" style={{width: '80%', background:'none'}} />
76+
<Image img={endpoints_curltest} size="md" alt="endpoint curl test" />
7777

7878
After you've sent your first request, a new button should appear immediately to the right of the **Share** button. Clicking it will open a flyout containing monitoring data about the query:
7979

80-
<img src={endpoints_monitoring} alt="Endpoint monitoring"/>
81-
80+
<Image img={endpoints_monitoring} size="md" alt="Endpoint monitoring" />
8281

8382
## Implementation Details {#implementation-details}
8483

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ keywords: ['query insights', 'query log', 'query log ui', 'system.query_log insi
66
title: 'Query Insights'
77
---
88

9+
import Image from '@theme/IdealImage';
910
import insights_overview from '@site/static/images/cloud/sqlconsole/insights_overview.png';
1011
import insights_latency from '@site/static/images/cloud/sqlconsole/insights_latency.png';
1112
import insights_recent from '@site/static/images/cloud/sqlconsole/insights_recent.png';
@@ -20,34 +21,31 @@ The **Query Insights** feature makes ClickHouse's built-in query log easier to u
2021

2122
After selecting a service, the **Monitoring** navigation item in the left sidebar should expand to reveal a new **Query insights** sub-item. Clicking on this option opens the new Query insights page:
2223

23-
<img src={insights_overview} alt="Query Insights UI Overview"/>
24+
<Image img={insights_overview} size="md" alt="Query Insights UI Overview" border/>
2425

2526
## Top-level metrics {#top-level-metrics}
2627

27-
The stat boxes at the top represent some basic top-level query metrics over the selected period of time. Beneath it, weve exposed three time-series charts representing query volume, latency, and error rate broken down by query kind (select, insert, other) over a selected time window. The latency chart can be further adjusted to display p50, p90, and p99 latencies:
28+
The stat boxes at the top represent some basic top-level query metrics over the selected period of time. Beneath it, we've exposed three time-series charts representing query volume, latency, and error rate broken down by query kind (select, insert, other) over a selected time window. The latency chart can be further adjusted to display p50, p90, and p99 latencies:
2829

29-
<img src={insights_latency} alt="Query Insights UI Latency Chart"/>
30+
<Image img={insights_latency} size="md" alt="Query Insights UI Latency Chart" border/>
3031

3132
## Recent queries {#recent-queries}
3233

3334
Beneath the top-level metrics, a table displays query log entries (grouped by normalized query hash and user) over the selected time window:
3435

35-
<img src={insights_recent} alt="Query Insights UI Recent Queries Table"/>
36+
<Image img={insights_recent} size="md" alt="Query Insights UI Recent Queries Table" border/>
3637

3738
Recent queries can be filtered and sorted by any available field. The table can also be configured to display or hide additional fields such as tables, p90, and p99 latencies.
3839

3940
## Query drill-down {#query-drill-down}
4041

4142
Selecting a query from the recent queries table will open a flyout containing metrics and information specific to the selected query:
4243

43-
<img src={insights_drilldown} alt="Query Insights UI Query Drill down"/>
44+
<Image img={insights_drilldown} size="md" alt="Query Insights UI Query Drill down" border/>
4445

4546
As we can see from the flyout, this particular query has been run more than 3000 times in the last 24 hours. All metrics in the **Query info** tab are aggregated metrics, but we can also view metrics from individual runs by selecting the **Query history** tab:
4647

47-
<img src={insights_query_info}
48-
class="image"
49-
alt="Query Insights UI Query Information"
50-
style={{width: '400px'}} />
48+
<Image img={insights_query_info} size="sm" alt="Query Insights UI Query Information" border/>
5149

5250
<br />
5351

0 commit comments

Comments
 (0)