Skip to content

Commit a0395ee

Browse files
authored
cloud: add doc changes for v6.5 (#12041) (#12139)
1 parent e172615 commit a0395ee

14 files changed

+132
-92
lines changed

TOC-tidb-cloud.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
- [Follower Read](/develop/dev-guide-use-follower-read.md)
4848
- [Stale Read](/develop/dev-guide-use-stale-read.md)
4949
- [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md)
50+
- [FastScan](/develop/dev-guide-use-fastscan.md)
5051
- Transaction
5152
- [Overview](/develop/dev-guide-transaction-overview.md)
5253
- [Optimistic and Pessimistic Transactions](/develop/dev-guide-optimistic-and-pessimistic-transaction.md)
@@ -149,6 +150,7 @@
149150
- [Aggregation](/explain-aggregation.md)
150151
- [Views](/explain-views.md)
151152
- [Partitions](/explain-partitions.md)
153+
- [Index Merge](/explain-index-merge.md)
152154
- SQL Optimization Process
153155
- [Overview](/sql-optimization-concepts.md)
154156
- Logic Optimization
@@ -165,6 +167,7 @@
165167
- [Overview](/sql-physical-optimization.md)
166168
- [Index Selection](/choose-index.md)
167169
- [Statistics](/statistics.md)
170+
- [Extended Statistics](/extended-statistics.md)
168171
- [Wrong Index Solution](/wrong-index-solution.md)
169172
- [Distinct Optimization](/agg-distinct-optimization.md)
170173
- [Cost Model](/cost-model.md)
@@ -288,6 +291,8 @@
288291
- [`EXECUTE`](/sql-statements/sql-statement-execute.md)
289292
- [`EXPLAIN ANALYZE`](/sql-statements/sql-statement-explain-analyze.md)
290293
- [`EXPLAIN`](/sql-statements/sql-statement-explain.md)
294+
- [`FLASHBACK CLUSTER TO TIMESTAMP`](/sql-statements/sql-statement-flashback-to-timestamp.md)
295+
- [`FLASHBACK DATABASE`](/sql-statements/sql-statement-flashback-database.md)
291296
- [`FLASHBACK TABLE`](/sql-statements/sql-statement-flashback-table.md)
292297
- [`FLUSH PRIVILEGES`](/sql-statements/sql-statement-flush-privileges.md)
293298
- [`FLUSH STATUS`](/sql-statements/sql-statement-flush-status.md)
@@ -296,11 +301,13 @@
296301
- [`GRANT <role>`](/sql-statements/sql-statement-grant-role.md)
297302
- [`INSERT`](/sql-statements/sql-statement-insert.md)
298303
- [`KILL [TIDB]`](/sql-statements/sql-statement-kill.md)
304+
- [`LOCK STATS`](/sql-statements/sql-statement-lock-stats.md)
299305
- [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md)
300306
- [`PREPARE`](/sql-statements/sql-statement-prepare.md)
301307
- [`RECOVER TABLE`](/sql-statements/sql-statement-recover-table.md)
302308
- [`RENAME INDEX`](/sql-statements/sql-statement-rename-index.md)
303309
- [`RENAME TABLE`](/sql-statements/sql-statement-rename-table.md)
310+
- [`RENAME USER`](/sql-statements/sql-statement-rename-user.md)
304311
- [`REPLACE`](/sql-statements/sql-statement-replace.md)
305312
- [`REVOKE <privileges>`](/sql-statements/sql-statement-revoke-privileges.md)
306313
- [`REVOKE <role>`](/sql-statements/sql-statement-revoke-role.md)
@@ -319,6 +326,7 @@
319326
- [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md)
320327
- [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md)
321328
- [`SHOW [FULL] COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md)
329+
- [`SHOW CREATE DATABASE`](/sql-statements/sql-statement-show-create-database.md)
322330
- [`SHOW CREATE SEQUENCE`](/sql-statements/sql-statement-show-create-sequence.md)
323331
- [`SHOW CREATE TABLE`](/sql-statements/sql-statement-show-create-table.md)
324332
- [`SHOW CREATE USER`](/sql-statements/sql-statement-show-create-user.md)
@@ -340,6 +348,7 @@
340348
- [`SHOW SCHEMAS`](/sql-statements/sql-statement-show-schemas.md)
341349
- [`SHOW STATS_HEALTHY`](/sql-statements/sql-statement-show-stats-healthy.md)
342350
- [`SHOW STATS_HISTOGRAMS`](/sql-statements/sql-statement-show-histograms.md)
351+
- [`SHOW STATS_LOCKED`](/sql-statements/sql-statement-show-stats-locked.md)
343352
- [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md)
344353
- [`SHOW STATUS`](/sql-statements/sql-statement-show-status.md)
345354
- [`SHOW TABLE NEXT_ROW_ID`](/sql-statements/sql-statement-show-table-next-rowid.md)
@@ -354,6 +363,7 @@
354363
- [`TABLE`](/sql-statements/sql-statement-table.md)
355364
- [`TRACE`](/sql-statements/sql-statement-trace.md)
356365
- [`TRUNCATE`](/sql-statements/sql-statement-truncate.md)
366+
- [`UNLOCK STATS`](/sql-statements/sql-statement-unlock-stats.md)
357367
- [`UPDATE`](/sql-statements/sql-statement-update.md)
358368
- [`USE`](/sql-statements/sql-statement-use.md)
359369
- [`WITH`](/sql-statements/sql-statement-with.md)
@@ -408,6 +418,7 @@
408418
- [Usage Scenarios of Stale Read](/stale-read.md)
409419
- [Perform Stale Read Using `As OF TIMESTAMP`](/as-of-timestamp.md)
410420
- [Perform Stale Read Using `tidb_read_staleness`](/tidb-read-staleness.md)
421+
- [Perform Stale Read Using `tidb_external_ts`](/tidb-external-ts.md)
411422
- [Use the `tidb_snapshot` System Variable](/read-historical-data.md)
412423
- System Tables
413424
- [`mysql`](/mysql-schema.md)
@@ -427,6 +438,8 @@
427438
- [`DEADLOCKS`](/information-schema/information-schema-deadlocks.md)
428439
- [`ENGINES`](/information-schema/information-schema-engines.md)
429440
- [`KEY_COLUMN_USAGE`](/information-schema/information-schema-key-column-usage.md)
441+
- [`MEMORY_USAGE`](/information-schema/information-schema-memory-usage.md)
442+
- [`MEMORY_USAGE_OPS_HISTORY`](/information-schema/information-schema-memory-usage-ops-history.md)
430443
- [`PARTITIONS`](/information-schema/information-schema-partitions.md)
431444
- [`PROCESSLIST`](/information-schema/information-schema-processlist.md)
432445
- [`REFERENTIAL_CONSTRAINTS`](/information-schema/information-schema-referential-constraints.md)
@@ -446,9 +459,12 @@
446459
- [`TIKV_REGION_PEERS`](/information-schema/information-schema-tikv-region-peers.md)
447460
- [`TIKV_REGION_STATUS`](/information-schema/information-schema-tikv-region-status.md)
448461
- [`TIKV_STORE_STATUS`](/information-schema/information-schema-tikv-store-status.md)
462+
- [`USER_ATTRIBUTES`](/information-schema/information-schema-user-attributes.md)
449463
- [`USER_PRIVILEGES`](/information-schema/information-schema-user-privileges.md)
464+
- [`VARIABLES_INFO`](/information-schema/information-schema-variables-info.md)
450465
- [`VIEWS`](/information-schema/information-schema-views.md)
451466
- [Metadata Lock](/metadata-lock.md)
467+
- [Use UUIDs](/best-practices/uuid.md)
452468
- [System Variables](/system-variables.md)
453469
- Storage Engines
454470
- TiKV

best-practices/uuid.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,36 @@ The textual UUID format looks like this: `ab06f63e-8fe7-11ec-a514-5405db7aad56`,
2121

2222
### UUID format binary order and a clustered PK
2323

24-
The `UUID_TO_BIN()` function can be used with one argument, the UUID or with two arguments where the second argument is a `swap_flag`. It is recommended to not set the `swap_flag` with TiDB to avoid [hotspots](/best-practices/high-concurrency-best-practices.md).
24+
The `UUID_TO_BIN()` function can be used with one argument, the UUID or with two arguments where the second argument is a `swap_flag`.
25+
26+
<CustomContent platform="tidb">
27+
28+
It is recommended to not set the `swap_flag` with TiDB to avoid [hotspots](/best-practices/high-concurrency-best-practices.md).
29+
30+
</CustomContent>
31+
32+
<CustomContent platform="tidb-cloud">
33+
34+
It is recommended to not set the `swap_flag` with TiDB to avoid hotspots.
35+
36+
</CustomContent>
2537

2638
You can also explicitly set the [`CLUSTERED` option](/clustered-indexes.md) for UUID based primary keys to avoid hotspots.
2739

2840
To demonstrate the effect of the `swap_flag`, here are two tables with an identical structure. The difference is that the data inserted into `uuid_demo_1` uses `UUID_TO_BIN(?, 0)` and `uuid_demo_2` uses `UUID_TO_BIN(?, 1)`.
2941

42+
<CustomContent platform="tidb">
43+
3044
In the screenshot of the [Key Visualizer](/dashboard/dashboard-key-visualizer.md) below, you can see that writes are concentrated in a single region of the `uuid_demo_2` table that has the order of the fields swapped in the binary format.
3145

46+
</CustomContent>
47+
48+
<CustomContent platform="tidb-cloud">
49+
50+
In the screenshot of the [Key Visualizer](/tidb-cloud/tune-performance.md#key-visualizer) below, you can see that writes are concentrated in a single region of the `uuid_demo_2` table that has the order of the fields swapped in the binary format.
51+
52+
</CustomContent>
53+
3254
![Key Visualizer](/media/best-practices/uuid_keyviz.png)
3355

3456
```sql

develop/dev-guide-choose-driver-or-orm.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,3 +247,9 @@ go get -u gorm.io/driver/mysql
247247
```
248248

249249
For an example of using GORM to build a TiDB application, see [Build a Simple CRUD App with TiDB and Golang](/develop/dev-guide-sample-application-golang.md).
250+
251+
<CustomContent platform="tidb-cloud">
252+
253+
After you have determined the driver or ORM, you can [connect to your TiDB cluster](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster).
254+
255+
</CustomContent>

explain-subqueries.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -267,9 +267,4 @@ Currently, TiDB can only be null-aware of anti semi join and anti left outer sem
267267
+ [Explain Statements That Use Aggregation](/explain-aggregation.md)
268268
+ [Explain Statements Using Views](/explain-views.md)
269269
+ [Explain Statements Using Partitions](/explain-partitions.md)
270-
271-
<CustomContent platform="tidb">
272-
273-
+ [Explain Statements Using Index Merge](/explain-index-merge.md)
274-
275-
</CustomContent>
270+
+ [Explain Statements Using Index Merge](/explain-index-merge.md)

0 commit comments

Comments
 (0)