diff --git a/TOC-tidb-cloud-starter.md b/TOC-tidb-cloud-starter.md index 0bb12b21b6b65..d6f8f748a6189 100644 --- a/TOC-tidb-cloud-starter.md +++ b/TOC-tidb-cloud-starter.md @@ -135,15 +135,11 @@ - [排查从 Amazon S3 导入数据期间的访问被拒绝错误](/tidb-cloud/troubleshoot-import-access-denied-error.md) - [将 AWS DMS 连接到 TiDB Cloud](/tidb-cloud/tidb-cloud-connect-aws-dms.md) - 探索数据 - - [SQL 编辑器中的 Chat2Query](/tidb-cloud/explore-data-with-chat2query.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png) + - [SQL 编辑器](/tidb-cloud/explore-data-with-sql-editor.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png) - [SQL 代理账户](/tidb-cloud/sql-proxy-account.md) - 数据服务 ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png) - [概述](/tidb-cloud/data-service-overview.md) - [快速上手](/tidb-cloud/data-service-get-started.md) - - Chat2Query API - - [快速上手](/tidb-cloud/use-chat2query-api.md) - - [启动多轮 Chat2Query](/tidb-cloud/use-chat2query-sessions.md) - - [使用知识库](/tidb-cloud/use-chat2query-knowledge.md) - [管理数据应用](/tidb-cloud/data-service-manage-data-app.md) - [管理端点](/tidb-cloud/data-service-manage-endpoint.md) - [API 密钥](/tidb-cloud/data-service-api-key.md) diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index 09e85d5fc6971..5d2cb782ec8d9 100644 --- a/TOC-tidb-cloud.md +++ b/TOC-tidb-cloud.md @@ -171,15 +171,11 @@ - [数据迁移的预检查错误、迁移错误和警报](/tidb-cloud/tidb-cloud-dm-precheck-and-troubleshooting.md) - [将 AWS DMS 连接到 TiDB Cloud](/tidb-cloud/tidb-cloud-connect-aws-dms.md) - 探索数据 - - [SQL 编辑器中的 Chat2Query](/tidb-cloud/explore-data-with-chat2query.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png) + - [SQL 编辑器](/tidb-cloud/explore-data-with-sql-editor.md) ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png) - [SQL 代理账户](/tidb-cloud/sql-proxy-account.md) - 数据服务 ![PREVIEW](/media/tidb-cloud/blank_transparent_placeholder.png) - [概述](/tidb-cloud/data-service-overview.md) - [快速上手](/tidb-cloud/data-service-get-started.md) - - Chat2Query API - - [快速上手](/tidb-cloud/use-chat2query-api.md) - - [启动多轮 Chat2Query](/tidb-cloud/use-chat2query-sessions.md) - - [使用知识库](/tidb-cloud/use-chat2query-knowledge.md) - [管理数据应用](/tidb-cloud/data-service-manage-data-app.md) - [管理端点](/tidb-cloud/data-service-manage-endpoint.md) - [API 密钥](/tidb-cloud/data-service-api-key.md) diff --git a/latest_translation_commit.json b/latest_translation_commit.json index 14b968b070a81..b916cbf17435b 100644 --- a/latest_translation_commit.json +++ b/latest_translation_commit.json @@ -1,4 +1,4 @@ { "target": "release-8.5", - "sha": "212f51701c89f5ffe0a030e70a5ff32466af7646" + "sha": "d96fa6c87cc4d3710639c4245fb7528584dffffa" } diff --git a/sql-statements/sql-statement-add-index.md b/sql-statements/sql-statement-add-index.md index f47231480b0c0..64b9508746d71 100644 --- a/sql-statements/sql-statement-add-index.md +++ b/sql-statements/sql-statement-add-index.md @@ -52,6 +52,7 @@ IndexOption | 'INVISIBLE' | 'GLOBAL' | 'LOCAL' + | 'WHERE' Expression IndexType ::= 'BTREE' @@ -92,6 +93,129 @@ mysql> EXPLAIN SELECT * FROM t1 WHERE c1 = 3; 2 rows in set (0.00 sec) ``` +## 部分索引 + +> **注意：** +> +> TiDB Self-Managed 和 TiDB Cloud Dedicated 从 v8.5.7 开始支持部分索引，TiDB Cloud Essential 和 Premium 从 CLOUD.202603.1 开始支持部分索引。 + +部分索引是建立在表中部分行上的索引。添加部分索引时，你可以指定一个条件表达式（也称为谓词）来定义这部分行。索引仅包含满足该谓词的行的条目。 + +### 使用场景 + +在以下场景中，使用部分索引有助于提升查询性能或减少索引维护开销： + +- **选择性过滤**：当你经常基于特定条件查询一小部分行时，可以使用部分索引。对于满足部分索引谓词的查询，TiDB 可以使用部分索引来避免扫描无关行，并减少索引占用的存储空间。 +- **条件唯一性**：当你只需要对满足特定条件的行强制执行唯一性约束时，可以使用唯一部分索引，以避免将唯一性约束应用到整张表。 +- **降低 DML 开销**：当大量 `INSERT`、`UPDATE` 或 `DELETE` 操作影响到不需要建立索引的行时，可以使用部分索引。与维护完整索引相比，维护部分索引可以减少索引维护开销。 + +### 添加部分索引 + +你可以通过在索引定义后追加 `WHERE` 子句来添加部分索引。例如： + +```sql +CREATE TABLE t1 (c1 INT, c2 INT, c3 TEXT); +ALTER TABLE t1 ADD INDEX idx1 (c1) WHERE c2 > 10; +``` + +你还可以添加唯一部分索引： + +```sql +ALTER TABLE t1 ADD UNIQUE INDEX idx2 (c1, c2) WHERE c3 = 'abc'; +``` + +### 使用示例 + +以下示例演示了如何有效使用部分索引。 + +创建一个包含用户数据的表： + +```sql +CREATE TABLE users ( + id INT PRIMARY KEY AUTO_INCREMENT, + name VARCHAR(100), + status VARCHAR(20), + created_at DATETIME, + score INT +); +``` + +为常见查询模式添加部分索引： + +```sql +ALTER TABLE users ADD INDEX idx_active_users (name) WHERE status = 'active'; +ALTER TABLE users ADD INDEX idx_high_score_users (created_at) WHERE score > 1000; +ALTER TABLE users ADD INDEX idx_pending_status (status) WHERE status = 'pending'; +``` + +然后，以下查询可以使用部分索引： + +```sql +mysql> EXPLAIN SELECT * FROM users WHERE status = 'active' AND name = 'John'; ++-------------------------------+---------+-----------+-------------------------------------------+-------------------------------------------------------+ +| id | estRows | task | access object | operator info | ++-------------------------------+---------+-----------+-------------------------------------------+-------------------------------------------------------+ +| IndexLookUp_9 | 1.00 | root | | | +| ├─IndexRangeScan_6(Build) | 10.00 | cop[tikv] | table:users, index:idx_active_users(name) | range:["John","John"], keep order:false, stats:pseudo | +| └─Selection_8(Probe) | 1.00 | cop[tikv] | | eq(test.users.status, "active") | +| └─TableRowIDScan_7 | 10.00 | cop[tikv] | table:users | keep order:false, stats:pseudo | ++-------------------------------+---------+-----------+-------------------------------------------+-------------------------------------------------------+ +4 rows in set (0.00 sec) + +mysql> EXPLAIN SELECT * FROM users WHERE status = 'active' ORDER BY name; ++-------------------------------+----------+-----------+-------------------------------------------+---------------------------------+ +| id | estRows | task | access object | operator info | ++-------------------------------+----------+-----------+-------------------------------------------+---------------------------------+ +| IndexLookUp_18 | 10.00 | root | | | +| ├─IndexFullScan_15(Build) | 10000.00 | cop[tikv] | table:users, index:idx_active_users(name) | keep order:true, stats:pseudo | +| └─Selection_17(Probe) | 10.00 | cop[tikv] | | eq(test.users.status, "active") | +| └─TableRowIDScan_16 | 10000.00 | cop[tikv] | table:users | keep order:false, stats:pseudo | ++-------------------------------+----------+-----------+-------------------------------------------+---------------------------------+ +4 rows in set (0.00 sec) + +mysql> EXPLAIN SELECT * FROM users WHERE score > 10000 ORDER BY created_at; ++-------------------------------+----------+-----------+-----------------------------------------------------+--------------------------------+ +| id | estRows | task | access object | operator info | ++-------------------------------+----------+-----------+-----------------------------------------------------+--------------------------------+ +| IndexLookUp_18 | 3333.33 | root | | | +| ├─IndexFullScan_15(Build) | 10000.00 | cop[tikv] | table:users, index:idx_high_score_users(created_at) | keep order:true, stats:pseudo | +| └─Selection_17(Probe) | 3333.33 | cop[tikv] | | gt(test.users.score, 10000) | +| └─TableRowIDScan_16 | 10000.00 | cop[tikv] | table:users | keep order:false, stats:pseudo | ++-------------------------------+----------+-----------+-----------------------------------------------------+--------------------------------+ +4 rows in set (0.00 sec) + +mysql> EXPLAIN SELECT * FROM users WHERE status = 'pending'; ++-------------------------------+---------+-----------+-----------------------------------------------+-------------------------------------------------------------+ +| id | estRows | task | access object | operator info | ++-------------------------------+---------+-----------+-----------------------------------------------+-------------------------------------------------------------+ +| IndexLookUp_7 | 10.00 | root | | | +| ├─IndexRangeScan_5(Build) | 10.00 | cop[tikv] | table:users, index:idx_pending_status(status) | range:["pending","pending"], keep order:false, stats:pseudo | +| └─TableRowIDScan_6(Probe) | 10.00 | cop[tikv] | table:users | keep order:false, stats:pseudo | ++-------------------------------+---------+-----------+-----------------------------------------------+-------------------------------------------------------------+ +3 rows in set (0.00 sec) +``` + +如果查询的谓词不满足部分索引定义的条件，TiDB 不会选择该部分索引，即使使用了 hint 也是如此。例如，以下语句无法使用部分索引 `idx_high_score_users`，因为查询谓词 `score > 100` 不满足部分索引定义 `score > 1000`： + +```sql +mysql> EXPLAIN SELECT * FROM users USE INDEX(idx_high_score_users) WHERE score > 100 ORDER BY created_at; ++---------------------------+----------+-----------+---------------+--------------------------------+ +| id | estRows | task | access object | operator info | ++---------------------------+----------+-----------+---------------+--------------------------------+ +| Sort_5 | 3333.33 | root | | test.users.created_at | +| └─TableReader_10 | 3333.33 | root | | data:Selection_9 | +| └─Selection_9 | 3333.33 | cop[tikv] | | gt(test.users.score, 100) | +| └─TableFullScan_8 | 10000.00 | cop[tikv] | table:users | keep order:false, stats:pseudo | ++---------------------------+----------+-----------+---------------+--------------------------------+ +``` + +### 限制 + +- 部分索引中的 `WHERE` 子句支持基本比较运算符（`=`、`!=`、`<`、`<=`、`>`、`>=`）、`IS NULL`、`IS NOT NULL` 以及带常量值的 `IN` 谓词。 +- 谓词中的列和常量值必须具有相同的数据类型。 +- 谓词只能引用同一张表中的列。 +- 不能在表达式索引上创建部分索引。 + ## MySQL 兼容性 * TiDB 在语法上接受 `HASH`、`BTREE` 和 `RTREE` 等索引类型以兼容 MySQL，但会忽略这些类型。 diff --git a/sql-statements/sql-statement-create-index.md b/sql-statements/sql-statement-create-index.md index 9955f874c92ee..cdd7b7629f563 100644 --- a/sql-statements/sql-statement-create-index.md +++ b/sql-statements/sql-statement-create-index.md @@ -368,7 +368,9 @@ Query OK, 1 row affected (0.00 sec) ## 部分索引 {#partial-indexes} -TiDB Self-Managed 和 TiDB Cloud Dedicated 从 v8.5.7 版本开始引入，TiDB Cloud Essential 和 Premium 从 CLOUD.202603.1 开始引入 +> **注意：** +> +> TiDB Self-Managed 和 TiDB Cloud Dedicated 从 v8.5.7 开始支持部分索引，TiDB Cloud Essential 和 Premium 从 CLOUD.202603.1 开始支持部分索引。 部分索引是建立在表中部分行子集上的索引。创建部分索引时，你可以指定一个条件表达式，也称为谓词，用于定义这个行子集。索引中仅包含满足该谓词的行的条目。 diff --git a/system-variables.md b/system-variables.md index 7baf011d09478..7bb67a0f38712 100644 --- a/system-variables.md +++ b/system-variables.md @@ -6270,6 +6270,26 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) + + +### tidb_stmt_summary_group_by_user 在 CLOUD.202603.1 中引入 {#tidb_stmt_summary_group_by_user} + +> **Note:** +> +> - 对于 TiDB Cloud Starter，此变量不受支持。 +> - 对于 TiDB Cloud Essential 和 Premium，此变量为只读。 + +- Scope: GLOBAL +- Persists to cluster: Yes +- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制： No +- Type: Boolean +- Default value: TiDB Cloud Essential 和 TiDB Cloud Premium 为 `ON` +- 此变量控制是否将执行 SQL 语句的用户作为 [statement summary tables](/statement-summary-tables.md) 中的聚合维度之一。当此变量设置为 `OFF` 时，TiDB 会将不同用户执行的相同 SQL digest 聚合到同一行中，`SAMPLE_USER` 字段显示一个采样用户。当此变量设置为 `ON` 时，TiDB 会将不同用户执行的相同 SQL digest 分别聚合到不同的行中，每一行的 `SAMPLE_USER` 字段表示执行该语句的用户。 +- 修改此变量会清除当前内存中的 statement summary 数据，因为修改前后的数据使用了不同的维度进行聚合。这不会影响持久化到磁盘的历史数据。 +- 启用此变量后，statement summary 记录数可能会随着同一 SQL digest 的不同执行用户数量增加而增加，从而增加内存使用量。 + + + ### tidb_stmt_summary_history_size 从 v4.0 版本开始引入 > **注意：** @@ -6345,6 +6365,26 @@ Query OK, 0 rows affected, 1 warning (0.00 sec) + + +### tidb_stmt_summary_persist_evicted 在 CLOUD.202603.1 中引入 {#tidb_stmt_summary_persist_evicted} + +> **Note:** +> +> - 对于 TiDB Cloud Starter，此变量不受支持。 +> - 对于 TiDB Cloud Essential 和 Premium，此变量为只读。 + +- Scope: GLOBAL +- Persists to cluster: Yes +- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制： No +- Type: Boolean +- Default value: `OFF` +- 此变量控制在启用[语句摘要持久化](/statement-summary-tables.md#persist-statements-summary)后，是否将被 LRU 淘汰的 statement summary 记录写入 statement summary 日志。TiDB 会将这些 JSON 记录标记为 `"evicted": true`，以便下游日志消费者识别它们。 +- 此变量仅在启用 [tidb_stmt_summary_enable_persistent](/system-variables.md#tidb_stmt_summary_enable_persistent-new-in-v660) 时生效。TiDB 不会将标记为 `"evicted": true` 的记录作为 `statements_summary_history` 或 `cluster_statements_summary_history` 的查询结果返回。 +- 启用此变量后，随着 LRU 淘汰变得更频繁，日志量会增加。TiDB 使用异步缓冲机制写入被淘汰的记录。当缓冲队列已满时，TiDB 可能会丢弃新的被淘汰记录。 + + + ### tidb_stmt_summary_refresh_interval 从 v4.0 版本开始引入 > **注意：** diff --git a/tidb-cloud-lake/guides/data-lineage.md b/tidb-cloud-lake/guides/data-lineage.md index 6c5107e3b200b..9c8ea05610b7b 100644 --- a/tidb-cloud-lake/guides/data-lineage.md +++ b/tidb-cloud-lake/guides/data-lineage.md @@ -105,6 +105,16 @@ REFRESH LINEAGE FOR ALL VIEWS; 刷新操作会为 `default` catalog 中的所有视图校正血缘信息。它只会报告需要变更或无法处理的视图；未发生变化的视图不会显示。该命令需要全局 `SUPER` 权限。有关输出详情，请参见 [`REFRESH LINEAGE`](/tidb-cloud-lake/sql/refresh-lineage.md)。 +## 导出到 OpenMetadata {#export-to-openmetadata} + +要在 [OpenMetadata](https://open-metadata.org) 中查看 {{{ .lake }}} 血缘，请使用 [lake-openmetadata-ingestion](https://github.com/tidbcloud/lake-openmetadata-ingestion)。该工具通过 REST API 将 {{{ .lake }}} 中的元信息（数据库、表、视图和列）和血缘（表级别和列级别）推送到 OpenMetadata。有关安装、配置和使用方法，请参阅该项目的 [README](https://github.com/tidbcloud/lake-openmetadata-ingestion)。 + +> **注意：** +> +> - 该工具当前仅支持元信息和血缘导入。 +> - 对于初始同步，请先运行 `lake-om -c config.yaml metadata` 直至完成，然后运行 `lake-om -c config.yaml lineage --full`。如果某条血缘边的任一端点在 OpenMetadata 中尚不存在，则会跳过该血缘边。 +> - 对于持续同步，请调度 cron 或 Airflow 工作流，先运行 `lake-om -c config.yaml metadata` 直至完成，再运行 `lake-om -c config.yaml lineage`。长时间中断后，请运行 `lake-om -c config.yaml lineage --full`。 + ## 限制 {#limitations} - `GET_LINEAGE` 最多只能遍历五跳。 diff --git a/tidb-cloud/ai-feature-concepts.md b/tidb-cloud/ai-feature-concepts.md index 14c8765f2a2e6..603a3f3c73d5e 100644 --- a/tidb-cloud/ai-feature-concepts.md +++ b/tidb-cloud/ai-feature-concepts.md @@ -5,16 +5,10 @@ summary: 了解 TiDB Cloud 的 AI 功能。 # AI 功能 -TiDB Cloud 的 AI 功能使你能够充分利用先进技术进行数据探索、搜索和集成。从基于自然语言驱动的 SQL 查询生成，到高性能向量搜索，TiDB 将数据库能力与现代 AI 功能相结合，为创新应用提供动力。TiDB 支持主流 AI 框架、embedding 模型，并可与 ORM 库无缝集成，为语义搜索和 AI 驱动分析等场景提供了多样化的平台。 +TiDB Cloud 的 AI 功能使你能够充分利用先进技术进行数据探索、搜索和集成。TiDB 将数据库能力与现代 AI 功能相结合，为创新应用提供动力。TiDB 支持主流 AI 框架、嵌入模型，并可与 ORM 库无缝集成，为语义搜索和 AI 驱动分析等场景提供了多样化的平台。 本文档将重点介绍这些 AI 功能及其如何提升 TiDB 体验。 -## Chat2Query（PREVIEW） {#chat2query-preview} - -Chat2Query 是集成在 SQL Editor 中的 AI 驱动功能，能够帮助用户通过自然语言指令生成、调试或重写 SQL 查询。更多信息，参见 [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)。 - -此外，TiDB Cloud 为 TiDB Cloud Starter 实例提供了 Chat2Query API。启用后，TiDB Cloud 会自动创建一个名为 Chat2Query 的系统 Data App，以及一个 Data Service 中的 Chat2Data endpoint。你可以调用该 endpoint，通过提供指令让 AI 生成并执行 SQL 语句。更多信息，参见 [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md)。 - ## 向量搜索（PREVIEW） {#vector-search-preview} 向量搜索是一种以数据语义为优先级的搜索方法，能够返回更相关的结果。 diff --git a/tidb-cloud/architecture-concepts.md b/tidb-cloud/architecture-concepts.md index 31c59551af379..1dd5e302f0d1d 100644 --- a/tidb-cloud/architecture-concepts.md +++ b/tidb-cloud/architecture-concepts.md @@ -134,6 +134,12 @@ TiDB Cloud Lake 在一个平台中支持 ANSI SQL、半结构化数据处理、 更多详情，请参见 [TiDB Cloud Lake Overview](https://docs.pingcap.com/tidbcloudlake/lake-overview/)。 +## TiDB Cloud Filesystem {#tidb-cloud-filesystem} + +TiDB Cloud Filesystem 提供持久、共享的文件存储，独立于访问它的机器和进程。你可以使用 `ti fs` 命令访问文件，或将文件系统挂载为本地目录，而无需预配或管理 TiDB 数据库。 + +更多详细信息，请参见 [TiDB Cloud Filesystem](https://docs.pingcap.com/tidbcloud-filesystem/filesystem-intro/)。 + ## TiDB Cloud 控制台 [TiDB Cloud 控制台](https://tidbcloud.com/) 是 TiDB Cloud 资源的基于 Web 的管理界面。你可以通过该平台管理 TiDB Cloud 资源、导入或迁移数据、监控性能指标、配置备份、设置安全控制，并与其他云服务集成，所有操作均可在一个用户友好的平台上完成。 diff --git a/tidb-cloud/connect-to-tidb-cluster.md b/tidb-cloud/connect-to-tidb-cluster.md index e828179d106eb..da8d62d025016 100644 --- a/tidb-cloud/connect-to-tidb-cluster.md +++ b/tidb-cloud/connect-to-tidb-cluster.md @@ -36,15 +36,15 @@ summary: 了解如何通过不同方法连接到你的 TiDB Cloud Dedicated 集 如果你需要更低的延时和更高的安全性，可以设置 VPC Peering，并通过你云账户中相应云服务商的 VM 实例使用私有端点进行连接。更多信息请参阅 [Connect to TiDB Cloud Dedicated via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md)。 -- [内置 SQL 编辑器](/tidb-cloud/explore-data-with-chat2query.md) +- [内置 SQL 编辑器](/tidb-cloud/explore-data-with-sql-editor.md) > **注意：** > > 如需在 [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) 集群上使用 SQL 编辑器，请联系 [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md)。 - 如果你的集群托管在 AWS 且 TiDB 版本为 v6.5.0 或更高版本，你可以在 [TiDB Cloud 控制台](https://tidbcloud.com/)中使用 AI 辅助的 SQL 编辑器，最大化数据价值。 + 如果你的集群托管在 AWS 且 TiDB 版本为 v6.5.0 或更高版本，你可以在 [TiDB Cloud 控制台](https://tidbcloud.com/)中使用 SQL 编辑器，最大化数据价值。 - 在 SQL 编辑器中，你可以手动编写 SQL 查询语句，或直接在 macOS 上按 ⌘ + I（或在 Windows 或 Linux 上按 Control + I），让 [Chat2Query (PREVIEW)](/tidb-cloud/tidb-cloud-glossary.md#chat2query) 自动生成 SQL 查询语句。这样你无需本地 SQL 客户端即可对数据库执行 SQL 查询。你可以直观地以表格或图表形式查看查询结果，并轻松查看查询日志。 + 在 SQL 编辑器中，你可以编写并运行 SQL 查询。这样你无需本地 SQL 客户端即可对数据库执行 SQL 查询。你可以直观地以表格或图表形式查看查询结果，并轻松查看查询日志。 ## 后续操作 diff --git a/tidb-cloud/data-service-app-config-files.md b/tidb-cloud/data-service-app-config-files.md index 9ee4a344be4eb..b2d5116372fbd 100644 --- a/tidb-cloud/data-service-app-config-files.md +++ b/tidb-cloud/data-service-app-config-files.md @@ -201,7 +201,6 @@ SQL 文件的名称格式为 `-.sql`，其中 `` ```sql /* 入门： 在输入 SQL 语句之前，输入 "USE {database};"。 -输入 "--你的问题" + Enter 可以在 TiDB Cloud 控制台中尝试 AI 生成的 SQL 查询。 声明参数的格式为 "Where id = ${arg}"。 */ USE sample_data; diff --git a/tidb-cloud/data-service-get-started.md b/tidb-cloud/data-service-get-started.md index 98bd3f288a7ac..2a06abd1a6e65 100644 --- a/tidb-cloud/data-service-get-started.md +++ b/tidb-cloud/data-service-get-started.md @@ -61,10 +61,6 @@ Data Service（预览版）使你能够通过自定义 API 端点以 HTTPS 请 3. 在 **Create Data App** 对话框中，输入名称、描述，并选择你希望 Data App access 的 {{{ .starter }}} 实例。 - > **注意：** - > - > 默认情况下，Data App 类型为 **Standard Data App**。如果你想创建 **Chat2Query Data App**，请参考 [快速开始使用 Chat2Query API](/tidb-cloud/use-chat2query-api.md)，而不是本文档。 - 4. （可选）如需将 Data App 的端点自动 deploy 到你指定的 GitHub repository 和分支，请启用 **Connect to GitHub**，然后执行以下操作： 1. 点击 **Install on GitHub**，并按照页面指引将 **TiDB Cloud Data Service** 作为应用安装到目标 repository。 @@ -116,11 +112,7 @@ Data Service（预览版）使你能够通过自定义 API 端点以 HTTPS 请 在 query 或 update 数据前，需要先在 SQL statement 中指定数据库。例如：`USE database_name;`。 - 在 SQL editor 中，你可以编写表关联查询、复杂查询、aggregate function 等 statement。你也可以直接输入 `--` 加上你的指令，让 AI 自动生成 SQL statement。 - - > **注意：** - > - > 如需体验 TiDB Cloud 的 AI 能力，你需要允许 PingCAP 和 Amazon Bedrock 使用你的代码片段进行研究和服务改进。详细信息，参见 [启用或禁用 AI 生成 SQL 查询](/tidb-cloud/explore-data-with-chat2query.md#enable-or-disable-ai-to-generate-sql-queries)。 + 在 SQL editor 中，你可以编写表关联查询、复杂查询、aggregate function 等 statement。 如需定义 parameter，可以在 SQL statement 中以 `${ID}` 形式插入 variable 占位符。例如：`SELECT * FROM table_name WHERE id = ${ID}`。然后，你可以点击右侧面板的 **Params** 标签页，修改 parameter 定义和 test 值。 @@ -303,6 +295,5 @@ TiDB Cloud 会生成代码示例，帮助你调用端点。要获取代码示例 ## 了解更多 - [Data Service 概览](/tidb-cloud/data-service-overview.md) -- [快速开始使用 Chat2Query API](/tidb-cloud/use-chat2query-api.md) - [管理 Data App](/tidb-cloud/data-service-manage-data-app.md) - [管理端点](/tidb-cloud/data-service-manage-endpoint.md) diff --git a/tidb-cloud/data-service-manage-data-app.md b/tidb-cloud/data-service-manage-data-app.md index 4d8dc2379e5e1..213561744d59e 100644 --- a/tidb-cloud/data-service-manage-data-app.md +++ b/tidb-cloud/data-service-manage-data-app.md @@ -21,10 +21,6 @@ Data Service (PREVIEW) 中的 Data App 是一组用于访问特定应用程序 2. 输入名称、描述，并选择你希望 Data App 访问的集群。 - > **注意：** - > - > 默认情况下，Data App 类型为 **Standard Data App**。如果你想创建 **Chat2Query Data App**，请参考 [Chat2Query API 入门](/tidb-cloud/use-chat2query-api.md)，而不是本文档。 - 3. （可选）要将 Data App 的端点自动部署到你首选的 GitHub 仓库和分支，请启用 **Connect to GitHub**，然后执行以下操作： 1. 点击 **Install on GitHub**，然后按照屏幕上的说明将 **TiDB Cloud Data Service** 作为应用程序安装到你的目标仓库。 diff --git a/tidb-cloud/data-service-manage-endpoint.md b/tidb-cloud/data-service-manage-endpoint.md index 0a1be6dfef808..4088e6c06bb43 100644 --- a/tidb-cloud/data-service-manage-endpoint.md +++ b/tidb-cloud/data-service-manage-endpoint.md @@ -199,7 +199,7 @@ Data Service 提供了一个包含预定义系统 endpoint 的 endpoint 库， ### 编写 SQL 语句 -在 endpoint 详情页的 SQL editor 中，你可以为 endpoint 编写并运行 SQL 语句。你也可以直接输入 `--` 加指令，让 AI 自动生成 SQL 语句。 +在 endpoint 详情页的 SQL editor 中，你可以为 endpoint 编写并运行 SQL 语句。 1. 选择 {{{ .starter }}} 实例。 @@ -216,7 +216,7 @@ Data Service 提供了一个包含预定义系统 endpoint 的 endpoint 库， 3. 编写 SQL 语句。 - 在 SQL editor 中，你可以编写如表关联查询、复杂查询、aggregate function 等语句。你也可以直接输入 `--` 加指令，让 AI 自动生成 SQL 语句。 + 在 SQL editor 中，你可以编写如表关联查询、复杂查询、聚合函数等语句。 若要定义参数，可以在 SQL 语句中以变量占位符形式插入，如 `${ID}`。例如，`SELECT * FROM table_name WHERE id = ${ID}`。然后，你可以点击右侧面板的 **Params** 标签页，修改参数定义和测试值。更多信息，参见 [参数](#configure-parameters)。 diff --git a/tidb-cloud/data-service-oas-with-nextjs.md b/tidb-cloud/data-service-oas-with-nextjs.md index 6df8013670463..7ef09b31616f8 100644 --- a/tidb-cloud/data-service-oas-with-nextjs.md +++ b/tidb-cloud/data-service-oas-with-nextjs.md @@ -22,7 +22,7 @@ summary: 学习如何使用 Data App 的 OpenAPI 规范生成客户端代码并 首先，在你的 {{{ .starter }}} 实例或 {{{ .dedicated }}} 集群中创建表 `test.repository`，并插入一些示例数据。以下示例插入了由 PingCAP 开发的一些开源项目，作为演示数据。 -你可以在 [TiDB Cloud 控制台](https://tidbcloud.com)的 [SQL 编辑器](/tidb-cloud/explore-data-with-chat2query.md)中执行这些 SQL 语句。 +你可以在 [TiDB Cloud 控制台](https://tidbcloud.com)的 [SQL 编辑器](/tidb-cloud/explore-data-with-sql-editor.md)中执行这些 SQL 语句。 ```sql -- 选择数据库 diff --git a/tidb-cloud/data-service-overview.md b/tidb-cloud/data-service-overview.md index 54e3453bb930e..df1f495796415 100644 --- a/tidb-cloud/data-service-overview.md +++ b/tidb-cloud/data-service-overview.md @@ -35,6 +35,5 @@ Data Service 允许你将 TiDB Cloud 无缝集成到任何兼容 HTTPS 的应用 ## 后续步骤 - [Get Started with Data Service](/tidb-cloud/data-service-get-started.md) -- [Get Started with Chat2Query API](/tidb-cloud/use-chat2query-api.md) - [Manage a Data App](/tidb-cloud/data-service-manage-data-app.md) - [Manage an Endpoint](/tidb-cloud/data-service-manage-endpoint.md) diff --git a/tidb-cloud/data-service-postman-integration.md b/tidb-cloud/data-service-postman-integration.md index df0a5be79c615..248bd8f7b1048 100644 --- a/tidb-cloud/data-service-postman-integration.md +++ b/tidb-cloud/data-service-postman-integration.md @@ -35,8 +35,7 @@ summary: 了解如何在 Postman 中运行数据应用。 > **注意：** > - > - 如果数据应用缺少定义完善的端点（已配置目标 {{{ .starter }}} 实例、路径、请求方法和 SQL 语句），则该数据应用的**在 Postman 中运行**按钮将保持禁用状态。 - > - Chat2Query 数据应用不提供**在 Postman 中运行**功能。 + > 如果数据应用缺少定义完善的端点（已配置目标 {{{ .starter }}} 实例、路径、请求方法和 SQL 语句），则该数据应用的**在 Postman 中运行**按钮将保持禁用状态。 4. 按照对话框中提供的步骤导入数据应用： diff --git a/tidb-cloud/data-service-response-and-status-code.md b/tidb-cloud/data-service-response-and-status-code.md index a44eab49dbf0d..355d1187c29a6 100644 --- a/tidb-cloud/data-service-response-and-status-code.md +++ b/tidb-cloud/data-service-response-and-status-code.md @@ -19,7 +19,7 @@ Data Service 返回带有 JSON 主体的 HTTP 响应。 响应主体包含以下字段： -- `type`：_string_。此端点的类型。值可能是 `"sql_endpoint"` 或 `"chat2data_endpoint"`。不同的端点返回不同类型的响应。 +- `type`：_string_。此端点的类型。值为 `"sql_endpoint"`。 - `data`：_object_。执行结果，包括三个部分： - `columns`：_array_。返回字段的架构信息。 @@ -34,9 +34,6 @@ Data Service 返回带有 JSON 主体的 HTTP 响应。 以下是一个示例响应： - -
- ```json { "type": "sql_endpoint", @@ -70,51 +67,6 @@ Data Service 返回带有 JSON 主体的 HTTP 响应。 } ``` -
- -
- -```json -{ - "type": "chat2data_endpoint", - "data": { - "columns": [ - { - "col": "id", - "data_type": "BIGINT", - "nullable": false - }, - { - "col": "type", - "data_type": "VARCHAR", - "nullable": false - } - ], - "rows": [ - { - "id": "20008295419", - "type": "CreateEvent" - } - ], - "result": { - "code": 200, - "message": "Query OK!", - "start_ms": 1678965476709, - "end_ms": 1678965476839, - "latency": "130ms", - "row_count": 1, - "row_affect": 0, - "limit": 50 - "sql": "select id,type from sample_data.github_events limit 1;", - "ai_latency": "30ms" - } - } -} -``` - -
- - ## 状态码 ### 200 @@ -279,9 +231,6 @@ Data Service 返回带有 JSON 主体的 HTTP 响应。 以下是一个示例响应： - -
- ```json { "type": "", @@ -302,33 +251,6 @@ Data Service 返回带有 JSON 主体的 HTTP 响应。 } ``` -
- -
- -```json -{ - "type": "chat2data_endpoint", - "data": { - "columns": [], - "rows": [], - "result": { - "code": 429, - "message": "The AI request exceeded the limit of 100 times per day. For more quota, please contact us: https://tidb.support.pingcap.com/", - "start_ms": "", - "end_ms": "", - "latency": "", - "row_count": 0, - "row_affect": 0, - "limit": 0 - } - } -} -``` - -
- - ### 500 此状态码表示请求遇到了内部错误。这个错误可能有多种原因。 diff --git a/tidb-cloud/explore-data-with-sql-editor.md b/tidb-cloud/explore-data-with-sql-editor.md new file mode 100644 index 0000000000000..a85ac7ee0e79e --- /dev/null +++ b/tidb-cloud/explore-data-with-sql-editor.md @@ -0,0 +1,101 @@ +--- +title: 使用 SQL Editor (PREVIEW) 探索你的数据 +summary: 了解如何在 TiDB Cloud 控制台中使用 SQL Editor 编写和运行 SQL 查询、管理 SQL 文件以及查看查询结果。 +aliases: ['/zh/tidbcloud/explore-data-with-chat2query','/zh/tidbcloud/use-chat2query-api','/zh/tidbcloud/use-chat2query-knowledge','/zh/tidbcloud/use-chat2query-sessions'] +--- + +# 使用 SQL Editor (PREVIEW) 探索你的数据 + +你可以使用 [TiDB Cloud 控制台](https://tidbcloud.com/)内置的 SQL Editor，最大化挖掘数据价值。 + +在 SQL Editor 中，你无需本地 SQL 客户端即可针对数据库编写和运行 SQL 查询。你可以直观地以表格或图表形式查看查询结果，并轻松检查查询日志。 + +## 使用场景 {#use-cases} + +SQL Editor 的推荐使用场景如下： + +- 快速测试 TiDB 的 MySQL 兼容性。 +- 使用你自己的数据集轻松探索 TiDB 中的 SQL 功能。 + +## 限制 {#limitations} + +- SQL Editor 目前处于公测阶段，可以在 AWS 上的 [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) 实例上使用。如需在 [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) 集群上使用 SQL Editor，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。 + +## 访问 SQL Editor {#access-sql-editor} + +1. 进入 [**My TiDB**](https://tidbcloud.com/tidbs) 页面。 + + > **Tip:** + > + > 如果你属于多个组织，请先使用左上角的下拉框切换到目标组织。 + +2. 点击你的 {{{ .starter }}} 实例或 TiDB Cloud Dedicated 集群名称，然后在左侧导航栏中点击 **SQL Editor**。 + + > **Note:** + > + > 在以下情况下，**SQL Editor** 入口会显示为灰色且不可点击。 + > + > - 你的 TiDB Cloud Dedicated 集群版本早于 v6.5.0。要使用 SQL Editor，你需要联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md) 升级集群。 + > - 你的 TiDB Cloud Dedicated 集群刚刚创建，SQL Editor 的运行环境仍在准备中。在这种情况下，请等待几分钟，SQL Editor 即可使用。 + > - 你的 TiDB Cloud Dedicated 集群已[暂停](/tidb-cloud/pause-or-resume-tidb-cluster.md)。 + +## 编写并运行 SQL 查询 {#write-and-run-sql-queries} + +在 SQL Editor 中，你可以使用自己的数据集编写并运行 SQL 查询。 + +1. 编写 SQL 查询。 + +2. 运行 SQL 查询。 + + +
+ + 对于 macOS： + + - 如果编辑器中只有一条查询，要运行它，请按 **⌘ + Enter** 或点击 **Run**。 + + - 如果编辑器中有多条查询，要按顺序运行其中一条或多条，请用光标选中目标查询所在的行，然后按 **⌘ + Enter** 或点击 **Run**。 + + - 要按顺序运行编辑器中的所有查询，请按 **⇧ + ⌘ + Enter**，或用光标选中所有查询所在的行后点击 **Run**。 + +
+ +
+ + 对于 Windows 或 Linux： + + - 如果编辑器中只有一条查询，要运行它，请按 **Ctrl + Enter** 或点击 **Run**。 + + - 如果编辑器中有多条查询，要按顺序运行其中一条或多条，请用光标选中目标查询所在的行，然后按 **Ctrl + Enter** 或点击 **Run**。 + + - 要按顺序运行编辑器中的所有查询，请按 **Shift + Ctrl + Enter**，或用光标选中所有查询所在的行后点击 **Run**。 + +
+ + +运行查询后，你可以立即在页面底部看到查询日志和结果。 + +> **Note:** +> +> 返回结果的大小限制为 8 MiB。 + +## 管理 SQL 文件 {#manage-sql-files} + +在 SQL Editor 中，你可以将 SQL 查询保存到不同的 SQL 文件中，并按如下方式管理 SQL 文件： + +- 要添加 SQL 文件，请在 **SQL Files** 选项卡上点击 **+**。 +- 要重命名 SQL 文件，请将光标移动到文件名上，点击文件名旁边的 **...**，然后选择 **Rename**。 +- 要删除 SQL 文件，请将光标移动到文件名上，点击文件名旁边的 **...**，然后选择 **Delete**。请注意，当 **SQL Files** 选项卡上只有一个 SQL 文件时，你无法将其删除。 + +## 管理 SQL Editor 设置 {#manage-sql-editor-settings} + +在 SQL Editor 中，你可以更改以下设置： + +- 查询结果中的最大行数 +- 是否在 **Schemas** 选项卡上显示系统数据库模式 + +要更改设置，请执行以下步骤： + +1. 在 **SQL Editor** 右上角，点击 **...** 并选择 **Settings**。 +2. 根据需要更改设置。 +3. 点击 **Save**。 \ No newline at end of file diff --git a/tidb-cloud/manage-user-access.md b/tidb-cloud/manage-user-access.md index b78563f9ec5de..907af51dbb3a7 100644 --- a/tidb-cloud/manage-user-access.md +++ b/tidb-cloud/manage-user-access.md @@ -141,8 +141,8 @@ TiDB Cloud 定义了不同的用户角色，用于管理组织、项目和实例 | 从备份中将实例或集群恢复为新资源。 | ✅ | ❌ | ❌ | ❌ | | 管理 [Data Service](/tidb-cloud/data-service-overview.md) 的只读操作，如使用或创建端点读取数据。 | ✅ | ✅ | ✅ | ❌ | | 管理 [Data Service](/tidb-cloud/data-service-overview.md) 的读写操作。 | ✅ | ✅ | ❌ | ❌ | -| 使用 [SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) 查看资源数据（如果资源类型支持）。 | ✅ | ✅ | ✅ | ❌ | -| 使用 [SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) 修改和删除资源数据（如果资源类型支持）。 | ✅ | ✅ | ❌ | ❌ | +| 使用 [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) 查看资源数据（如果资源类型支持）。 | ✅ | ✅ | ✅ | ❌ | +| 使用 [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) 修改和删除资源数据（如果资源类型支持）。 | ✅ | ✅ | ❌ | ❌ | | 管理 [changefeeds](/tidb-cloud/changefeed-overview.md)。 | ✅ | ✅ | ✅ | ❌ | | 审核和重置资源密码（如果资源类型支持）。 | ✅ | ❌ | ❌ | ❌ | | 查看项目中的资源概览、备份记录、指标、事件和 [changefeeds](/tidb-cloud/changefeed-overview.md)。 | ✅ | ✅ | ✅ | ✅ | @@ -161,8 +161,8 @@ TiDB X 实例支持实例级角色，因此你可以授予对单个 TiDB X 实 | 权限 | `Instance Manager` | `TiDB X Instance Data Access Read-Write` | `TiDB X Instance Data Access Read-Only` | `TiDB X Instance Viewer` | |---|---|---|---|---| | 管理实例操作，例如实例创建、修改和删除。 | ✅ | ❌ | ❌ | ❌ | -| 使用 [SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) 查看和修改实例数据。 | ✅ | ✅ | ❌ | ❌ | -| 使用 [SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) 查看实例数据。 | ✅ | ✅ | ✅ | ❌ | +| 使用 [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) 查看和修改实例数据。 | ✅ | ✅ | ❌ | ❌ | +| 使用 [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) 查看实例数据。 | ✅ | ✅ | ✅ | ❌ | | 管理实例作用域的角色。 | ✅ | ❌ | ❌ | ❌ | | 查看 TiDB X 实例的备份记录。 | ✅ | ❌ | ❌ | ✅ | | 从备份恢复 TiDB X 实例。 | ✅ | ❌ | ❌ | ❌ | diff --git a/tidb-cloud/monitor-built-in-alerting.md b/tidb-cloud/monitor-built-in-alerting.md index fe4169b2541c2..81022a0ac925c 100644 --- a/tidb-cloud/monitor-built-in-alerting.md +++ b/tidb-cloud/monitor-built-in-alerting.md @@ -9,9 +9,9 @@ TiDB Cloud 为你提供了便捷的方式来查看告警、编辑告警规则， 本文档介绍了如何进行这些操作，并为你提供了 TiDB Cloud 内置告警条件以供参考。 -> **注意：** +> **Note:** > -> 目前，告警订阅适用于 [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) 实例、[TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium) 实例和 [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) 集群。 +> 目前，告警订阅适用于 [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) 实例、[TiDB Cloud Premium](/tidb-cloud/select-cluster-tier.md#premium) 实例、[TiDB Cloud BYOC](/tidb-cloud/select-cluster-tier.md#byoc) 实例和 [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) 集群。 ## 查看告警 @@ -32,7 +32,7 @@ TiDB Cloud 为你提供了便捷的方式来查看告警、编辑告警规则， - + 在 TiDB Cloud 中，你可以在 **Alerts** 页面查看活跃和已关闭的告警。 @@ -42,7 +42,7 @@ TiDB Cloud 为你提供了便捷的方式来查看告警、编辑告警规则， > > 如果你属于多个组织，请使用左上角的下拉框先切换到目标组织。 -2. 点击目标 {{{ .premium }}} 实例的名称，进入其概览页面。 +2. 点击目标 {{{ .premium }}} 或 {{{ .byoc }}} 实例的名称，进入其概览页面。 3. 在左侧导航栏点击 **Alerts**。 4. **Alerts** 页面默认显示活跃告警。你可以查看每个活跃告警的信息，如告警名称、触发时间和持续时间。 5. 如果你还想查看已关闭的告警，只需点击 **Status** 下拉列表并选择 **Closed** 或 **All**。 @@ -133,12 +133,12 @@ TiDB Cloud 会根据不同的 [TiDB Cloud 方案](/tidb-cloud/select-cluster-tie | 每秒请求单元数（RU/s）超过最大 RCU 的 80% |
  1. 查看 RU 指标，判断增长是逐步上升还是突然激增。
  2. 如果增长是逐步发生的，请检查查询持续时间是否增加。如果是，则当前最大 RCU 可能不足。
  3. 在 TiDB Cloud 控制台中手动增加最大 RCU，以扩展容量。

如果你无法解决该问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| | RCU 消耗（Request Unit/s）超过 100,000 RCU |
  1. 查看 RU 指标中的流量模式，判断增长是逐步上升还是突然激增。
  2. 在 Elastic Mode 下，TiDB Cloud 会根据你的工作负载自动扩展后端容量。如果该使用水平符合预期，请调整告警阈值以匹配你的工作负载。请注意，持续较高的 RU/s 可能会增加你的成本。
  3. 如果该使用水平不符合预期，请使用 Top RU 功能识别并优化消耗最多 RU 的查询。

如果你无法解决该问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| | QPS 下降 80% |
  1. 检查下降是否由查询延时增加导致。
  2. 验证你的应用是否运行正常。如果该下降是预期行为，请忽略此告警。如果该下降并非预期且你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。
| -| 查询 P99 延时超过 200 ms |
  1. 排查慢查询：前往 Slow Query 页面，并按最近时间范围进行筛选，以识别新引入的查询或运行变慢的查询。
  2. 检查最近的变更，例如应用部署、schema 变更或数据导入任务，这些变更可能影响了流量模式。

如果你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| -| 查询 P95 延时超过 200 ms |
  1. 排查慢查询：前往 Slow Query 页面，并按最近时间范围进行筛选，以识别新引入的查询或运行变慢的查询。
  2. 检查最近的变更，例如应用部署、schema 变更或数据导入任务，这些变更可能影响了流量模式。

如果你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 查询 P99 延时超过 200 ms |
  1. 排查慢查询：前往 Slow Query 页面，并按最近时间范围进行筛选，以识别新引入的查询或运行变慢的查询。
  2. 检查最近的变更，例如应用部署、数据库模式变更或数据导入任务，这些变更可能影响了流量模式。

如果你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 查询 P95 延时超过 200 ms |
  1. 排查慢查询：前往 Slow Query 页面，并按最近时间范围进行筛选，以识别新引入的查询或运行变慢的查询。
  2. 检查最近的变更，例如应用部署、数据库模式变更或数据导入任务，这些变更可能影响了流量模式。

如果你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| | 请求错误率超过 10% | 查看最近的错误以及集群整体的语句执行状态。| -| 1 分钟内超过 20 条 SQL 语句的延时超过 256 ms 阈值 | 检查最近是否有 schema 或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| -| 1 分钟内超过 20 条 SQL 语句的延时超过 512 ms 阈值 | 检查最近是否有 schema 或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| -| 1 分钟内超过 20 条 SQL 语句的延时超过 4,096 ms 阈值 | 检查最近是否有 schema 或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 1 分钟内超过 20 条 SQL 语句的延时超过 256 ms 阈值 | 检查最近是否有数据库模式或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 1 分钟内超过 20 条 SQL 语句的延时超过 512 ms 阈值 | 检查最近是否有数据库模式或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 1 分钟内超过 20 条 SQL 语句的延时超过 4,096 ms 阈值 | 检查最近是否有数据库模式或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| ### {{{ .premium }}} 的 Changefeed 告警 {#changefeed-alerts-for-premium} @@ -150,6 +150,47 @@ TiDB Cloud 会根据不同的 [TiDB Cloud 方案](/tidb-cloud/select-cluster-tie + + +### {{{ .byoc }}} 的性能概览告警 {#performance-overview-alerts-for-byoc} + +| 条件 | 建议操作 | +|:---|:---| +| 每秒请求单元数（RU/s）超过最大 RCU 的 80% |
  1. 查看 RU 指标，判断增长是逐步上升还是突然激增。
  2. 如果增长是逐步发生的，请检查查询持续时间是否增加。如果是，则当前最大 RCU 可能不足。
  3. 在 TiDB Cloud 控制台中手动增加最大 RCU，以扩展容量。

如果你无法解决该问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| QPS 下降 80% |
  1. 检查下降是否由查询延时增加导致。
  2. 验证你的应用是否运行正常。如果该下降是预期行为，请忽略此告警。如果该下降并非预期且你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。
| +| 查询 P95 延时超过 200 ms |
  1. 排查慢查询：前往 Slow Query 页面，并按最近时间范围进行筛选，以识别新引入的查询或运行变慢的查询。
  2. 检查最近的变更，例如应用部署、数据库模式变更或数据导入任务，这些变更可能影响了流量模式。

如果你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 查询 P99 延时超过 200 ms |
  1. 排查慢查询：前往 Slow Query 页面，并按最近时间范围进行筛选，以识别新引入的查询或运行变慢的查询。
  2. 检查最近的变更，例如应用部署、数据库模式变更或数据导入任务，这些变更可能影响了流量模式。

如果你无法确定根因，请立即联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 请求错误率超过 10% | 查看最近的错误以及集群整体的语句执行状态。| +| 1 分钟内超过 20 条 SQL 语句的延时超过 256 ms 阈值 | 检查最近是否有数据库模式或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 1 分钟内超过 20 条 SQL 语句的延时超过 512 ms 阈值 | 检查最近是否有数据库模式或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| +| 1 分钟内超过 20 条 SQL 语句的延时超过 4,096 ms 阈值 | 检查最近是否有数据库模式或索引变更。查看 TiDB Cloud 控制台中的慢查询列表。对应的慢查询记录可能需要几分钟后才会出现。如果你无法确定根因，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。| + +### {{{ .byoc }}} 的 Resource Pool vCPU 限制告警 {#resource-pool-vcpu-limit-alerts-for-byoc} + +这些告警用于指示资源池的进一步扩展容量受限，或者扩展操作被其 **Pool vCPU Limit** 阻止。 + +分配百分比是指资源池中所有实例的所有数据库相关资源已分配 vCPU 总量除以 **Pool vCPU Limit**。Admin 和 Observability 节点的 vCPU 不计入其中。这些告警仅在配置了 **Pool vCPU Limit** 时适用。 + +| 告警 | 条件 | 建议操作 | +|:---|:---|:---| +| Resource Pool vCPU 分配过高 | 分配比例在配置的持续时间内保持在配置阈值或以上。默认值为 10 分钟内达到 80%。 | 查看资源池中各实例最近的工作负载变化和容量使用情况。如果需要额外的扩展容量，请提高 **Pool vCPU Limit**。如果你无法解决该问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。 | +| Resource Pool vCPU 分配接近上限 | 分配比例在配置的持续时间内保持在配置阈值或以上。默认值为 5 分钟内达到 95%。 | 提高 **Pool vCPU Limit**。查看资源池中各实例的容量使用情况，并排查最近的流量激增、导入任务或异常工作负载变化。如果你无法解决该问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。 | +| Resource Pool 扩缩容因 vCPU 限制而被阻止 | 由于请求的容量会超过 **Pool vCPU Limit**，扩展操作被拒绝。 | 提高 **Pool vCPU Limit** 或减少不必要的已分配容量。查看资源池中各实例的工作负载和容量使用情况。如果你无法解决该问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md)。 | + +这两个分配类告警默认启用。你可以在每个实例的 **Edit Rules** 页面更改其阈值和持续时间，或将其禁用。**Resource Pool vCPU allocation is high** 的阈值必须低于 **Resource Pool vCPU allocation is approaching the limit** 的阈值。设置按实例生效，而分配比例则是在共享资源池范围内进行度量。 + +**Resource Pool scaling was blocked by the vCPU limit** 不能被禁用。它表示共享资源池中的某个扩展请求因会超过 **Pool vCPU Limit** 而被拒绝。即使是同一资源池中的另一个实例发起了被阻止的扩展操作，此告警也可能出现在某个实例的 **Alerts** 页面上。 + +### {{{ .byoc }}} 的 Changefeed 告警 {#changefeed-alerts-for-byoc} + +| 条件 | 建议操作 | +|:---|:---| +| Changefeed 延时超过 600 秒 | 在 TiDB Cloud 控制台的 **Changefeed** 页面和 **Changefeed Detail** 页面检查 changefeed 状态，你可以在这些页面找到一些错误信息以帮助诊断问题。
可能触发该告警的原因包括：
  • 上游整体流量增加，导致现有 changefeed 规格无法承载。如果流量增加是暂时的，changefeed 延时会在流量恢复正常后自动恢复。如果流量持续增加，则需要扩展 changefeed。
  • 下游或网络异常，此时应先排查并解决异常。
  • 如果下游为 RDS，表缺少索引，可能导致写入性能低、延时高，此时需要为上游或下游添加必要索引。
如果你无法自行解决问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md) 获取进一步协助。 | +| Changefeed 状态为 `FAILED` | 在 TiDB Cloud 控制台的 **Changefeed** 页面和 **Changefeed Detail** 页面检查 changefeed 状态，你可以在这些页面找到一些错误信息以帮助诊断问题。
如果你无法自行解决问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md) 获取进一步协助。| +| Changefeed 状态为 `WARNING` | 在 TiDB Cloud 控制台的 **Changefeed** 页面和 **Changefeed Detail** 页面检查 changefeed 状态，你可以在这些页面找到一些错误信息以帮助诊断问题。
如果你无法自行解决问题，请联系 [TiDB Cloud 支持](/tidb-cloud/tidb-cloud-support.md) 获取进一步协助。| + + + ### {{{ .essential }}} 的性能概览告警 {#performance-overview-alerts-for-essential} diff --git a/tidb-cloud/releases/release-notes-2023.md b/tidb-cloud/releases/release-notes-2023.md index 225d35c6f2e17..b5c5a9fa271a1 100644 --- a/tidb-cloud/releases/release-notes-2023.md +++ b/tidb-cloud/releases/release-notes-2023.md @@ -758,13 +758,12 @@ summary: 了解 2023 年 TiDB Cloud 的发布说明。 - 通过 Data Service 作为数据源集成数据可视化项目。 - 从不支持 MySQL interface 的环境连接数据库。 - 此外，TiDB Cloud 提供 [Chat2Query API](/tidb-cloud/use-chat2query-api.md)，可通过 RESTful 接口结合 AI 生成并执行 SQL statement。 + 此外，TiDB Cloud 提供 Chat2Query API，可通过 RESTful 接口结合 AI 生成并执行 SQL statement。 访问方法：左侧导航栏进入 [**Data Service**](https://tidbcloud.com/project/data-service) 页面。更多信息参见： - [Data Service 概览](/tidb-cloud/data-service-overview.md) - [Data Service 入门](/tidb-cloud/data-service-get-started.md) - - [Chat2Query API 入门](/tidb-cloud/use-chat2query-api.md) - 支持对 2022 年 12 月 31 日后在 AWS 上创建的 [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) 集群缩容 TiDB、TiKV、TiFlash 节点规格。 @@ -948,7 +947,7 @@ summary: 了解 2023 年 TiDB Cloud 的发布说明。 - 你现在可以直接拖拽 CSV 文件到 **Import** 页的上传区域。 - 创建导入任务时，如目标数据库或表不存在，可输入名称让 TiDB Cloud 自动创建。对于新建目标表，你可指定主键或选择多个字段组成复合主键。 - - 导入完成后，可点击 **Explore your data by Chat2Query** 或任务列表中的目标表名，使用 [AI 驱动的 Chat2Query](/tidb-cloud/explore-data-with-chat2query.md) 探索数据。 + - 导入完成后，可点击 **Explore your data by Chat2Query** 或任务列表中的目标表名，使用 AI 驱动的 Chat2Query 探索数据。 详情参见 [导入本地文件到 TiDB Cloud](/tidb-cloud/tidb-cloud-import-local-files.md)。 diff --git a/tidb-cloud/releases/release-notes-2024.md b/tidb-cloud/releases/release-notes-2024.md index 882274be9e200..b4272001338a1 100644 --- a/tidb-cloud/releases/release-notes-2024.md +++ b/tidb-cloud/releases/release-notes-2024.md @@ -257,8 +257,6 @@ summary: 了解 2024 年 TiDB Cloud 的发布说明。 通过 Chat2Query API v3 端点，你可以使用会话开启多轮 Chat2Query。 - 更多信息，参见 [开始使用 Chat2Query API](/tidb-cloud/use-chat2query-api.md)。 - **控制台变更** - 将 Chat2Query（测试版）重命名为 SQL Editor（测试版）。 @@ -268,8 +266,6 @@ summary: 了解 2024 年 TiDB Cloud 的发布说明。 - **SQL Editor**：TiDB Cloud 控制台中用于手动编写和执行 SQL 查询的默认界面。 - **Chat2Query**：AI 辅助的文本转查询功能，支持你通过自然语言与数据库交互，生成、重写和优化 SQL 查询。 - 更多信息，参见 [使用 AI 辅助 SQL Editor 探索数据](/tidb-cloud/explore-data-with-chat2query.md)。 - ## 2024 年 6 月 18 日 **通用变更** diff --git a/tidb-cloud/releases/tidb-cloud-release-notes.md b/tidb-cloud/releases/tidb-cloud-release-notes.md index 0a13d8a11ec71..438d8c3e847e8 100644 --- a/tidb-cloud/releases/tidb-cloud-release-notes.md +++ b/tidb-cloud/releases/tidb-cloud-release-notes.md @@ -12,6 +12,12 @@ aliases: ['/zh/tidbcloud/supported-tidb-versions','/zh/tidbcloud/release-notes', **常规变更** +- **TiDB Cloud Starter** + + - [SQL Editor](https://docs.pingcap.com/tidbcloud/explore-data-with-sql-editor/?plan=starter&compatibility=mysql) 和 [Data Service](https://docs.pingcap.com/tidbcloud/data-service-overview/?plan=starter&compatibility=mysql) 不再支持 Chat2Query。 + + 从 2026 年 10 月 20 日起，TiDB Cloud 不再在 SQL Editor 和 Data Service 中提供 Chat2Query 功能。此变更仅影响 Chat2Query 和 Chat2Query API。SQL Editor 和 Data Service 中的所有其他功能仍然可用。 + - **TiDB Cloud Essential and Premium** - TiDB Cloud Essential and Premium 支持 [New Relic](https://newrelic.com/) 指标集成（公测中）。 @@ -39,6 +45,8 @@ aliases: ['/zh/tidbcloud/supported-tidb-versions','/zh/tidbcloud/release-notes', 这些告警可为你清晰地说明可用的扩展容量以及建议采取的操作。 + 更多信息，请参阅 [TiDB Cloud 内置告警](https://docs.pingcap.com/tidbcloud/monitor-built-in-alerting/?plan=byoc)。 + ## 2026 年 10 月 15 日 {#october-15-2026} **常规变更** diff --git a/tidb-cloud/select-cluster-tier.md b/tidb-cloud/select-cluster-tier.md index 879c15abf56cf..fade9f1e9505f 100644 --- a/tidb-cloud/select-cluster-tier.md +++ b/tidb-cloud/select-cluster-tier.md @@ -16,6 +16,7 @@ TiDB Cloud 提供了以下几种方案选项。无论你是刚刚开始使用， - [{{{ .byoc }}}](#byoc) - [{{{ .dedicated }}}](#tidb-cloud-dedicated) - [{{{ .lake }}}](#lake) +- [TiDB Cloud Filesystem](#tidb-cloud-filesystem) > **注意：** > @@ -162,3 +163,9 @@ TiDB Cloud Dedicated 适用于生产环境，具备跨可用区高可用性、 TiDB Cloud Lake 在一个平台中支持 ANSI SQL、半结构化数据处理、向量搜索和面向 AI 的工作流。它专为希望获得托管式分析体验而无需自行运维底层基础设施的团队而设计。 参见 [TiDB Cloud Lake Overview](https://docs.pingcap.com/tidbcloudlake/lake-overview/) 和 [TiDB Cloud Lake Quick Start](https://docs.pingcap.com/tidbcloudlake/lake-quick-start/)。 + +## TiDB Cloud Filesystem {#tidb-cloud-filesystem} + +TiDB Cloud Filesystem 是一个面向应用程序、自动化流程和 AI 代理的持久化共享云文件系统。当文件需要在不同会话和环境之间保持可用，或者多个用户或工作负载需要以受控方式访问同一组文件时，可以使用它。你无需预配或管理 TiDB 数据库即可使用它。 + +TiDB Cloud Filesystem 目前处于公测阶段。更多信息，请参见 [TiDB Cloud Filesystem 文档](https://docs.pingcap.com/tidbcloud-filesystem/filesystem-intro/)。 diff --git a/tidb-cloud/sql-proxy-account.md b/tidb-cloud/sql-proxy-account.md index 81ae8bdd625d4..ffb9741055539 100644 --- a/tidb-cloud/sql-proxy-account.md +++ b/tidb-cloud/sql-proxy-account.md @@ -5,7 +5,7 @@ summary: 了解 TiDB Cloud 中的 SQL 代理账号。 # SQL 代理账号 -SQL 代理账号是 TiDB Cloud 自动为 TiDB Cloud 用户创建的 SQL 用户账号，用于通过 [SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) 或 [Data Service](https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice) 代表用户访问数据库。例如，`testuser@pingcap.com` 是一个 TiDB Cloud 用户账号，而 `3jhEcSimm7keKP8.testuser._41mqK6H4` 则是其对应的 SQL 代理账号。 +SQL 代理账号是 TiDB Cloud 自动为 TiDB Cloud 用户创建的 SQL 用户账号，用于通过 [SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md) 或 [Data Service](https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice) 代表用户访问数据库。例如，`testuser@pingcap.com` 是一个 TiDB Cloud 用户账号，而 `3jhEcSimm7keKP8.testuser._41mqK6H4` 则是其对应的 SQL 代理账号。 SQL 代理账号为在 TiDB Cloud 中访问数据库提供了一种安全的、基于令牌的身份验证机制。通过消除传统的用户名和密码凭证，SQL 代理账号提升了安全性并简化了访问管理。 diff --git a/tidb-cloud/tidb-cloud-billing.md b/tidb-cloud/tidb-cloud-billing.md index 9edd571748892..2ba9306263a6b 100644 --- a/tidb-cloud/tidb-cloud-billing.md +++ b/tidb-cloud/tidb-cloud-billing.md @@ -35,6 +35,10 @@ TiDB Cloud 根据你所消耗的资源进行收费。 对于 TiDB Cloud Lake，你的费用由 warehouse、storage 和 cloud service fee 构成。详情请参见 [TiDB Cloud Lake Pricing & Billing](https://docs.pingcap.com/tidbcloudlake/pricing-billing/)。 +### TiDB Cloud Filesystem 的定价 {#pricing-for-tidb-cloud-filesystem} + +TiDB Cloud Filesystem 对读、写、存储和互联网出口流量采用按量付费定价，并提供按月计算的免费额度，该额度在你组织的各个文件系统和 Region 之间共享。详情请参见 [TiDB Cloud Filesystem Pricing Details](https://www.pingcap.com/tidb-cloud-filesystem-pricing-details/)。 + ## 发票 {#invoices} 如果你在组织中拥有 `Organization Owner` 或 `Organization Billing Manager` 角色，则可以管理 TiDB Cloud 的发票信息。否则，请跳过本节。 diff --git a/tidb-cloud/tidb-cloud-glossary.md b/tidb-cloud/tidb-cloud-glossary.md index 2bb17ea055337..d254bcf309f93 100644 --- a/tidb-cloud/tidb-cloud-glossary.md +++ b/tidb-cloud/tidb-cloud-glossary.md @@ -23,12 +23,6 @@ ACID 指的是事务的四个关键属性：原子性（atomicity）、一致性 ## C -### Chat2Query - -Chat2Query 是集成在 SQL Editor 中的 AI 驱动功能，帮助用户通过自然语言指令生成、调试或重写 SQL 查询。更多信息，参见 [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)。 - -此外，TiDB Cloud 为托管在 AWS 上的 TiDB Cloud Starter 实例提供 Chat2Query API。启用后，TiDB Cloud 会自动创建一个名为 **Chat2Query** 的系统 Data App，并在 Data Service 中创建一个 Chat2Data endpoint。你可以调用该 endpoint，通过指令让 AI 生成并执行 SQL 语句。更多信息，参见 [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md)。 - ### Cluster 在 TiDB Cloud 中，cluster 是一种专用云部署，包含明确的基础设施细节，例如节点拓扑、实例类型、存储配置和扩缩容模型。 @@ -154,7 +148,7 @@ project members 是被邀请加入 organization 下一个或多个 project 的 - TiDB Region - TiDB 中数据的基本单元。TiKV 将 Key-Value 空间划分为一系列连续的 Key 段，每个段称为 Region。每个 Region 的默认大小上限为 96 MB，可配置。 + TiDB 中数据的基本单元。TiKV 将 Key-Value 空间划分为一系列连续的 Key 段，每个段称为 Region。默认情况下，[新切分 Region 的预估大小](https://docs.pingcap.com/tidb/stable/tikv-configuration-file/#region-split-size) 在 TiDB v8.4.0 及以上版本中为 256 MiB，在早于 v8.4.0 的 TiDB 版本中为 96 MiB。 ### replica diff --git a/tidb-cloud/tidb-cloud-import-local-files.md b/tidb-cloud/tidb-cloud-import-local-files.md index ce808251ecdd4..a443c95cdb1c3 100644 --- a/tidb-cloud/tidb-cloud-import-local-files.md +++ b/tidb-cloud/tidb-cloud-import-local-files.md @@ -75,7 +75,7 @@ summary: 了解如何将本地文件导入 TiDB Cloud Starter。 你可以在 **Import Task Detail** 页面查看导入进度。如果有警告或失败的任务，可以查看详情并进行处理。 -9. 导入任务完成后，你可以点击 **Explore your data by SQL Editor**，通过 SQL 查询已导入的数据。关于如何使用 SQL Editor 的更多信息，请参见 [使用 AI 辅助 SQL Editor 探索数据](/tidb-cloud/explore-data-with-chat2query.md)。 +9. 导入任务完成后，你可以点击 **Explore your data by SQL Editor**，通过 SQL 查询已导入的数据。关于如何使用 SQL Editor 的更多信息，请参见 [使用 SQL Editor 探索数据](/tidb-cloud/explore-data-with-sql-editor.md)。 10. 在 **Import** 页面，你可以点击 **...** > **View**，在 **Action** 列查看导入任务详情。 diff --git a/tidb-cloud/tidb-cloud-intro.md b/tidb-cloud/tidb-cloud-intro.md index 0583aca14afa3..bf2c8f464cf90 100644 --- a/tidb-cloud/tidb-cloud-intro.md +++ b/tidb-cloud/tidb-cloud-intro.md @@ -133,6 +133,10 @@ TiDB Cloud 提供以下部署选项： TiDB Cloud Lake 是一项面向分析负载的云原生数据仓库服务。它将计算与存储分离，并支持 ANSI SQL、半结构化数据处理和面向 AI 的工作流。更多详情，参见 [TiDB Cloud Lake Overview](https://docs.pingcap.com/tidbcloudlake/lake-overview/)。 +- TiDB Cloud Filesystem + + TiDB Cloud Filesystem 是一个面向应用程序、自动化流程和 AI 代理的持久化共享云文件系统。目前处于公测阶段。更多详情，参见 [TiDB Cloud Filesystem](https://docs.pingcap.com/tidbcloud-filesystem/filesystem-intro/)。 + ## 架构 ![TiDB Cloud architecture](/media/tidb-cloud/tidb-cloud-architecture.png) diff --git a/tidb-cloud/tidb-cloud-quickstart.md b/tidb-cloud/tidb-cloud-quickstart.md index 712fdc312b37f..fb19d149ac55b 100644 --- a/tidb-cloud/tidb-cloud-quickstart.md +++ b/tidb-cloud/tidb-cloud-quickstart.md @@ -26,7 +26,7 @@ category: quick start 3. 对于新注册用户，TiDB Cloud 会自动为你创建一个名为 `Instance0` 的默认 {{{ .starter }}} 实例。 - - 如果你想立即使用该默认 {{{ .starter }}} 实例体验 TiDB Cloud 的功能，请继续阅读 [第 2 步：体验 AI 辅助 SQL 编辑器](#step-2-try-ai-assisted-sql-editor)。 + - 如果你想立即使用该默认 {{{ .starter }}} 实例体验 TiDB Cloud 的功能，请继续阅读 [第 2 步：体验 SQL Editor](#step-2-try-sql-editor)。 - 如果你想自行创建新的 {{{ .starter }}} 实例，请按照以下步骤操作： 1. 点击 **Create Resource**。 @@ -50,25 +50,33 @@ category: quick start -## 第 2 步：体验 AI 辅助 SQL 编辑器 +## 第 2 步：体验 SQL Editor {#step-2-try-sql-editor} -对于托管在 AWS 上的 {{{ .starter }}} 实例，你可以在 TiDB Cloud 控制台中使用内置的 AI 辅助 SQL 编辑器，最大化数据价值。你无需本地 SQL 客户端即可对数据库运行 SQL 查询，并可直观地以表格或图表形式查看查询结果，轻松查看查询日志。 +对于托管在 AWS 上的 {{{ .starter }}} 实例，你可以在 TiDB Cloud 控制台中使用内置的 SQL Editor，最大化数据价值。你无需本地 SQL 客户端即可对数据库运行 SQL 查询，并可直观地以表格或图表形式查看查询结果，轻松查看查询日志。 1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面，点击你的 {{{ .starter }}} 实例名称进入其概览页面，然后在左侧导航栏点击 **SQL Editor**。 -2. 若要体验 TiDB Cloud 的 AI 能力，请按照页面提示，允许 PingCAP 和 AWS Bedrock 使用你的代码片段进行研究和服务改进，然后点击 **Save and Get Started**。 +2. 在 SQL Editor 中编写 SQL 查询。 -3. 在 SQL Editor 中，按下 ⌘ + I（macOS）或 Control + I（Windows 或 Linux），即可指示 [Chat2Query (PREVIEW)](/tidb-cloud/tidb-cloud-glossary.md#chat2query) 自动生成 SQL 查询。 + 例如，你可以运行以下 SQL 语句来创建表、插入数据并查询数据： - 例如，若要创建一个包含两列（`id` 和 `name`）的新表 `test.t`，你可以输入 `use test;` 指定数据库，按下 ⌘ + I，输入指令 `create a new table t with id and name`，然后按 **Enter**，让 AI 自动生成相应的 SQL 语句。 + ```sql + USE test; - 对于生成的语句，你可以点击 **Accept** 接受并根据需要进一步编辑，或点击 **Discard** 拒绝。 + -- create a new table t with id and name + CREATE TABLE `t` (`id` INT, `name` VARCHAR(255)); - > **注意：** - > - > AI 生成的 SQL 查询并非 100% 准确，可能仍需进一步调整。 + -- add 3 rows + INSERT INTO `t` (`id`, `name`) VALUES + (1, 'row1'), + (2, 'row2'), + (3, 'row3'); -4. 运行 SQL 查询。 + -- query all + SELECT `id`, `name` FROM `t`; + ``` + +3. 运行 SQL 查询。
@@ -98,31 +106,6 @@ category: quick start 运行查询后，你可以在页面底部立即看到查询日志和结果。 -如需让 AI 生成更多 SQL 语句，你可以输入更多指令，如下例所示： - -```sql -use test; - --- create a new table t with id and name -CREATE TABLE - `t` (`id` INT, `name` VARCHAR(255)); - --- add 3 rows -INSERT INTO - `t` (`id`, `name`) -VALUES - (1, 'row1'), - (2, 'row2'), - (3, 'row3'); - --- query all -SELECT - `id`, - `name` -FROM - `t`; -``` - ## 第 3 步：体验控制台引导式教程 TiDB Cloud 提供了交互式教程和精心设计的示例数据集，帮助你快速上手 TiDB Cloud。对于托管在 AWS 上的 {{{ .starter }}} 实例，你可以通过该教程学习如何使用 TiDB Cloud 进行高性能数据分析。 @@ -147,7 +130,7 @@ MySQL CLI 客户端将打开并连接到你的 {{{ .starter }}} 实例。 ## 后续操作 - 了解如何通过不同方式连接到你的 {{{ .starter }}} 实例，请参见 [Connect to a {{{ .starter }}} or Essential instance](/tidb-cloud/connect-to-tidb-cluster-serverless.md)。 -- 了解如何使用 SQL Editor 和 Chat2Query 探索你的数据，请参见 [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)。 +- 了解如何使用 SQL Editor 探索你的数据，请参见 [Explore your data with SQL Editor](/tidb-cloud/explore-data-with-sql-editor.md)。 - 了解 TiDB SQL 的使用方法，请参见 [Explore SQL with TiDB](/basic-sql-operations.md)。 - 若需生产环境使用，享受跨可用区高可用、水平扩展和 [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing) 等优势，请参见 [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md)。 - 如需使用 TiDB Cloud CLI 管理你的实例，请参见 [TiDB Cloud CLI Reference (PREVIEW)](/tidb-cloud/cli-reference.md)。 \ No newline at end of file