From faeb1a5a0f0daa9746fc2cbbacbca9a200272760 Mon Sep 17 00:00:00 2001 From: qiancai Date: Wed, 25 Dec 2024 15:50:29 +0800 Subject: [PATCH 1/3] test2 --- .vaunt/add-tidb-docs-dash-badge.md | 2 +- CONTRIBUTING.md | 4 +- README.md | 4 +- accelerated-table-creation.md | 4 +- alert-rules.md | 4 +- analyze-slow-queries.md | 2 +- auto-increment.md | 2 +- auto-random.md | 2 +- basic-features.md | 2 +- benchmark/benchmark-sysbench-v2.md | 2 +- benchmark/benchmark-sysbench-v3.md | 4 +- .../benchmark-sysbench-v5.1.0-vs-v5.0.2.md | 4 +- .../benchmark-sysbench-v5.2.0-vs-v5.1.1.md | 4 +- .../benchmark-sysbench-v5.3.0-vs-v5.2.2.md | 4 +- .../benchmark-sysbench-v5.4.0-vs-v5.3.0.md | 4 +- .../benchmark-sysbench-v6.0.0-vs-v5.4.0.md | 4 +- .../benchmark-sysbench-v6.1.0-vs-v6.0.0.md | 4 +- .../benchmark-sysbench-v6.2.0-vs-v6.1.0.md | 4 +- benchmark/benchmark-tidb-using-ch.md | 2 +- benchmark/benchmark-tidb-using-sysbench.md | 4 +- benchmark/benchmark-tidb-using-tpcc.md | 2 +- benchmark/benchmark-tpch.md | 2 +- ...line-workloads-and-add-index-operations.md | 2 +- ...-performance-benchmarking-with-sysbench.md | 4 +- ...v3.0-performance-benchmarking-with-tpcc.md | 4 +- ...v5.1-performance-benchmarking-with-tpcc.md | 4 +- ...v5.2-performance-benchmarking-with-tpcc.md | 4 +- ...v5.3-performance-benchmarking-with-tpcc.md | 4 +- ...v5.4-performance-benchmarking-with-tpcc.md | 4 +- ...v6.0-performance-benchmarking-with-tpcc.md | 4 +- ...v6.1-performance-benchmarking-with-tpcc.md | 4 +- ...v6.2-performance-benchmarking-with-tpcc.md | 4 +- best-practices-for-security-configuration.md | 4 +- best-practices-on-public-cloud.md | 6 +-- .../grafana-monitor-best-practices.md | 2 +- best-practices/haproxy-best-practices.md | 2 +- .../high-concurrency-best-practices.md | 4 +- best-practices/java-app-best-practices.md | 2 +- best-practices/readonly-nodes.md | 2 +- best-practices/three-dc-local-read.md | 2 +- .../three-nodes-hybrid-deployment.md | 2 +- best-practices/tidb-best-practices.md | 4 +- binary-package.md | 2 +- br/backup-and-restore-design.md | 2 +- br/backup-and-restore-overview.md | 2 +- br/backup-and-restore-use-cases.md | 4 +- br/br-incremental-guide.md | 2 +- br/br-log-architecture.md | 2 +- br/br-pitr-guide.md | 2 +- br/br-pitr-manual.md | 2 +- br/br-snapshot-architecture.md | 2 +- br/br-snapshot-guide.md | 2 +- br/br-snapshot-manual.md | 6 +-- br/br-use-overview.md | 2 +- cached-tables.md | 4 +- certificate-authentication.md | 8 ++-- character-set-and-collation.md | 2 +- check-before-deployment.md | 2 +- clinic/clinic-collect-sql-query-plan.md | 2 +- clinic/clinic-data-instruction-for-tiup.md | 8 ++-- clinic/clinic-user-guide-for-tiup.md | 2 +- clinic/quick-start-with-clinic.md | 2 +- clustered-indexes.md | 4 +- command-line-flags-for-tidb-configuration.md | 2 +- comment-syntax.md | 2 +- configure-memory-usage.md | 2 +- credits.md | 6 +-- dashboard/dashboard-diagnostics-report.md | 2 +- dashboard/dashboard-ops-security.md | 2 +- ddl-introduction.md | 2 +- deploy-monitoring-services.md | 2 +- develop/dev-guide-build-cluster-in-cloud.md | 2 +- develop/dev-guide-overview.md | 8 ++-- develop/dev-guide-proxysql-integration.md | 8 ++-- develop/dev-guide-third-party-support.md | 2 +- ...v-guide-third-party-tools-compatibility.md | 8 ++-- develop/dev-guide-tidb-crud-sql.md | 2 +- develop/dev-guide-timeouts-in-tidb.md | 2 +- develop/dev-guide-use-temporary-tables.md | 2 +- dm/dm-binlog-event-filter.md | 2 +- dm/dm-enable-tls.md | 4 +- dm/dm-faq.md | 2 +- dm/dm-task-configuration-guide.md | 4 +- download-ecosystem-tools.md | 6 +-- dr-secondary-cluster.md | 4 +- dr-solution-introduction.md | 4 +- dumpling-overview.md | 4 +- dynamic-config.md | 2 +- ecosystem-tool-user-case.md | 6 +-- ecosystem-tool-user-guide.md | 4 +- enable-disk-spill-encrypt.md | 2 +- enable-tls-between-clients-and-servers.md | 4 +- enable-tls-between-components.md | 2 +- encryption-at-rest.md | 2 +- error-codes.md | 2 +- explain-overview.md | 2 +- faq/backup-and-restore-faq.md | 2 +- faq/deploy-and-maintain-faq.md | 16 +++---- faq/faq-overview.md | 2 +- faq/high-availability-faq.md | 4 +- faq/high-reliability-faq.md | 6 +-- faq/manage-cluster-faq.md | 46 +++++++++---------- faq/migration-tidb-faq.md | 18 ++++---- faq/monitor-faq.md | 2 +- faq/sql-faq.md | 36 +++++++-------- faq/tidb-faq.md | 34 +++++++------- filter-binlog-event.md | 2 +- foreign-key.md | 6 +-- .../aggregate-group-by-functions.md | 2 +- .../information-functions.md | 6 +-- functions-and-operators/tidb-functions.md | 2 +- get-started-with-tidb-lightning.md | 2 +- glossary.md | 2 +- grafana-tidb-dashboard.md | 2 +- hardware-and-software-requirements.md | 4 +- identify-slow-queries.md | 4 +- information-schema/information-schema.md | 2 +- log-redaction.md | 2 +- migrate-from-tidb-to-mysql.md | 2 +- migrate-from-tidb-to-tidb.md | 2 +- migration-overview.md | 2 +- mysql-compatibility.md | 2 +- mysql-schema/mysql-schema-user.md | 2 +- optimistic-transaction.md | 2 +- oracle-functions-to-tidb.md | 2 +- overview.md | 2 +- partitioned-table.md | 4 +- password-management.md | 4 +- pd-recover.md | 6 +-- performance-schema/performance-schema.md | 2 +- performance-tuning-methods.md | 10 ++-- performance-tuning-overview.md | 2 +- pessimistic-transaction.md | 2 +- post-installation-check.md | 4 +- privilege-management.md | 2 +- production-deployment-using-tiup.md | 4 +- quick-start-with-tidb.md | 2 +- read-historical-data.md | 2 +- releases/release-5.0.0.md | 4 +- releases/release-5.2.0.md | 2 +- releases/release-5.3.0.md | 4 +- releases/release-5.4.0.md | 2 +- releases/release-6.0.0-dmr.md | 2 +- releases/release-6.4.0.md | 4 +- releases/release-7.3.0.md | 2 +- releases/release-7.4.0.md | 2 +- releases/release-notes.md | 2 +- releases/release-timeline.md | 2 +- releases/versioning.md | 4 +- resources/tidb-pdf-generation-tutorial.md | 4 +- resources/tidb-terms.md | 2 +- scale-tidb-using-tiup.md | 2 +- schedule-replicas-by-topology-labels.md | 4 +- .../sql-statement-admin-show-ddl.md | 2 +- system-variables.md | 2 +- temporary-tables.md | 8 ++-- ticdc/deploy-ticdc.md | 6 +-- ticdc/integrate-confluent-using-ticdc.md | 2 +- ticdc/ticdc-avro-protocol.md | 6 +-- ticdc/ticdc-canal-json.md | 2 +- ticdc/ticdc-client-authentication.md | 2 +- ticdc/ticdc-faq.md | 4 +- ticdc/ticdc-manage-changefeed.md | 2 +- ticdc/ticdc-sink-to-cloud-storage.md | 2 +- ticdc/ticdc-sink-to-kafka.md | 2 +- ticdc/ticdc-upstream-downstream-check.md | 2 +- tidb-architecture.md | 2 +- tidb-computing.md | 2 +- tidb-configuration-file.md | 2 +- tidb-distributed-execution-framework.md | 2 +- tidb-global-sort.md | 2 +- tidb-in-kubernetes.md | 2 +- tidb-lightning/tidb-lightning-glossary.md | 2 +- tidb-lightning/troubleshoot-tidb-lightning.md | 2 +- tidb-monitoring-api.md | 2 +- tidb-monitoring-framework.md | 8 ++-- tidb-scheduling.md | 2 +- tidb-storage.md | 2 +- tidb-troubleshooting-map.md | 6 +-- tiflash/tiflash-configuration.md | 6 +-- tiflash/tune-tiflash-performance.md | 2 +- tiflash/use-tidb-to-read-tiflash.md | 2 +- time-to-live.md | 4 +- tiproxy/tiproxy-load-balance.md | 2 +- tiproxy/tiproxy-overview.md | 2 +- tiup/tiup-cluster-topology-reference.md | 2 +- tiup/tiup-cluster.md | 2 +- tiup/tiup-playground.md | 10 ++-- transaction-isolation-levels.md | 2 +- transaction-overview.md | 2 +- troubleshoot-cpu-issues.md | 2 +- troubleshoot-high-disk-io.md | 2 +- troubleshoot-hot-spot-issues.md | 4 +- troubleshoot-lock-conflicts.md | 2 +- troubleshoot-tidb-cluster.md | 2 +- tso.md | 2 +- upgrade-monitoring-services.md | 6 +-- upgrade-tidb-using-tiup.md | 4 +- user-account-management.md | 2 +- vector-search-get-started-using-python.md | 4 +- vector-search-get-started-using-sql.md | 2 +- vector-search-integrate-with-django-orm.md | 4 +- ...-search-integrate-with-jinaai-embedding.md | 6 +-- vector-search-integrate-with-langchain.md | 2 +- vector-search-integrate-with-llamaindex.md | 4 +- vector-search-integrate-with-peewee.md | 4 +- vector-search-integrate-with-sqlalchemy.md | 4 +- 207 files changed, 393 insertions(+), 393 deletions(-) diff --git a/.vaunt/add-tidb-docs-dash-badge.md b/.vaunt/add-tidb-docs-dash-badge.md index a58e6368d1ba..02487c898700 100644 --- a/.vaunt/add-tidb-docs-dash-badge.md +++ b/.vaunt/add-tidb-docs-dash-badge.md @@ -1,4 +1,4 @@ -# 如何在你的 GitHub 个人资料页上添加 TiDB 文档挑战赛徽章 +# 如何在你的 GitHub 个人资料页上添加测试数据库文档挑战赛徽章 [GitHub 个人资料页](https://docs.github.com/zh/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)不仅仅是你的 GitHub 仓库的集合，更是你在编程领域中的专业身份标志。 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6d6e70f9983..25675323b52c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# TiDB 中文文档贡献指南 +# 测试数据库中文文档贡献指南 无论你是热爱技术的程序员，还是擅长书面表达的语言爱好者，亦或是纯粹想帮 TiDB 改进文档的热心小伙伴，都欢迎来为 TiDB 文档做贡献，一起打造更加易用友好的 TiDB 文档！ -## 我能为 TiDB 文档做什么贡献？ +## 我能为测试数据库文档做什么贡献？ 你可以在提升 TiDB 文档质量、易用性、维护效率、翻译效率等方面做贡献，比如： diff --git a/README.md b/README.md index 859a99cc5792..29b0b76cea73 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# TiDB 文档 +# 测试数据库文档 欢迎来到 [TiDB](https://github.com/pingcap/tidb) 文档仓库！ @@ -8,7 +8,7 @@ 如果你想在本地定制输出符合特定场景需求的 PDF 格式的 TiDB 文档，例如对 TiDB 文档目录进行自由排序和删减，请参考[自助生成 TiDB 文档 PDF 教程](/resources/tidb-pdf-generation-tutorial.md)。 -## TiDB 文档维护方式及版本说明 +## 测试数据库文档维护方式及版本说明 目前，TiDB 的文档维护在以下 branch，对应着官网文档的不同版本： diff --git a/accelerated-table-creation.md b/accelerated-table-creation.md index 8dc306dcff4c..26322a1fefa4 100644 --- a/accelerated-table-creation.md +++ b/accelerated-table-creation.md @@ -3,7 +3,7 @@ title: 提升 TiDB 建表性能 summary: 介绍 TiDB 加速建表中的概念、原理、实现和影响。 --- -# 提升 TiDB 建表性能 +# 提升测试数据库建表性能 TiDB v7.6.0 引入了系统变量 [`tidb_ddl_version`](https://docs.pingcap.com/zh/tidb/v7.6/system-variables#tidb_ddl_version-从-v760-版本开始引入) 实现支持加速建表，可提升大批量建表的速度。从 v8.0.0 开始，该系统变量更名为 [`tidb_enable_fast_create_table`](/system-variables.md#tidb_enable_fast_create_table-从-v800-版本开始引入)。 @@ -11,7 +11,7 @@ TiDB v7.6.0 引入了系统变量 [`tidb_ddl_version`](https://docs.pingcap.com/ 合并后的批量建表语句在同一个事务内执行，如果其中一个语句失败，所有语句都会失败。 -## 与 TiDB 工具的兼容性 +## 与测试数据库工具的兼容性 - 在 TiDB v8.3.0 之前的版本中，[TiCDC](/ticdc/ticdc-overview.md) 不支持同步通过 TiDB 加速创建的表。从 v8.3.0 开始，TiCDC 可以正常同步这类表。 diff --git a/alert-rules.md b/alert-rules.md index 7dccc166eda6..950dd48295e9 100644 --- a/alert-rules.md +++ b/alert-rules.md @@ -3,7 +3,7 @@ title: TiDB 集群报警规则 summary: TiDB 集群中各组件的报警规则详解。 --- -# TiDB 集群报警规则 +# 测试数据库集群报警规则 本文介绍了 TiDB 集群中各组件的报警规则，包括 TiDB、TiKV、PD、TiFlash、TiCDC、Node_exporter 和 Blackbox_exporter 的各报警项的规则描述及处理方法。 @@ -15,7 +15,7 @@ summary: TiDB 集群中各组件的报警规则详解。 | 严重级别 | 服务可用性下降，需要用户密切关注异常指标 | | 警告级别 | 对某一问题或错误的提醒 | -## TiDB 报警规则 +## 测试数据库报警规则 本节介绍了 TiDB 组件的报警项。 diff --git a/analyze-slow-queries.md b/analyze-slow-queries.md index 8005c593560e..3028b51662c9 100644 --- a/analyze-slow-queries.md +++ b/analyze-slow-queries.md @@ -159,7 +159,7 @@ mysql> explain analyze select count(*) from t where a=(select max(t1.a) from t t 可以看到有 1 个子查询被提前执行，花费了 `7.76s`。 -### TiDB 执行慢 +### 测试数据库执行慢 这里我们假设 TiDB 的执行计划正确（不正确的情况在[分析优化器问题](#分析优化器问题)这一节中说明），但是执行上很慢； diff --git a/auto-increment.md b/auto-increment.md index 0894b3efac63..3c6ec80bbdb9 100644 --- a/auto-increment.md +++ b/auto-increment.md @@ -9,7 +9,7 @@ summary: 介绍 TiDB 的 `AUTO_INCREMENT` 列属性。 > **注意：** > -> 使用 `AUTO_INCREMENT` 可能会给生产环境带热点问题，因此推荐使用 [`AUTO_RANDOM`](/auto-random.md) 代替。详情请参考 [TiDB 热点问题处理](/troubleshoot-hot-spot-issues.md#tidb-热点问题处理)。 +> 使用 `AUTO_INCREMENT` 可能会给生产环境带热点问题，因此推荐使用 [`AUTO_RANDOM`](/auto-random.md) 代替。详情请参考 [测试数据库热点问题处理](/troubleshoot-hot-spot-issues.md#测试数据库热点问题处理)。 在 [`CREATE TABLE`](/sql-statements/sql-statement-create-table.md) 语句中也可以使用 `AUTO_INCREMENT` 参数来指定自增字段的初始值。 diff --git a/auto-random.md b/auto-random.md index 84bf027cce63..886980e31d1d 100644 --- a/auto-random.md +++ b/auto-random.md @@ -27,7 +27,7 @@ CREATE TABLE t (a BIGINT AUTO_RANDOM(5, 54), b VARCHAR(255), PRIMARY KEY (a)); CREATE TABLE t (a BIGINT AUTO_RANDOM(5, 54), b VARCHAR(255), PRIMARY KEY (a, b)); ``` -`AUTO_RANDOM` 关键字可以被包裹在 TiDB 可执行注释中，注释语法请参考 [TiDB 可执行注释](/comment-syntax.md#tidb-可执行的注释语法)。 +`AUTO_RANDOM` 关键字可以被包裹在 TiDB 可执行注释中，注释语法请参考 [测试数据库可执行注释](/comment-syntax.md#测试数据库可执行的注释语法)。 ```sql CREATE TABLE t (a bigint /*T![auto_rand] AUTO_RANDOM */, b VARCHAR(255), PRIMARY KEY (a)); diff --git a/basic-features.md b/basic-features.md index 8eb2b0eef0ae..8a5dec791e5b 100644 --- a/basic-features.md +++ b/basic-features.md @@ -3,7 +3,7 @@ title: TiDB 功能概览 summary: 了解 TiDB 的功能概览。 --- -# TiDB 功能概览 +# 测试数据库功能概览 本文列出了 TiDB 功能在不同版本中的支持变化情况，包括[长期支持版本 (LTS)](/releases/versioning.md#长期支持版本) 和最新的 LTS 版本之后的[开发里程碑版本 (DMR)](/releases/versioning.md#开发里程碑版本)。 diff --git a/benchmark/benchmark-sysbench-v2.md b/benchmark/benchmark-sysbench-v2.md index ef5ce303a384..7c9a47f8c9a4 100644 --- a/benchmark/benchmark-sysbench-v2.md +++ b/benchmark/benchmark-sysbench-v2.md @@ -30,7 +30,7 @@ IDC 机器 ## 测试方案 -### TiDB 版本信息 +### 测试数据库版本信息 ### v1.0.8 diff --git a/benchmark/benchmark-sysbench-v3.md b/benchmark/benchmark-sysbench-v3.md index 30c8f7050118..88985e56e283 100644 --- a/benchmark/benchmark-sysbench-v3.md +++ b/benchmark/benchmark-sysbench-v3.md @@ -34,7 +34,7 @@ Sysbench 版本：1.1.0 使用 Sysbench 向集群导入 **16 张表，每张数据 1000 万**。通过 HAProxy 代理，分别以递增并发数向集群发送请求，单次并发测试时间 5 分钟。 -### TiDB 版本信息 +### 测试数据库版本信息 ### v2.1.0-rc.2 @@ -52,7 +52,7 @@ Sysbench 版本：1.1.0 | TiKV | 57c83dc4ebc93d38d77dc8f7d66db224760766cc | | PD | b64716707b7279a4ae822be767085ff17b5f3fea | -### TiDB 参数配置 +### 测试数据库参数配置 两版本 TiDB 均使用**默认配置**。 diff --git a/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md b/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md index a45240256eb9..f1075f528f31 100644 --- a/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md +++ b/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md @@ -33,7 +33,7 @@ summary: TiDB v5.1.0 在 OLTP 场景下的 Sysbench 性能表现对比 v5.0.2。 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -63,7 +63,7 @@ pessimistic-txn.pipelined: true server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md b/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md index e7c4769ac2fe..b39458914047 100644 --- a/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md +++ b/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md @@ -33,7 +33,7 @@ summary: TiDB v5.2.0 在 OLTP 场景下的 Sysbench 性能对比测试显示，P 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -63,7 +63,7 @@ pessimistic-txn.pipelined: true server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md b/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md index 6ab0cb0d16d2..7deb7a9ed790 100644 --- a/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md +++ b/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md @@ -33,7 +33,7 @@ summary: TiDB v5.3.0 和 v5.2.2 在 OLTP 场景下的 Sysbench 性能对比测 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -62,7 +62,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md b/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md index edf021fb5224..fd60ec76a3f1 100644 --- a/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md +++ b/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md @@ -33,7 +33,7 @@ summary: TiDB v5.4.0 在 OLTP 场景下的 Sysbench 性能比 v5.3.0 有所提 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -62,7 +62,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md b/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md index 4a9ea0df0ebc..72105f82d251 100644 --- a/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md +++ b/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.0.0 在 OLTP 场景下的 Sysbench 性能表现对比 v5.4.0。 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -59,7 +59,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md b/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md index 3b8953af1e02..8bef1b58ad76 100644 --- a/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md +++ b/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.1.0 在 OLTP 场景下的 Sysbench 性能表现优于 v6.0.0。 两个版本使用相同的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -56,7 +56,7 @@ server.grpc-concurrency: 6 readpool.storage.normal-concurrency: 10 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md b/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md index 37c4b5ae941f..3346893862c0 100644 --- a/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md +++ b/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.2.0 和 v6.1.0 在 OLTP 场景下的 Sysbench 性能对比测 两个版本使用相同的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -56,7 +56,7 @@ server.grpc-concurrency: 6 readpool.unified.max-thread-count: 10 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-tidb-using-ch.md b/benchmark/benchmark-tidb-using-ch.md index d652ae304764..8ffbd7f995bf 100644 --- a/benchmark/benchmark-tidb-using-ch.md +++ b/benchmark/benchmark-tidb-using-ch.md @@ -3,7 +3,7 @@ title: 如何对 TiDB 进行 CH-benCHmark 测试 summary: 本文介绍如何对 TiDB 进行 CH-benCHmark 测试。 --- -# 如何对 TiDB 进行 CH-benCHmark 测试 +# 如何对测试数据库进行 CH-benCHmark 测试 本文介绍如何对 TiDB 进行 CH-benCHmark 测试。 diff --git a/benchmark/benchmark-tidb-using-sysbench.md b/benchmark/benchmark-tidb-using-sysbench.md index a12be2bcf992..b9218c0e0ea8 100644 --- a/benchmark/benchmark-tidb-using-sysbench.md +++ b/benchmark/benchmark-tidb-using-sysbench.md @@ -9,7 +9,7 @@ summary: 使用 Sysbench 1.0 或更新版本测试 TiDB 性能。调整 TiDB 和 ## 测试方案 -### TiDB 配置 +### 测试数据库配置 升高日志级别，可以减少打印日志数量，对 TiDB 的性能有积极影响。具体在 TiUP 配置文件中加入： @@ -182,7 +182,7 @@ TiKV 的其他模块，如 storage readpool、coprocessor 和 gRPC 的最大并 通过 Grafana 的 TiKV Thread CPU 监控面板可以观察到其实际使用率。如出现多线程模块瓶颈，可以通过增加该模块并发度进行调整。 -### 在高并发压力下，TiKV 也未达到 CPU 使用瓶颈，为什么 TiDB 的 CPU 利用率依然很低？ +### 在高并发压力下，TiKV 也未达到 CPU 使用瓶颈，为什么测试数据库的 CPU 利用率依然很低？ 在某些高端设备上，使用的是 NUMA 架构的 CPU，跨 CPU 访问远端内存将极大降低性能。TiDB 默认将使用服务器所有 CPU，goroutine 的调度不可避免地会出现跨 CPU 内存访问。 diff --git a/benchmark/benchmark-tidb-using-tpcc.md b/benchmark/benchmark-tidb-using-tpcc.md index b53217be3696..cf0020fa37d7 100644 --- a/benchmark/benchmark-tidb-using-tpcc.md +++ b/benchmark/benchmark-tidb-using-tpcc.md @@ -3,7 +3,7 @@ title: 如何对 TiDB 进行 TPC-C 测试 summary: 本文介绍了如何对 TiDB 进行 TPC-C 测试。TPC-C 是一个对 OLTP 系统进行测试的规范，使用商品销售模型对系统进行测试，包含五类事务：NewOrder、Payment、OrderStatus、Delivery、StockLevel。测试使用 tpmC 值衡量系统最大有效吞吐量，以 NewOrder Transaction 为准。使用 go-tpc 进行测试实现，通过 TiUP 命令下载测试程序。测试包括数据导入、运行测试和清理测试数据。 --- -# 如何对 TiDB 进行 TPC-C 测试 +# 如何对测试数据库进行 TPC-C 测试 本文介绍如何对 TiDB 进行 [TPC-C](http://www.tpc.org/tpcc/) 测试。 diff --git a/benchmark/benchmark-tpch.md b/benchmark/benchmark-tpch.md index d9bd01120f39..996edd48cdfa 100644 --- a/benchmark/benchmark-tpch.md +++ b/benchmark/benchmark-tpch.md @@ -53,7 +53,7 @@ summary: TiDB TPC-H 50G 性能测试报告显示，TiDB 2.0 在大部分查询 | 172.16.31.10 | PD \* 1 | | 172.16.31.4 | TiDB \* 1 | -### TiDB 版本信息 +### 测试数据库版本信息 TiDB 1.0: diff --git a/benchmark/online-workloads-and-add-index-operations.md b/benchmark/online-workloads-and-add-index-operations.md index 1a894ee40b48..c547d8fdca47 100644 --- a/benchmark/online-workloads-and-add-index-operations.md +++ b/benchmark/online-workloads-and-add-index-operations.md @@ -31,7 +31,7 @@ TiDB 版本：v3.0.1 Sysbench 版本：1.0.17 -### TiDB 参数配置 +### 测试数据库参数配置 TiDB、TiKV 和 PD 均使用 [TiDB Operator](https://github.com/pingcap/tidb-operator) 默认配置。 diff --git a/benchmark/v3.0-performance-benchmarking-with-sysbench.md b/benchmark/v3.0-performance-benchmarking-with-sysbench.md index de7ed220039f..b0cb3504c8d8 100644 --- a/benchmark/v3.0-performance-benchmarking-with-sysbench.md +++ b/benchmark/v3.0-performance-benchmarking-with-sysbench.md @@ -70,7 +70,7 @@ sysbench $testname \ run --tables=16 --table-size=10000000 ``` -### TiDB 版本信息 +### 测试数据库版本信息 ### v3.0.0 @@ -88,7 +88,7 @@ sysbench $testname \ | TiKV | `b3cf3c8d642534ea6fa93d475a46da285cc6acbf` | | PD | `886362ebfb26ef0834935afc57bcee8a39c88e54` | -### TiDB 参数配置 +### 测试数据库参数配置 2.1 和 3.0 中开启 prepared plan cache（出于优化考虑，2.1 的 point select 与 read write 并未开启）： diff --git a/benchmark/v3.0-performance-benchmarking-with-tpcc.md b/benchmark/v3.0-performance-benchmarking-with-tpcc.md index b01fa9692b8a..8c6d6673c797 100644 --- a/benchmark/v3.0-performance-benchmarking-with-tpcc.md +++ b/benchmark/v3.0-performance-benchmarking-with-tpcc.md @@ -40,7 +40,7 @@ git clone -b 5.0-mysql-support-opt https://github.com/pingcap/benchmarksql.git 使用 BenchmarkSQL 向集群导入 **1000 warehouse** 的数据。通过 HAProxy 代理，分别以递增并发数向集群发送请求，单次并发测试时间 10 分钟。 -### TiDB 版本信息 +### 测试数据库版本信息 ### v3.0.0 @@ -58,7 +58,7 @@ git clone -b 5.0-mysql-support-opt https://github.com/pingcap/benchmarksql.git | TiKV | b3cf3c8d642534ea6fa93d475a46da285cc6acbf | | PD | 886362ebfb26ef0834935afc57bcee8a39c88e54 | -### TiDB 参数配置 +### 测试数据库参数配置 ```toml [log] diff --git a/benchmark/v5.1-performance-benchmarking-with-tpcc.md b/benchmark/v5.1-performance-benchmarking-with-tpcc.md index 8a523f3cf0a3..48f3ec9bdaca 100644 --- a/benchmark/v5.1-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.1-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.1.0 在 TPC-C 性能上提升了 2.8%，测试环境为 AWS EC2 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -65,7 +65,7 @@ storage.scheduler-worker-pool-size: 20 server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.2-performance-benchmarking-with-tpcc.md b/benchmark/v5.2-performance-benchmarking-with-tpcc.md index f82f66b87c69..75b3017a2b02 100644 --- a/benchmark/v5.2-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.2-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.2.0 在 TPC-C 性能上下降了 4.22%，测试环境为 AWS EC 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -65,7 +65,7 @@ storage.scheduler-worker-pool-size: 20 server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.3-performance-benchmarking-with-tpcc.md b/benchmark/v5.3-performance-benchmarking-with-tpcc.md index 2130833a9c44..de98a300e2e2 100644 --- a/benchmark/v5.3-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.3-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.3.0 在 TPC-C 性能上略下降了 2.99%，与 v5.2.2 相比 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -64,7 +64,7 @@ server.grpc-concurrency: 6 storage.scheduler-worker-pool-size: 20 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.4-performance-benchmarking-with-tpcc.md b/benchmark/v5.4-performance-benchmarking-with-tpcc.md index 3831300d64f6..c5166fbaf765 100644 --- a/benchmark/v5.4-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.4-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.4.0 在 TPC-C 性能上提升了 3.16%，测试结果显示不 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -64,7 +64,7 @@ server.grpc-concurrency: 6 storage.scheduler-worker-pool-size: 20 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.0-performance-benchmarking-with-tpcc.md b/benchmark/v6.0-performance-benchmarking-with-tpcc.md index 033c382ddc37..0d5207654bd3 100644 --- a/benchmark/v6.0-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.0-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.0.0 在 TPC-C 性能上比 v5.4.0 提升了 24.20%，表现更 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -61,7 +61,7 @@ rocksdb.max-background-jobs: 8 server.grpc-concurrency: 6 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.1-performance-benchmarking-with-tpcc.md b/benchmark/v6.1-performance-benchmarking-with-tpcc.md index 045caf09cc99..93c316367adf 100644 --- a/benchmark/v6.1-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.1-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.1.0 在 TPC-C 性能上平均提升了 2.85%，分别为：50 两个版本使用同样的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -57,7 +57,7 @@ readpool.storage.normal-concurrency: 10 server.grpc-concurrency: 6 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.2-performance-benchmarking-with-tpcc.md b/benchmark/v6.2-performance-benchmarking-with-tpcc.md index 0b83fbe7e552..9f85e2c0418d 100644 --- a/benchmark/v6.2-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.2-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.2.0 在 TPC-C 性能测试中相比 v6.1.0 下降了 2.00%， 两个版本使用同样的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -57,7 +57,7 @@ readpool.storage.normal-concurrency: 10 server.grpc-concurrency: 6 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/best-practices-for-security-configuration.md b/best-practices-for-security-configuration.md index daca3966fd3e..a8ce9940848c 100644 --- a/best-practices-for-security-configuration.md +++ b/best-practices-for-security-configuration.md @@ -3,7 +3,7 @@ title: TiDB 安全配置最佳实践 summary: 介绍 TiDB 安全配置的最佳实践，帮助你降低潜在的安全风险。 --- -# TiDB 安全配置最佳实践 +# 测试数据库安全配置最佳实践 TiDB 的安全性对于保护数据完整性和机密性至关重要。本文提供了 TiDB 集群部署时的安全配置指南。遵循这些最佳实践可以有效降低潜在安全风险、防范数据泄露，并确保 TiDB 数据库系统能够持续稳定、可靠地运行。 @@ -118,6 +118,6 @@ sudo iptables -P INPUT DROP ## 解决第三方扫描器 MySQL 漏洞误报 -大多数漏洞扫描器在检测 MySQL 漏洞时，会根据版本信息来匹配 CVE 漏洞。由于 TiDB 仅兼容 MySQL 协议而非 MySQL 本身，基于版本信息的漏洞扫描可能导致误报。建议漏洞扫描应以原理扫描为主。当合规漏洞扫描工具要求 MySQL 版本时，你可以[修改服务器版本号](/faq/high-reliability-faq.md#我们的安全漏洞扫描工具对-mysql-version-有要求tidb-是否支持修改-server-版本号呢)，以满足其要求。 +大多数漏洞扫描器在检测 MySQL 漏洞时，会根据版本信息来匹配 CVE 漏洞。由于 TiDB 仅兼容 MySQL 协议而非 MySQL 本身，基于版本信息的漏洞扫描可能导致误报。建议漏洞扫描应以原理扫描为主。当合规漏洞扫描工具要求 MySQL 版本时，你可以[修改服务器版本号](/faq/high-reliability-faq.md#我们的安全漏洞扫描工具对-mysql-version-有要求测试数据库是否支持修改-server-版本号呢)，以满足其要求。 通过修改服务器版本号，可避免漏洞扫描器产生误报。[`server-version`](/tidb-configuration-file.md#server-version) 的值会被 TiDB 节点用于验证当前 TiDB 的版本。在进行 TiDB 集群升级前，请将 `server-version` 的值设置为空或者当前 TiDB 真实的版本值，避免出现非预期行为。 diff --git a/best-practices-on-public-cloud.md b/best-practices-on-public-cloud.md index 619ffc0e0e7f..36f5f02a9bf1 100644 --- a/best-practices-on-public-cloud.md +++ b/best-practices-on-public-cloud.md @@ -3,7 +3,7 @@ title: 在公有云上部署 TiDB 的最佳实践 summary: 了解在公有云上部署 TiDB 的最佳实践。 --- -# 在公有云上部署 TiDB 的最佳实践 +# 在公有云上部署测试数据库的最佳实践 随着公有云基础设施的普及，越来越多的用户选择在公有云上部署和管理 TiDB。然而，要想在公有云上充分发挥 TiDB 的性能，需要关注多个方面，包括性能优化、成本控制、系统可靠性和可扩展性。 @@ -160,7 +160,7 @@ Google Cloud 的[实时迁移功能](https://cloud.google.com/compute/docs/insta 通过使用该监控脚本，并在维护事件期间采取必要的措施，TiDB 集群可以更好地应对 Google Cloud 上的实时迁移事件，确保对查询处理和响应时间的影响最小以及系统的平稳运行。 -## 为具有高 QPS 的大规模 TiDB 集群优化 PD 性能 +## 为具有高 QPS 的大规模测试数据库集群优化 PD 性能 在 TiDB 集群中，一个活跃的 Placement Driver (PD) Server 承担着许多关键任务，例如处理提供 TSO (Timestamp Oracle) 和处理请求。然而，依赖单个活跃 PD Server 可能会限制 TiDB 集群的扩展性。 @@ -183,7 +183,7 @@ Google Cloud 的[实时迁移功能](https://cloud.google.com/compute/docs/insta tso-update-physical-interval = "10ms" # 默认值为 50ms ``` -#### 调整 TiDB 全局变量 +#### 调整测试数据库全局变量 除了 PD 配置外，启用 TSO 客户端攒批操作的等待功能可以进一步优化 TSO 客户端的行为。要启用此功能，可以将全局变量 [`tidb_tso_client_batch_max_wait_time`](/system-variables.md#tidb_tso_client_batch_max_wait_time-从-v530-版本开始引入) 设置为非零值： diff --git a/best-practices/grafana-monitor-best-practices.md b/best-practices/grafana-monitor-best-practices.md index 6fda9d06ece0..64afd2ffb41b 100644 --- a/best-practices/grafana-monitor-best-practices.md +++ b/best-practices/grafana-monitor-best-practices.md @@ -3,7 +3,7 @@ title: 使用 Grafana 监控 TiDB 的最佳实践 summary: 了解高效利用 Grafana 监控 TiDB 的七个技巧。 --- -# 使用 Grafana 监控 TiDB 的最佳实践 +# 使用 Grafana 监控测试数据库的最佳实践 [使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)时，如果在拓扑配置中添加了 Grafana 和 Prometheus，会部署一套 [Grafana + Prometheus 的监控平台](/tidb-monitoring-framework.md)，用于收集和展示 TiDB 集群各个组件和机器的 metric 信息。本文主要介绍使用 TiDB 监控的最佳实践，旨在帮助 TiDB 用户高效利用丰富的 metric 信息来分析 TiDB 的集群状态或进行故障诊断。 diff --git a/best-practices/haproxy-best-practices.md b/best-practices/haproxy-best-practices.md index 85879e9a9741..26eb037f6179 100644 --- a/best-practices/haproxy-best-practices.md +++ b/best-practices/haproxy-best-practices.md @@ -3,7 +3,7 @@ title: HAProxy 在 TiDB 中的最佳实践 summary: HAProxy 是 TiDB 中实现负载均衡的最佳实践。它提供 TCP 协议下的负载均衡能力，通过连接 HAProxy 提供的浮动 IP 对数据进行操作，实现 TiDB Server 层的负载均衡。HAProxy 提供高可用性、负载均衡、健康检查、会话保持、SSL 支持和监控统计等核心功能。部署 HAProxy 需要满足一定的硬件和软件要求，配置和启动 HAProxy 后即可实现数据库负载均衡。 --- -# HAProxy 在 TiDB 中的最佳实践 +# HAProxy 在测试数据库中的最佳实践 本文介绍 [HAProxy](https://github.com/haproxy/haproxy) 在 TiDB 中的最佳配置和使用方法。HAProxy 提供 TCP 协议下的负载均衡能力，TiDB 客户端通过连接 HAProxy 提供的浮动 IP 即可对数据进行操作，实现 TiDB Server 层的负载均衡。 diff --git a/best-practices/high-concurrency-best-practices.md b/best-practices/high-concurrency-best-practices.md index e738aac014a4..9738cfac9dc2 100644 --- a/best-practices/high-concurrency-best-practices.md +++ b/best-practices/high-concurrency-best-practices.md @@ -3,7 +3,7 @@ title: TiDB 高并发写入场景最佳实践 summary: 了解 TiDB 在高并发写入场景下的最佳实践。 --- -# TiDB 高并发写入场景最佳实践 +# 测试数据库高并发写入场景最佳实践 在 TiDB 的使用过程中，一个典型场景是高并发批量写入数据到 TiDB。本文阐述了该场景中的常见问题，旨在给出一个业务的最佳实践，帮助读者避免因使用 TiDB 不当而影响业务开发。 @@ -26,7 +26,7 @@ summary: 了解 TiDB 在高并发写入场景下的最佳实践。 对于分布式数据库来说，除了本身的基础性能外，最重要的就是充分利用所有节点能力，避免让单个节点成为瓶颈。 -## TiDB 数据分布原理 +## 测试数据库数据分布原理 如果要解决以上挑战，需要从 TiDB 数据切分以及调度的原理开始讲起。这里只作简单说明，详情可参阅[谈调度](https://pingcap.com/blog-cn/tidb-internal-3/)。 diff --git a/best-practices/java-app-best-practices.md b/best-practices/java-app-best-practices.md index eb44c002eb9b..f657f1e78371 100644 --- a/best-practices/java-app-best-practices.md +++ b/best-practices/java-app-best-practices.md @@ -3,7 +3,7 @@ title: 开发 Java 应用使用 TiDB 的最佳实践 summary: 本文介绍了开发 Java 应用程序使用 TiDB 的常见问题与解决办法。TiDB 是高度兼容 MySQL 协议的数据库，基于 MySQL 开发的 Java 应用的最佳实践也多适用于 TiDB。 --- -# 开发 Java 应用使用 TiDB 的最佳实践 +# 开发 Java 应用使用测试数据库的最佳实践 本文主要介绍如何开发 Java 应用程序以更好地使用 TiDB，包括开发中的常见问题与最佳实践。 diff --git a/best-practices/readonly-nodes.md b/best-practices/readonly-nodes.md index c43f1fbb3093..10af0000abba 100644 --- a/best-practices/readonly-nodes.md +++ b/best-practices/readonly-nodes.md @@ -107,7 +107,7 @@ tikv_servers: ### 3. 使用 Follower Read 功能读取只读节点 -#### 3.1 在 TiDB 中使用 Follower Read +#### 3.1 在测试数据库中使用 Follower Read 你可以将系统变量 [`tidb_replica_read`](/system-variables.md#tidb_replica_read-从-v40-版本开始引入) 设置为 `learner` 来读取只读节点上的数据： diff --git a/best-practices/three-dc-local-read.md b/best-practices/three-dc-local-read.md index 00209d00e2d6..3788543a36f1 100644 --- a/best-practices/three-dc-local-read.md +++ b/best-practices/three-dc-local-read.md @@ -7,7 +7,7 @@ summary: 了解通过 Stale Read 功能在三数据中心下就近读取数据 在三数据中心模式下，Region 的三个副本都会隔离在各个数据中心里。然而在强一致读的要求下，TiDB 的每一个查询都需要访问对应数据的 Leader 副本，而查询的来源可能和 Leader 所在的数据中心不一致，这就会引起跨数据中心的数据访问，从而造成访问的延迟上升。本文主要介绍使用 [Stale Read](/stale-read.md) 功能，以牺牲数据实时性的方式，避免跨数据中心的访问，从而降低访问的延迟。 -## 部署三数据中心的 TiDB 集群 +## 部署三数据中心的测试数据库集群 部署三数据中心的方法，参考[同城多数据中心部署 TiDB](/multi-data-centers-in-one-city-deployment.md)。 diff --git a/best-practices/three-nodes-hybrid-deployment.md b/best-practices/three-nodes-hybrid-deployment.md index 4b07847ff3df..44f9cf2c419b 100644 --- a/best-practices/three-nodes-hybrid-deployment.md +++ b/best-practices/three-nodes-hybrid-deployment.md @@ -114,7 +114,7 @@ tiup ctl:v tikv --host=${ip:port} modify-tikv-config -n gc.max_ > > 对于更新频繁的业务场景，限制 GC 流量可能会导致 MVCC 版本堆积，进而影响读取性能。所以这个参数的取值需要进行多次尝试，在性能抖动和性能衰退之间找一个比较平衡的取值。 -### TiDB 参数调整 +### 测试数据库参数调整 一般通过系统变量调整 TiDB 执行算子的优化参数，例如 `tidb_hash_join_concurrency`、`tidb_index_lookup_join_concurrency` 等。 diff --git a/best-practices/tidb-best-practices.md b/best-practices/tidb-best-practices.md index d917546b41ad..60155f27541c 100644 --- a/best-practices/tidb-best-practices.md +++ b/best-practices/tidb-best-practices.md @@ -3,7 +3,7 @@ title: TiDB 最佳实践 summary: TiDB 最佳实践总结了使用 TiDB 的一些优化技巧，包括 Raft 一致性协议、分布式事务、数据分片、负载均衡、SQL 到 KV 的映射方案、二级索引的实现方法等。建议阅读官方文档和知乎专栏了解更多细节。部署时推荐使用 TiUP，导入数据时可对 TiKV 参数进行调优。在写入和查询时需注意事务大小限制和并发度设置。监控系统和日志查看也是了解系统状态的重要方法。适用场景包括数据量大、不希望做 Sharding、需要事务和强一致性等。 --- -# TiDB 最佳实践 +# 测试数据库最佳实践 本文档总结使用 TiDB 时的一些最佳实践，主要涉及 SQL 使用和 OLAP/OLTP 优化技巧，特别是一些 TiDB 专有的优化开关。 @@ -187,7 +187,7 @@ TiDB [使用 Grafana + Prometheus 监控系统状态](/tidb-monitoring-framework + 知乎专栏：[TiDB 的后花园](https://zhuanlan.zhihu.com/newsql) + [官方博客](https://pingcap.com/blog-cn/) -## TiDB 的最佳适用场景 +## 测试数据库的最佳适用场景 简单来说，TiDB 适合具备下面这些特点的场景： diff --git a/binary-package.md b/binary-package.md index bbc355251a4a..4298d7a95c65 100644 --- a/binary-package.md +++ b/binary-package.md @@ -3,7 +3,7 @@ title: TiDB 离线包 summary: 了解 TiDB 离线包及其包含的内容。 --- -# TiDB 离线包 +# 测试数据库离线包 在[使用 TiUP 离线部署 TiDB](/production-deployment-using-tiup.md#离线部署) 前，你需要在[官方下载页面](https://cn.pingcap.com/product-community/)选择对应版本的 TiDB server 离线镜像包（包含 TiUP 离线组件包）。 diff --git a/br/backup-and-restore-design.md b/br/backup-and-restore-design.md index 2bf7d685d97b..7e07409e3f6c 100644 --- a/br/backup-and-restore-design.md +++ b/br/backup-and-restore-design.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复功能架构概述 summary: 了解 TiDB 的备份与恢复功能的架构设计。 --- -# TiDB 备份与恢复功能架构概述 +# 测试数据库备份与恢复功能架构概述 正如 [TiDB 备份与恢复概述](/br/backup-and-restore-overview.md)所介绍，TiDB 备份恢复功能包含了多种不同类型的集群数据对象的备份与恢复实现。这些功能都以 Backup & Restore (BR) 和 TiDB Operator 为使用入口，创建相应的任务从 TiKV 节点上备份数据，或者恢复数据到 TiKV 节点。 diff --git a/br/backup-and-restore-overview.md b/br/backup-and-restore-overview.md index 4d58e2cfec8e..b735a9463457 100644 --- a/br/backup-and-restore-overview.md +++ b/br/backup-and-restore-overview.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复概述 summary: 了解不同场景下如何使用 TiDB 的备份与恢复功能，以及不同功能、版本间的兼容性。 --- -# TiDB 备份与恢复概述 +# 测试数据库备份与恢复概述 基于 Raft 协议和合理的部署拓扑规划，TiDB 实现了集群的高可用，当集群中少数节点挂掉时，集群依然能对外提供服务。在此基础上，为了更进一步保证用户数据的安全，TiDB 还提供了集群的备份与恢复 (Backup & Restore, BR) 功能，作为数据安全的最后一道防线，使得集群能够免于严重的自然灾害，提供业务误操作“复原”的能力。 diff --git a/br/backup-and-restore-use-cases.md b/br/backup-and-restore-use-cases.md index 11d9894cb370..a71db907a203 100644 --- a/br/backup-and-restore-use-cases.md +++ b/br/backup-and-restore-use-cases.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复实践示例 summary: 介绍 TiDB 备份与恢复的具体使用示例，包括推荐环境配置、存储配置、备份策略及如何进行备份与恢复。 --- -# TiDB 备份与恢复实践示例 +# 测试数据库备份与恢复实践示例 [TiDB 快照备份与恢复使用指南](/br/br-snapshot-guide.md)及 [TiDB 日志备份与 PITR 使用指南](/br/br-pitr-guide.md)系统介绍了 TiDB 提供的备份与恢复方案，即快照（全量）备份与恢复、日志备份和恢复到指定时间点 (Point-in-time recovery, PITR)。本文档将基于具体的使用场景，介绍如何快速上手使用 TiDB 的备份与恢复方案。 @@ -14,7 +14,7 @@ summary: 介绍 TiDB 备份与恢复的具体使用示例，包括推荐环境 通过 TiDB 提供的 PITR 功能，你可以满足业务团队的需求。 -## 部署 TiDB 集群和 br 命令行工具 +## 部署测试数据库集群和 br 命令行工具 使用 PITR 功能，需要部署 v6.2.0 或以上版本的 TiDB 集群，并且更新 br 命令行工具到与 TiDB 集群相同的版本，本文假设使用的是 v8.5.0 版本。 diff --git a/br/br-incremental-guide.md b/br/br-incremental-guide.md index 57644c845957..183b61a40797 100644 --- a/br/br-incremental-guide.md +++ b/br/br-incremental-guide.md @@ -3,7 +3,7 @@ title: TiDB 增量备份与恢复使用指南 summary: 了解 TiDB 的增量备份与恢复功能使用。 --- -# TiDB 增量备份与恢复使用指南 +# 测试数据库增量备份与恢复使用指南 TiDB 集群增量数据包含在某个时间段的起始和结束两个快照的变化差异的数据，以及之间的 DDL。增量备份的数据相对比全量备份数据而言数据量更小，适合配合快照备份一起使用，减少备份的数据量。进行增量备份的时候，需要保证备份时间范围内的多版本数据没有被 [TiDB GC 机制](/garbage-collection-overview.md)回收。例如，每个小时进行一次增量备份，则需要[调整 TiDB 集群的 GC Lifetime 设置](/system-variables.md#tidb_gc_life_time-从-v50-版本开始引入)至少大于 1 小时。 diff --git a/br/br-log-architecture.md b/br/br-log-architecture.md index 9e3eed959724..82f071b574a7 100644 --- a/br/br-log-architecture.md +++ b/br/br-log-architecture.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 功能架构 summary: 了解 TiDB 的日志备份与 PITR 的架构设计。 --- -# TiDB 日志备份与 PITR 功能架构 +# 测试数据库日志备份与 PITR 功能架构 本文以使用 BR 工具进行备份与恢复为例，介绍 TiDB 集群日志备份与 Point-in-time recovery (PITR) 的架构设计与流程。 diff --git a/br/br-pitr-guide.md b/br/br-pitr-guide.md index e4eb1e10d8f0..7e07299f4397 100644 --- a/br/br-pitr-guide.md +++ b/br/br-pitr-guide.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 使用指南 summary: 了解 TiDB 的日志备份与 PITR 功能使用。 --- -# TiDB 日志备份与 PITR 使用指南 +# 测试数据库日志备份与 PITR 使用指南 全量备份包含集群某个时间点的全量数据，但是不包含其他时间点的更新数据，而 TiDB 日志备份能够将业务写入 TiDB 的数据记录及时备份到指定存储中。如果你需要灵活的选择恢复的时间点，即实现 Point-in-time recovery (PITR)，可以开启[日志备份](#开启日志备份)，并[定期执行快照（全量）备份](#定期执行全量备份)。 diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index df3bb468b7d4..2b916f0f6656 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 命令行手册 summary: 介绍 TiDB 日志备份与 PITR 的命令行。 --- -# TiDB 日志备份与 PITR 命令行手册 +# 测试数据库日志备份与 PITR 命令行手册 本文介绍 TiDB 日志备份和 PITR (Point-in-time recovery) 命令行。 diff --git a/br/br-snapshot-architecture.md b/br/br-snapshot-architecture.md index 800a8e34ab1e..b65b1b86dae2 100644 --- a/br/br-snapshot-architecture.md +++ b/br/br-snapshot-architecture.md @@ -3,7 +3,7 @@ title: TiDB 快照备份与恢复功能架构 summary: 了解 TiDB 快照备份与恢复功能的架构设计。 --- -# TiDB 快照备份与恢复功能架构 +# 测试数据库快照备份与恢复功能架构 本文以使用 BR 工具进行备份与恢复为例，介绍 TiDB 集群快照数据备份和恢复的架构设计与流程。 diff --git a/br/br-snapshot-guide.md b/br/br-snapshot-guide.md index 09f700cefd94..392036d53284 100644 --- a/br/br-snapshot-guide.md +++ b/br/br-snapshot-guide.md @@ -3,7 +3,7 @@ title: TiDB 快照备份与恢复使用指南 summary: 了解如何使用 br 命令行工具进行 TiDB 快照备份与恢复。 --- -# TiDB 快照备份与恢复使用指南 +# 测试数据库快照备份与恢复使用指南 本文介绍如何使用 br 命令行工具进行 TiDB 快照备份和恢复。使用前，请先[安装 br 命令行工具](/br/br-use-overview.md#部署和使用-br)。 diff --git a/br/br-snapshot-manual.md b/br/br-snapshot-manual.md index 73da418d22e7..4ab8bee74ac1 100644 --- a/br/br-snapshot-manual.md +++ b/br/br-snapshot-manual.md @@ -3,12 +3,12 @@ title: TiDB 快照备份与恢复命令行手册 summary: 介绍备份与恢复 TiDB 集群快照的命令行。 --- -# TiDB 快照备份与恢复命令行手册 +# 测试数据库快照备份与恢复命令行手册 本文按备份恢复的场景介绍快照备份和恢复的命令行，包括： - [备份集群快照](#备份集群快照) -- [备份 TiDB 集群指定库表的数据](#备份-tidb-集群指定库表的数据) +- [备份测试数据库集群指定库表的数据](备份测试数据库集群指定库表的数据) - [备份单个数据库的数据](#备份单个数据库的数据) - [备份单张表的数据](#备份单张表的数据) - [使用表库过滤功能备份多张表的数据](#使用表库过滤功能备份多张表的数据) @@ -57,7 +57,7 @@ tiup br backup full \ Full Backup <---------/................................................> 17.12%. ``` -## 备份 TiDB 集群指定库表的数据 +## 备份测试数据库集群指定库表的数据 br 工具支持只备份集群快照和增量数据中指定库或表的局部数据。在快照备份和增量数据备份的基础上，该功能可过滤掉不需要的数据，只备份关键业务的数据。 diff --git a/br/br-use-overview.md b/br/br-use-overview.md index aa260efd00cd..767f9c46ce4d 100644 --- a/br/br-use-overview.md +++ b/br/br-use-overview.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复功能使用概述 summary: 了解如何部署和使用 TiDB 集群的备份与恢复。 --- -# TiDB 备份与恢复功能使用概述 +# 测试数据库备份与恢复功能使用概述 本文介绍使用 TiDB 备份与恢复功能的最佳实践，包括如何选择备份方案、如何管理备份数据，以及如何安装和部署备份恢复工具。 diff --git a/cached-tables.md b/cached-tables.md index 5d9d88abbdf9..33d840d241c3 100644 --- a/cached-tables.md +++ b/cached-tables.md @@ -217,7 +217,7 @@ Query OK, 0 rows affected (0.00 sec) 目前 TiDB 对于每张缓存表的大小限制为 64 MB。如果表的数据超过了 64 MB，执行 `ALTER TABLE t CACHE` 会失败。 -## 与其他 TiDB 功能的兼容性限制 +## 与其他测试数据库功能的兼容性限制 以下是缓存表不支持的功能： @@ -232,7 +232,7 @@ Query OK, 0 rows affected (0.00 sec) - 设置系统变量 `tidb_snapshot` 读取历史数据 - 执行修改操作期间，已有缓存会失效，直到数据被再次加载 -## TiDB 数据迁移工具兼容性 +## 测试数据库数据迁移工具兼容性 缓存表并不是标准的 MySQL 功能，而是 TiDB 扩展。只有 TiDB 能识别 `ALTER TABLE ... CACHE` 语句。所有的 TiDB 数据迁移工具均不支持缓存表功能，包括 Backup & Restore (BR)、TiCDC、Dumpling 等组件，它们会将缓存表当作普通表处理。 diff --git a/certificate-authentication.md b/certificate-authentication.md index ecac63f38f61..c62127c273b0 100644 --- a/certificate-authentication.md +++ b/certificate-authentication.md @@ -3,7 +3,7 @@ title: TiDB 证书鉴权使用指南 summary: 了解使用 TiDB 的证书鉴权功能。 --- -# TiDB 证书鉴权使用指南 +# 测试数据库证书鉴权使用指南 TiDB 支持基于证书鉴权的登录方式。采用这种方式，TiDB 对不同用户签发证书，使用加密连接来传输数据，并在用户登录时验证证书。相比 MySQL 用户常用的用户名密码验证方式，与 MySQL 相兼容的证书鉴权方式更安全，因此越来越多的用户使用证书鉴权来代替用户名密码验证。 @@ -212,11 +212,11 @@ server-cert.pem: OK client-cert.pem: OK ``` -## 配置 TiDB 和客户端使用证书 +## 配置测试数据库和客户端使用证书 在生成证书后，需要在 TiDB 中配置服务端所使用的证书，同时让客户端程序使用客户端证书。 -### 配置 TiDB 服务端 +### 配置测试数据库服务端 修改 TiDB 配置文件中的 `[security]` 段。这一步指定 CA 证书、服务端密钥和服务端证书存放的路径。可将 `path/to/server-cert.pem`、`path/to/server-key.pem` 和 `path/to/ca-cert.pem` 替换成实际的路径。 @@ -487,7 +487,7 @@ CA 证书是客户端和服务端相互校验的依据，所以如果需要替 sudo openssl x509 -req -in server-req.new.pem -days 365000 -CA ca-cert.pem -CAkey ca-key.pem -set_serial 01 -out server-cert.new.pem ``` -3. 配置 TiDB 使用上面新生成的服务端密钥和证书并重启。参见[配置 TiDB 服务端](#配置-tidb-服务端)。 +3. 配置 TiDB 使用上面新生成的服务端密钥和证书并重启。参见[配置测试数据库服务端](配置测试数据库服务端)。 ## 基于策略的证书访问控制 diff --git a/character-set-and-collation.md b/character-set-and-collation.md index eda681ab7b80..4b4a2cfb4471 100644 --- a/character-set-and-collation.md +++ b/character-set-and-collation.md @@ -142,7 +142,7 @@ SHOW COLLATION WHERE Charset = 'utf8mb4'; TiDB 对 GBK 字符集的支持详情见 [GBK](/character-set-gbk.md)。 -## TiDB 中的 `utf8` 和 `utf8mb4` +## 测试数据库中的 `utf8` 和 `utf8mb4` MySQL 限制字符集 `utf8` 为最多 3 个字节。这足以存储在基本多语言平面 (BMP) 中的字符，但不足以存储表情符号 (emoji) 等字符。因此，建议改用字符集`utf8mb4`。 diff --git a/check-before-deployment.md b/check-before-deployment.md index cb4348d8f5b9..8a2b930290d6 100644 --- a/check-before-deployment.md +++ b/check-before-deployment.md @@ -3,7 +3,7 @@ title: TiDB 环境与系统配置检查 summary: 了解部署 TiDB 前的环境检查操作。 --- -# TiDB 环境与系统配置检查 +# 测试数据库环境与系统配置检查 本文介绍部署 TiDB 前的环境检查操作，以下各项操作按优先级排序。 diff --git a/clinic/clinic-collect-sql-query-plan.md b/clinic/clinic-collect-sql-query-plan.md index cc095633c149..8ed34b6a82b9 100644 --- a/clinic/clinic-collect-sql-query-plan.md +++ b/clinic/clinic-collect-sql-query-plan.md @@ -117,6 +117,6 @@ roles = [ diag collect --profile= --explain-sql= ``` -### 将结果导入到 TiDB 集群 +### 将结果导入到测试数据库集群 采集结果中的 `plan_replayer.zip` 可以通过 `PLAN REPLAYER LOAD` 语句直接导入到 TiDB 集群中进行信息查看，具体方法可参考[使用 `PLAN REPLAYER` 导入集群信息](/sql-plan-replayer.md#使用-plan-replayer-导入集群信息) diff --git a/clinic/clinic-data-instruction-for-tiup.md b/clinic/clinic-data-instruction-for-tiup.md index f06d1a5bd525..1d82f4a4b57c 100644 --- a/clinic/clinic-data-instruction-for-tiup.md +++ b/clinic/clinic-data-instruction-for-tiup.md @@ -14,18 +14,18 @@ Clinic Server 是部署在云端的云服务，根据数据存储的位置不同 - [Clinic Server 中国区](https://clinic.pingcap.com.cn)：如果你把采集的数据上传到了 Clinic Server 中国区，这些数据将存储于 PingCAP 设立在 AWS 中国区（北京）的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。 - [Clinic Server 美国区](https://clinic.pingcap.com)：如果你把采集的数据上传到了 Clinic Server 美国区，这些数据将存储于 PingCAP 设立在 AWS 美国区的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。 -## TiDB 集群 +## 测试数据库集群 本节列出了 [Diag](https://github.com/pingcap/diag) 在使用 TiUP 部署的 TiDB 集群中能够采集的诊断数据类型。 -### TiDB 集群信息 +### 测试数据库集群信息 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | | 集群基础信息，包括集群 ID | `cluster.json` | 每次收集默认采集 | | 集群详细信息 | `meta.yaml` | 每次收集默认采集 | -### TiDB 诊断数据 +### 测试数据库诊断数据 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | @@ -80,7 +80,7 @@ Clinic Server 是部署在云端的云服务，根据数据存储的位置不同 | 所有的 Metrics 数据 | `{metric_name}.json` | `--include=monitor` | | Alert 列表 | `alerts.json` | `--include=monitor` | -### TiDB 系统变量 +### 测试数据库系统变量 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | diff --git a/clinic/clinic-user-guide-for-tiup.md b/clinic/clinic-user-guide-for-tiup.md index 916cd028ec9a..c4d947df0a1a 100644 --- a/clinic/clinic-user-guide-for-tiup.md +++ b/clinic/clinic-user-guide-for-tiup.md @@ -119,7 +119,7 @@ summary: 详细介绍在使用 TiUP 部署的 TiDB 集群或 DM 集群上如何 4. 开启日志脱敏配置（可选步骤）。 - TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#tidb-组件日志脱敏)。 + TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#测试数据库组件日志脱敏)。 ## 远程定位集群问题 diff --git a/clinic/quick-start-with-clinic.md b/clinic/quick-start-with-clinic.md index f746e87ab9d4..0fac2dead1e1 100644 --- a/clinic/quick-start-with-clinic.md +++ b/clinic/quick-start-with-clinic.md @@ -104,7 +104,7 @@ PingCAP Clinic 由 [Diag 诊断客户端](https://github.com/pingcap/diag)（以 6. 开启日志脱敏配置（可选步骤）。 - TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#tidb-组件日志脱敏)。 + TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#测试数据库组件日志脱敏)。 ## 体验步骤 diff --git a/clustered-indexes.md b/clustered-indexes.md index a48325ae9fb9..2b0c2f8221e5 100644 --- a/clustered-indexes.md +++ b/clustered-indexes.md @@ -171,7 +171,7 @@ TiDB v5.0 完成了所有类型主键的支持，但默认行为与 TiDB v3.0 TiDB 支持使用可执行注释的语法来包裹 `CLUSTERED` 或 `NONCLUSTERED` 关键字，且 `SHOW CREATE TABLE` 的结果均包含 TiDB 特有的可执行注释，这些注释在 MySQL 或低版本的 TiDB 中会被忽略。 -### TiDB 数据迁移工具兼容性 +### 测试数据库数据迁移工具兼容性 聚簇索引仅与 v5.0 及以后版本的以下数据迁移工具兼容： @@ -180,7 +180,7 @@ TiDB 支持使用可执行注释的语法来包裹 `CLUSTERED` 或 `NONCLUSTERED v5.0 的 BR 不能通过备份恢复将非聚簇索引表转换成聚簇索引表，反之亦然。 -### 与 TiDB 其他特性的兼容性 +### 与测试数据库其他特性的兼容性 在非单整数列作为主键的表中，从非聚簇索引变为聚簇索引之后，在 v5.0 之前版本的 TiDB 能够执行的 `SPLIT TABLE BY/BETWEEN` 语句在 v5.0 及以后版本的 TiDB 上不再可用，原因是行数据键的构成发生了变化。在聚簇索引表上执行 `SPLIT TABLE BY/BETWEEN` 时需要依据主键列指定值，而不是指定一个整数值。例如： diff --git a/command-line-flags-for-tidb-configuration.md b/command-line-flags-for-tidb-configuration.md index c57f49cf029b..1377327d266a 100644 --- a/command-line-flags-for-tidb-configuration.md +++ b/command-line-flags-for-tidb-configuration.md @@ -3,7 +3,7 @@ title: TiDB 配置参数 summary: TiDB 配置参数包括启动参数和环境变量。启动参数包括 advertise-address、config、config-check、config-strict、cors 等。其中默认端口为 4000 和 10080。其他参数包括 log-file、metrics-addr、metrics-interval 等。注意配置文件的有效性和安全模式下的启动。 --- -# TiDB 配置参数 +# 测试数据库配置参数 在启动 TiDB 时，你可以使用命令行参数或环境变量来配置 TiDB。 diff --git a/comment-syntax.md b/comment-syntax.md index 4130d2564883..cf909107a205 100644 --- a/comment-syntax.md +++ b/comment-syntax.md @@ -121,7 +121,7 @@ TiDB 也跟 MySQL 保持一致，支持一种 C 风格注释的变体： 如果注释中指定了 Server 版本号，例如 `/*!50110 KEY_BLOCK_SIZE=1024 */`，在 MySQL 中表示只有 MySQL 的版本大于等于 5.1.10 才会处理这个 comment 中的内容。但是在 TiDB 中，这个 MySQL 版本号不会起作用，所有的 comment 都被会处理。 -## TiDB 可执行的注释语法 +## 测试数据库可执行的注释语法 TiDB 也有独立的注释语法，称为 TiDB 可执行注释语法。主要分为两种： diff --git a/configure-memory-usage.md b/configure-memory-usage.md index 14dda46a8405..51d81a1b439a 100644 --- a/configure-memory-usage.md +++ b/configure-memory-usage.md @@ -3,7 +3,7 @@ title: TiDB 内存控制文档 summary: TiDB 内存控制文档介绍了如何追踪和控制 SQL 查询过程中的内存使用情况，以及配置内存使用阈值和 tidb-server 实例的内存使用阈值。还介绍了使用 INFORMATION_SCHEMA 系统表查看内存使用情况，以及降低写入事务内存使用的方法。另外还介绍了流量控制和数据落盘的内存控制策略，以及通过设置环境变量 GOMEMLIMIT 缓解 OOM 问题。 --- -# TiDB 内存控制文档 +# 测试数据库内存控制文档 目前 TiDB 已经能够做到追踪单条 SQL 查询过程中的内存使用情况，当内存使用超过一定阈值后也能采取一些操作来预防 OOM 或者排查 OOM 原因。你可以使用系统变量 [`tidb_mem_oom_action`](/system-variables.md#tidb_mem_oom_action-从-v610-版本开始引入) 来控制查询超过内存限制后所采取的操作： diff --git a/credits.md b/credits.md index 906d0eae7277..8537d356b243 100644 --- a/credits.md +++ b/credits.md @@ -3,11 +3,11 @@ title: TiDB 社区荣誉列表 summary: 了解 TiDB 社区贡献者列表及角色。 --- -# TiDB 社区荣誉列表 +# 测试数据库社区荣誉列表 每一位贡献者都是推动 TiDB 健壮发展的重要成员，我们感谢所有为 TiDB 提交代码、撰写或翻译文档的贡献者。 -## TiDB 开发者 +## 测试数据库开发者 TiDB 开发者为 TiDB 的新功能开发、性能优化、稳定性保障做出了贡献。以下链接包含了 TiDB 相关 repo 的贡献者名单： @@ -25,7 +25,7 @@ TiDB 开发者为 TiDB 的新功能开发、性能优化、稳定性保障做出 - [tidb-incubator/TiBigData](https://github.com/tidb-incubator/TiBigData/graphs/contributors) - [ti-community-infra](https://github.com/orgs/ti-community-infra/people) -## TiDB 文档写作者和译员 +## 测试数据库文档写作者和译员 TiDB 文档写作者和译员为 TiDB 及相关项目撰写文档、提供翻译。以下链接包含了 TiDB 文档相关 repo 的贡献者名单： diff --git a/dashboard/dashboard-diagnostics-report.md b/dashboard/dashboard-diagnostics-report.md index 8f31ed10328e..73e42da66150 100644 --- a/dashboard/dashboard-diagnostics-report.md +++ b/dashboard/dashboard-diagnostics-report.md @@ -216,7 +216,7 @@ TiDB 内置自动诊断的结果，具体各字段含义以及介绍可以参考 这部分包括了 TiDB/PD/TiKV 更多的具体的监控信息。 -#### TiDB 相关监控信息 +#### 测试数据库相关监控信息 ##### Time Consumed by TiDB Component diff --git a/dashboard/dashboard-ops-security.md b/dashboard/dashboard-ops-security.md index 4c921d52d7b9..6ce2a988ec9f 100644 --- a/dashboard/dashboard-ops-security.md +++ b/dashboard/dashboard-ops-security.md @@ -7,7 +7,7 @@ summary: TiDB Dashboard 需要提高安全性。建议为 `root` 用户设置强 尽管访问 TiDB Dashboard 需要登录，但它被设计为默认供可信的用户实体访问。当你希望将 TiDB Dashboard 提供给外部网络用户或不可信用户访问时，需要注意采取以下措施以避免安全漏洞。 -## 提高 TiDB 用户安全性 +## 提高测试数据库用户安全性 ### 为 `root` 用户设置强密码 diff --git a/ddl-introduction.md b/ddl-introduction.md index 32d810258406..bca75f3dfc51 100644 --- a/ddl-introduction.md +++ b/ddl-introduction.md @@ -60,7 +60,7 @@ ADMIN SHOW DDL; 1 row in set (0.00 sec) ``` -### TiDB 在线 DDL 异步变更的原理 +### 测试数据库在线 DDL 异步变更的原理 TiDB DDL 模块从设计之初就选择了在线异步变更的模式，为 TiDB 的用户提供了不停机变更业务的服务能力。 diff --git a/deploy-monitoring-services.md b/deploy-monitoring-services.md index 4e5724b53e95..ead88d8795ec 100644 --- a/deploy-monitoring-services.md +++ b/deploy-monitoring-services.md @@ -3,7 +3,7 @@ title: 集群监控部署 summary: 本文适用于手动部署 TiDB 监控报警系统的用户。假设 TiDB 的拓扑结构如下：Node1 主机 IP 为 192.168.199.113，服务包括 PD1、TiDB、node_export、Prometheus、Grafana；Node2 主机 IP 为 192.168.199.114，服务包括 PD2、node_export；Node3 主机 IP 为 192.168.199.115，服务包括 PD3、node_export；Node4 主机 IP 为 192.168.199.116，服务包括 TiKV1、node_export；Node5 主机 IP 为 192.168.199.117，服务包括 TiKV2、node_export；Node6 主机 IP 为 192.168.199.118，服务包括 TiKV3、node_export。具体部署步骤包括下载二进制包、启动 node_exporter 服务、启动 Prometheus 服务、启动 Grafana 服务、配置 Grafana 数据源和导入 Grafana 面板。可查看 TiDB Server、PD Server 和 TiKV Server 的监控信息。 --- -# TiDB 集群监控部署 +# 测试数据库集群监控部署 本文档适用于希望手动部署 TiDB 监控报警系统的用户。TiUP 部署方式，会同时自动部署监控报警系统，无需手动部署。 diff --git a/develop/dev-guide-build-cluster-in-cloud.md b/develop/dev-guide-build-cluster-in-cloud.md index 5caf762868f6..2ecd778962af 100644 --- a/develop/dev-guide-build-cluster-in-cloud.md +++ b/develop/dev-guide-build-cluster-in-cloud.md @@ -5,7 +5,7 @@ summary: 使用 TiDB Cloud Serverless 构建 TiDB 集群，并连接 TiDB Cloud -# 使用 TiDB Cloud Serverless 构建 TiDB 集群 +# 使用 TiDB Cloud Serverless 构建测试数据库集群 本文将介绍如何以最快的方式开始使用 TiDB。你将创建并启动一个 [TiDB Cloud Serverless](https://www.pingcap.com/tidb-serverless/) 集群，使用 TiDB SQL 客户端，插入数据。随后将从示例程序读取出数据。 diff --git a/develop/dev-guide-overview.md b/develop/dev-guide-overview.md index 0cc72ac21562..1a64dcab9398 100644 --- a/develop/dev-guide-overview.md +++ b/develop/dev-guide-overview.md @@ -11,15 +11,15 @@ summary: 整体叙述了开发者手册，罗列了开发者手册的大致脉 此外，你还可以通过视频的形式学习免费的 [TiDB SQL 开发在线课程](https://cn.pingcap.com/courses-catalog/category/back-end-developer/?utm_source=docs-cn-dev-guide)。 -## TiDB 基础 +## 测试数据库基础 在你开始使用 TiDB 之前，你需要了解一些关于 TiDB 数据库的一些重要工作机制： - 阅读 [TiDB 事务概览](/transaction-overview.md)来了解 TiDB 的事务运作方式或查看[为应用开发程序员准备的事务说明](/develop/dev-guide-transaction-overview.md)查看应用开发程序员需要了解的事务部分。 - 学习免费在线课程 [TiDB 架构与特点](https://learn.pingcap.com/learner/course/600003/?utm_source=docs-cn-dev-guide)，了解构建 TiDB 分布式数据库集群的核心组件及其概念。 -- 了解[应用程序与 TiDB 交互的方式](#应用程序与-tidb-交互的方式)。 +- 了解[应用程序与测试数据库交互的方式](应用程序与测试数据库交互的方式)。 -## TiDB 事务机制 +## 测试数据库事务机制 TiDB 支持分布式事务，而且提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。TiDB 当前版本中默认采用 **悲观事务** 模式，这让你在 TiDB 事务时可以像使用传统的单体数据库 (如: MySQL) 事务一样。 @@ -29,7 +29,7 @@ TiDB 会为你保证 `BEGIN` 开始到 `COMMIT` 或 `ROLLBACK` 结束间的所 若你不清楚**乐观事务**是什么，请暂时不要使用它。因为使用**乐观事务**的前提是需要应用程序可以正确的处理 `COMMIT` 语句所返回的[所有错误](/error-codes.md)。如果不确定应用程序如何处理，请直接使用**悲观事务**。 -## 应用程序与 TiDB 交互的方式 +## 应用程序与测试数据库交互的方式 TiDB 高度兼容 MySQL 协议，TiDB 支持[大多数 MySQL 的语法及特性](/mysql-compatibility.md)，因此大部分的 MySQL 的连接库都与 TiDB 兼容。如果你的应用程序框架或语言无 PingCAP 的官方适配，那么建议你使用 MySQL 的客户端库。同时，也有越来越多的三方数据库主动支持 TiDB 的差异特性。 diff --git a/develop/dev-guide-proxysql-integration.md b/develop/dev-guide-proxysql-integration.md index 93f1b9d63cbe..360c47a82c8d 100644 --- a/develop/dev-guide-proxysql-integration.md +++ b/develop/dev-guide-proxysql-integration.md @@ -40,7 +40,7 @@ ProxySQL 的设计目标是快速、高效且易于使用。它完全兼容 MySQ 本节介绍如何在开发环境中将 TiDB 与 ProxySQL 集成。在满足[前提条件](#前提条件)的情况下，你可以根据 TiDB 集群类型选择以下选项之一开始集成 ProxySQL： - 选项 1：[集成 TiDB Cloud 与 ProxySQL](#选项-1-集成-tidb-cloud-与-proxysql) -- 选项 2：[集成本地部署的 TiDB 与 ProxySQL](#选项-2-集成本地部署的-tidb-与-proxysql) +- 选项 2：[集成本地部署的测试数据库与 ProxySQL](选项-2-集成本地部署的测试数据库与-proxysql) ### 前提条件 @@ -350,7 +350,7 @@ systemctl start docker comment: ``` -#### 步骤 4. 通过 ProxySQL 连接到 TiDB 集群 +#### 步骤 4. 通过 ProxySQL 连接到测试数据库集群 1. 运行 `proxysql-connect.py` 连接到你的 TiDB 集群。该脚本将自动启动 MySQL 客户端并使用你在[步骤 2](#步骤-2-生成-proxysql-配置文件) 中指定的用户名和密码进行连接。 @@ -427,7 +427,7 @@ systemctl start docker -### 选项 2: 集成本地部署的 TiDB 与 ProxySQL +### 选项 2: 集成本地部署的测试数据库与 ProxySQL 在这个集成中，你将使用 [TiDB](https://hub.docker.com/r/pingcap/tidb) 和 [ProxySQL](https://hub.docker.com/r/proxysql/proxysql) 的 Docker 镜像设置环境。你也可以尝试[其他方式安装 TiDB](/quick-start-with-tidb.md)。 @@ -803,7 +803,7 @@ systemctl start docker > **注意：** > -> 以下步骤使用 TiDB 和 ProxySQL 的容器镜像配置查询规则。如果你还没有拉取这些镜像，请参考[集成本地部署的 TiDB 与 ProxySQL](#选项-2-集成本地部署的-tidb-与-proxysql) 部分的详细步骤。 +> 以下步骤使用 TiDB 和 ProxySQL 的容器镜像配置查询规则。如果你还没有拉取这些镜像，请参考[集成本地部署的测试数据库与 ProxySQL](选项-2-集成本地部署的测试数据库与-proxysql) 部分的详细步骤。 1. 克隆 TiDB 和 ProxySQL 的集成示例代码仓库 [`pingcap-inc/tidb-proxysql-integration`](https://github.com/pingcap-inc/tidb-proxysql-integration)。如果你已经在前面的步骤中克隆了它，请跳过这一步。 diff --git a/develop/dev-guide-third-party-support.md b/develop/dev-guide-third-party-support.md index bd5386062a53..37eaca4328c4 100644 --- a/develop/dev-guide-third-party-support.md +++ b/develop/dev-guide-third-party-support.md @@ -3,7 +3,7 @@ title: TiDB 支持的第三方工具 summary: TiDB 支持的第三方工具主要包括驱动、ORM 框架和 GUI。支持等级分为 Full 和 Compatible，其中 Full 表示绝大多数功能兼容性已得到支持，Compatible 表示大部分功能可使用但未经完整验证。对于支持的 Driver 或 ORM 框架并不包括应用端事务重试和错误处理。如果在使用工具连接 TiDB 时出现问题，可在 GitHub 上提交包含详细信息的 issue 以获得进展。 --- -# TiDB 支持的第三方工具 +# 测试数据库支持的第三方工具 > **注意：** > diff --git a/develop/dev-guide-third-party-tools-compatibility.md b/develop/dev-guide-third-party-tools-compatibility.md index fa9713bcd716..7a60ea887da4 100644 --- a/develop/dev-guide-third-party-tools-compatibility.md +++ b/develop/dev-guide-third-party-tools-compatibility.md @@ -22,7 +22,7 @@ summary: 介绍在测试中发现的 TiDB 与第三方工具的兼容性问题 ## 通用 -### TiDB 中 `SELECT CONNECTION_ID()` 返回结果类型为 64 位整型 +### 测试数据库中 `SELECT CONNECTION_ID()` 返回结果类型为 64 位整型 **描述** @@ -32,7 +32,7 @@ TiDB 中 `SELECT CONNECTION_ID()` 的返回值为 64 位，如 `2199023260887` 在 TiDB 应用程序中，请注意使用各语言的 64 位整型类型（或字符串类型）存储 `SELECT CONNECTION_ID()` 的结果，防止溢出。如 Java 应使用 `Long` 或 `String` 进行接收，JavaScript/TypeScript 应使用 `string` 类型进行接收。 -### TiDB 未设置 `Com_*` 计数器 +### 测试数据库未设置 `Com_*` 计数器 **描述** @@ -42,7 +42,7 @@ MySQL 维护了一系列 [`Com_` 开头的服务端变量](https://dev.mysql.com 请勿使用这样的变量。在 MySQL 中 `Com_*` 常见的使用场景之一是监控。TiDB 的可观测性较为完善，无需从服务端变量进行查询。如需定制监控工具，可阅读 [TiDB 监控框架概述](/tidb-monitoring-framework.md)来获得更多信息。 -### TiDB 错误日志区分 `TIMESTAMP` 与 `DATETIME` 类型 +### 测试数据库错误日志区分 `TIMESTAMP` 与 `DATETIME` 类型 **描述** @@ -52,7 +52,7 @@ TiDB 错误日志区分 `TIMESTAMP` 与 `DATETIME`，而 MySQL 不区分，全 请勿使用错误日志进行字符串匹配，要使用[错误码](/error-codes.md)进行故障诊断。 -### TiDB 不支持 `CHECK TABLE` 语句 +### 测试数据库不支持 `CHECK TABLE` 语句 **描述** diff --git a/develop/dev-guide-tidb-crud-sql.md b/develop/dev-guide-tidb-crud-sql.md index 2108dd10e104..d17aeae84abd 100644 --- a/develop/dev-guide-tidb-crud-sql.md +++ b/develop/dev-guide-tidb-crud-sql.md @@ -3,7 +3,7 @@ title: 使用 TiDB 的增删改查 SQL summary: 简单介绍 TiDB 的增删改查 SQL。 --- -# 使用 TiDB 的增删改查 SQL +# 使用测试数据库的增删改查 SQL 本章将简单介绍 TiDB 的增删改查 SQL 的使用方法。 diff --git a/develop/dev-guide-timeouts-in-tidb.md b/develop/dev-guide-timeouts-in-tidb.md index daaac2d24d6f..87e06325ba91 100644 --- a/develop/dev-guide-timeouts-in-tidb.md +++ b/develop/dev-guide-timeouts-in-tidb.md @@ -3,7 +3,7 @@ title: TiDB 中的各种超时 summary: 简单介绍 TiDB 中的各种超时，为排查错误提供依据。 --- -# TiDB 中的各种超时 +# 测试数据库中的各种超时 本章将介绍 TiDB 中的各种超时，为排查错误提供依据。 diff --git a/develop/dev-guide-use-temporary-tables.md b/develop/dev-guide-use-temporary-tables.md index 4d449aa53a38..95f5d790e9cb 100644 --- a/develop/dev-guide-use-temporary-tables.md +++ b/develop/dev-guide-use-temporary-tables.md @@ -252,7 +252,7 @@ DROP GLOBAL TEMPORARY TABLE top_50_eldest_authors_global; ## 限制 -关于 TiDB 在临时表功能上的一些限制，你可以通过阅读参考文档中的[临时表与其他 TiDB 功能的兼容性限制](/temporary-tables.md#与其他-tidb-功能的兼容性限制)小节进行了解。 +关于 TiDB 在临时表功能上的一些限制，你可以通过阅读参考文档中的[临时表与其他测试数据库功能的兼容性限制](/temporary-tables.md#与其他测试数据库功能的兼容性限制)小节进行了解。 ## 扩展阅读 diff --git a/dm/dm-binlog-event-filter.md b/dm/dm-binlog-event-filter.md index 978a8058b58e..f64e116a4131 100644 --- a/dm/dm-binlog-event-filter.md +++ b/dm/dm-binlog-event-filter.md @@ -138,7 +138,7 @@ filters: action: Do ``` -### 过滤 TiDB 不支持的 SQL 语句 +### 过滤测试数据库不支持的 SQL 语句 可设置如下规则过滤 TiDB 不支持的 `PROCEDURE` 语句： diff --git a/dm/dm-enable-tls.md b/dm/dm-enable-tls.md index c3eb77aca5a5..06e1ea29d93e 100644 --- a/dm/dm-enable-tls.md +++ b/dm/dm-enable-tls.md @@ -107,9 +107,9 @@ DM-master、DM-worker 和 dmctl 都会在每次新建相互通讯的连接时重 ssl-key: "/path/to/mysql-client-key.pem" ``` -### 为下游 TiDB 连接开启加密传输 +### 为下游测试数据库连接开启加密传输 -1. 配置下游 TiDB 启用加密连接支持，具体可参考[配置 TiDB 启用加密连接支持](/enable-tls-between-clients-and-servers.md#配置-tidb-服务端启用安全连接) +1. 配置下游 TiDB 启用加密连接支持，具体可参考[配置测试数据库启用加密连接支持](/enable-tls-between-clients-and-servers.md#配置测试数据库服务端启用安全连接) 2. 在 task 配置文件中设置 TiDB Client 证书： diff --git a/dm/dm-faq.md b/dm/dm-faq.md index 2ef1af2067ba..ac91aa83b859 100644 --- a/dm/dm-faq.md +++ b/dm/dm-faq.md @@ -32,7 +32,7 @@ DM 会尝试将包含多个 DDL 变更操作的单条语句拆分成只包含一 > > TiDB 目前并不兼容 MySQL 支持的所有 DDL 语句。 -## DM 是否会将视图的 DDL 语句和对视图的 DML 语句同步到下游的 TiDB 中？ +## DM 是否会将视图的 DDL 语句和对视图的 DML 语句同步到下游的测试数据库中？ 目前 DM 不会将视图的 DDL 语句同步到下游的 TiDB 集群，也不会将针对视图的 DML 语句同步到下游。 diff --git a/dm/dm-task-configuration-guide.md b/dm/dm-task-configuration-guide.md index f66f3d83a5ab..43e30416d944 100644 --- a/dm/dm-task-configuration-guide.md +++ b/dm/dm-task-configuration-guide.md @@ -29,7 +29,7 @@ mysql-instances: - source-id: "mysql-replica-02" # 从 source-id = mysql-replica-02 的数据源迁移数据 ``` -## 配置迁移的目标 TiDB 集群 +## 配置迁移的目标测试数据库集群 仿照下面的 `target-database:` 示例定义迁移的目标 TiDB 集群。 @@ -119,7 +119,7 @@ target-database: # 目标 TiDB 配置 filter-rules: ["filter-rule-2"] # 过滤数据源特定操作的规则，可以配置多个过滤规则 ``` -## 配置需要数据源表到目标 TiDB 表的映射 +## 配置需要数据源表到目标测试数据库表的映射 如果不需要将数据源表路由到不同名的目标 TiDB 表，可以跳过该项配置。分库分表合并迁移的场景必须配置该规则。 diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index 446492b4782a..44166b3074f4 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -3,11 +3,11 @@ title: TiDB 工具下载 summary: 本文介绍如何下载 TiDB 工具包。TiDB 工具包包含常用工具如 Dumpling、TiDB Lightning、BR 等。如果部署环境能访问互联网，可直接通过 TiUP 命令一键部署所需的 TiDB 工具。操作系统需为 Linux，架构为 amd64 或 arm64。下载步骤包括访问 TiDB 社区版页面，找到 TiDB-community-toolkit 软件包并点击立即下载。注意，点击立即下载后默认下载当前 TiDB 的最新发布版本。根据要使用的工具选择安装对应的离线包。 --- -# TiDB 工具下载 +# 测试数据库工具下载 本文介绍如何下载 TiDB 工具包。关于 TiDB 工具包的内容，请查看 [TiDB 离线包](/binary-package.md)。 -## TiDB 工具包下载 +## 测试数据库工具包下载 TiDB 工具包中包含了一些常用的 TiDB 工具，例如数据导出工具 Dumpling、数据导入工具 TiDB Lightning、备份恢复工具 BR。 @@ -31,7 +31,7 @@ TiDB 工具包中包含了一些常用的 TiDB 工具，例如数据导出工具 > - 如需在 Kubernetes 上部署运维 TiDB，无需下载 TiDB-community-toolkit 软件包，请参考[离线安装 TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tidb-operator#离线安装-tidb-operator)。 > - 如需使用 [PD Control](/pd-control.md) 工具 `pd-ctl`，请下载 **TiDB-community-server 软件包**。 -### TiDB 工具包说明 +### 测试数据库工具包说明 在 TiDB 工具包中，你可以依据要使用的工具，选择安装对应的离线包。 diff --git a/dr-secondary-cluster.md b/dr-secondary-cluster.md index d25c6aefabb5..cdffb96c54df 100644 --- a/dr-secondary-cluster.md +++ b/dr-secondary-cluster.md @@ -22,7 +22,7 @@ summary: 了解如何使用 TiCDC 构建主备集群进行容灾。 同时，本文还介绍了如何在备用集群上进行业务查询，以及如何在主备集群间进行双向同步。 -## 基于 TiCDC 构建 TiDB 主备集群 +## 基于 TiCDC 构建测试数据库主备集群 ### 架构概览 @@ -64,7 +64,7 @@ summary: 了解如何使用 TiCDC 构建主备集群进行容灾。 部署 TiCDC 组件需要注意的是，Secondary Cluster 和 TiCDC 需要在一起部署和管理，并且它们之间的网络需要能够连通。 -- 如果需要在已有的 Primary Cluster 上部署 TiCDC，请参考[部署 TiCDC 组件](/ticdc/deploy-ticdc.md#使用-tiup-在原有-tidb-集群上新增或扩容-ticdc-组件)。 +- 如果需要在已有的 Primary Cluster 上部署 TiCDC，请参考[部署 TiCDC 组件](/ticdc/deploy-ticdc.md#使用-tiup-在原有测试数据库集群上新增或扩容-ticdc-组件)。 - 如果部署全新的 Primary Cluster 和 TiCDC 组件，则可以使用以下 TiUP 部署模版，并按照需要修改配置参数： ```yaml diff --git a/dr-solution-introduction.md b/dr-solution-introduction.md index ecdc783489d4..2c99cb8e3c75 100644 --- a/dr-solution-introduction.md +++ b/dr-solution-introduction.md @@ -3,7 +3,7 @@ title: TiDB 容灾方案概述 summary: 了解 TiDB 提供的几种容灾方案，包括基于主备集群的容灾、基于多副本的单集群容灾和基于备份与恢复的容灾。 --- -# TiDB 容灾方案概述 +# 测试数据库容灾方案概述 本文将以如下结构系统介绍 TiDB 容灾解决方案： @@ -28,7 +28,7 @@ summary: 了解 TiDB 提供的几种容灾方案，包括基于主备集群的 在介绍具体的容灾方案之前，本部分将从容灾角度介绍容灾系统中的组件架构，包括 TiDB、TiCDC 和 BR。 -### TiDB 架构 +### 测试数据库架构 ![TiDB architecture](/media/dr/tidb-architecture.png) diff --git a/dumpling-overview.md b/dumpling-overview.md index 8a8986bde7c4..2e3e4f5786cd 100644 --- a/dumpling-overview.md +++ b/dumpling-overview.md @@ -291,7 +291,7 @@ $ ls -lh /tmp/test | awk '{print $5 "\t" $9}' 190K test.sbtest3.0.sql ``` -### 导出 TiDB 的历史数据快照 +### 导出测试数据库的历史数据快照 Dumpling 可以通过 `--snapshot` 指定导出某个 [tidb_snapshot](/read-historical-data.md#操作流程) 的数据。 @@ -306,7 +306,7 @@ tiup dumpling --snapshot "2020-07-02 17:12:45" 即可导出 TSO 为 `417773951312461825` 或 `2020-07-02 17:12:45` 时的 TiDB 历史数据快照。 -### 控制导出 TiDB 大表（超过 1 TB）时的内存使用 +### 控制导出测试数据库大表（超过 1 TB）时的内存使用 Dumpling 导出 TiDB 较大单表（超过 1 TB）时，可能会因为导出数据过大导致 TiDB 内存溢出 (OOM)，从而使连接中断导出失败。可以通过以下参数减少 TiDB 的内存使用。 diff --git a/dynamic-config.md b/dynamic-config.md index 52cc175a566b..d54a2bc838fd 100644 --- a/dynamic-config.md +++ b/dynamic-config.md @@ -306,7 +306,7 @@ Query OK, 0 rows affected (0.01 sec) 具体配置项意义可参考 [PD 配置文件描述](/pd-configuration-file.md)。 -### 在线修改 TiDB 配置 +### 在线修改测试数据库配置 在线修改 TiDB 配置的方式和 TiKV/PD 有所不同，你可以通过修改[系统变量](/system-variables.md)来实现。 diff --git a/ecosystem-tool-user-case.md b/ecosystem-tool-user-case.md index be7939a4dcfb..5012a3fd1ed2 100644 --- a/ecosystem-tool-user-case.md +++ b/ecosystem-tool-user-case.md @@ -3,7 +3,7 @@ title: TiDB 工具的使用场景 summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 --- -# TiDB 工具的使用场景 +# 测试数据库工具的使用场景 本文档从数据迁移工具的使用场景出发，介绍部分常见场景下的迁移工具的选择。 @@ -29,7 +29,7 @@ summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 如果全量数据量较大（TB 级别），则可先使用 [Dumpling](/dumpling-overview.md) 与 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 完成全量数据的迁移，再使用 DM 完成增量数据的迁移。 -## TiDB 集群备份与恢复 +## 测试数据库集群备份与恢复 当需要对 TiDB 集群进行备份或在之后对 TiDB 集群进行恢复时，可使用 [BR](/br/backup-and-restore-overview.md)。 @@ -39,6 +39,6 @@ summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 如果还需要执行增量数据的迁移，则可使用 [TiCDC](/ticdc/ticdc-overview.md)。 -## TiDB 增量数据订阅 +## 测试数据库增量数据订阅 当需要订阅 TiDB 增量数据的变更时，可使用 [TiCDC](/ticdc/ticdc-overview.md)。 diff --git a/ecosystem-tool-user-guide.md b/ecosystem-tool-user-guide.md index 3f593f406cfb..5d4831a53071 100644 --- a/ecosystem-tool-user-guide.md +++ b/ecosystem-tool-user-guide.md @@ -3,7 +3,7 @@ title: TiDB 工具功能概览 summary: TiDB 提供了丰富的工具，包括部署运维工具 TiUP 和 TiDB Operator，数据管理工具如 TiDB Data Migration（DM）、Dumpling、TiDB Lightning、Backup & Restore（BR）、TiCDC、sync-diff-inspector，以及 OLAP 分析工具 TiSpark。这些工具可用于部署、数据迁移、备份恢复、数据校验等多种操作，满足不同需求。 --- -# TiDB 工具功能概览 +# 测试数据库工具功能概览 TiDB 提供了丰富的工具，可以帮助你进行部署运维、数据管理（例如，数据迁移、备份恢复、数据校验）、在 TiKV 上运行 Spark SQL。请根据需要选择适用的工具。 @@ -110,7 +110,7 @@ TiDB 提供了 TiUP 和 TiDB Operator 部署运维工具，满足你在不同系 - 适用 TiDB 版本：v4.0 及以上 - Kubernetes 支持：[使用 BR 工具备份 TiDB 集群数据到兼容 S3 的存储](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/backup-to-aws-s3-using-br)，[使用 BR 工具恢复 S3 兼容存储上的备份数据](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/restore-from-aws-s3-using-br) -### TiDB 增量数据同步 - TiCDC +### 测试数据库增量数据同步 - TiCDC [TiCDC](/ticdc/ticdc-overview.md) 是一款通过拉取 TiKV 变更日志实现的 TiDB 增量数据同步工具，具有将数据还原到与上游任意 TSO 一致状态的能力，同时提供开放数据协议 (TiCDC Open Protocol)，支持其他系统订阅数据变更。 diff --git a/enable-disk-spill-encrypt.md b/enable-disk-spill-encrypt.md index 62c8b227830a..09e02a86bad8 100644 --- a/enable-disk-spill-encrypt.md +++ b/enable-disk-spill-encrypt.md @@ -3,7 +3,7 @@ title: 为 TiDB 落盘文件开启加密 summary: 了解如何为 TiDB 落盘文件开启加密。 --- -# 为 TiDB 落盘文件开启加密 +# 为测试数据库落盘文件开启加密 当系统变量 [`tidb_enable_tmp_storage_on_oom`](/system-variables.md#tidb_enable_tmp_storage_on_oom) 为 `ON` 时，如果单条 SQL 语句的内存使用超出系统变量 [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query) 的限制，某些算子可以将执行时的中间结果作为临时文件落盘保存，直到查询执行完成之后将它们删除。 diff --git a/enable-tls-between-clients-and-servers.md b/enable-tls-between-clients-and-servers.md index a83628f7fcc7..dc11bbba0e96 100644 --- a/enable-tls-between-clients-and-servers.md +++ b/enable-tls-between-clients-and-servers.md @@ -3,7 +3,7 @@ title: 为 TiDB 客户端服务端间通信开启加密传输 summary: TiDB 服务端与客户端间默认采用非加密连接，容易造成信息泄露。建议使用加密连接确保安全性。要开启 TLS 加密传输，需要在服务端配置开启 TLS 支持，并在客户端应用程序中配置使用 TLS 加密连接。可以通过配置系统变量或在创建 / 修改用户时指定要求加密连接。可通过命令检查当前连接是否是加密连接。TLS 版本为 TLSv1.2 和 TLSv1.3，支持的加密算法包括 AES 和 CHACHA20_POLY1305。 --- -# 为 TiDB 客户端服务端间通信开启加密传输 +# 为测试数据库客户端服务端间通信开启加密传输 默认情况下，TiDB 允许服务端与客户端之间的不安全连接，因而具备监视信道流量能力的第三方可以知悉 TiDB 服务端与客户端之间发送和接受的数据，包括但不限于查询语句内容、查询结果等。若信道是不可信的，例如客户端是通过公网连接到 TiDB 服务端的，则不安全连接容易造成信息泄露，建议使用 TLS 连接确保安全性。 @@ -30,7 +30,7 @@ TiDB 服务端支持启用基于 TLS（传输层安全）协议的安全连接 > > 如果登录用户已配置使用 [TiDB 证书鉴权功能](/certificate-authentication.md#配置登录时需要校验的用户证书信息)校验用户证书，也会隐式要求对应用户必须使用加密连接连接 TiDB。 -## 配置 TiDB 服务端启用安全连接 +## 配置测试数据库服务端启用安全连接 要启用安全连接，请参考以下相关参数说明： diff --git a/enable-tls-between-components.md b/enable-tls-between-components.md index eaff49b1b7b8..4b6fc182b84e 100644 --- a/enable-tls-between-components.md +++ b/enable-tls-between-components.md @@ -3,7 +3,7 @@ title: 为 TiDB 组件间通信开启加密传输 summary: 了解如何为 TiDB 集群内各组件间开启加密传输。 --- -# 为 TiDB 组件间通信开启加密传输 +# 为测试数据库组件间通信开启加密传输 本部分介绍如何为 TiDB 集群内各组件间开启加密传输。一旦开启，以下组件间均将使用加密传输： diff --git a/encryption-at-rest.md b/encryption-at-rest.md index aae5bc01d442..e4c3ad12b94d 100644 --- a/encryption-at-rest.md +++ b/encryption-at-rest.md @@ -11,7 +11,7 @@ summary: 了解如何启用静态加密功能保护敏感数据。 静态加密 (encryption at rest) 即在存储数据时进行数据加密。对于数据库，静态加密功能也叫透明数据加密 (TDE)，区别于传输数据加密 (TLS) 或使用数据加密（很少使用）。SSD 驱动器、文件系统、云供应商等都可进行静态加密。但区别于这些加密方式，若 TiKV 在存储数据前就进行数据加密，攻击者则必须通过数据库的身份验证才能访问数据。例如，即使攻击者获得物理机的访问权限时，也无法通过复制磁盘上的文件来访问数据。 -## 各 TiDB 组件支持的加密方式 +## 各测试数据库组件支持的加密方式 在一个 TiDB 集群中，不同的组件使用不同的加密方式。本节介绍 TiKV、 TiFlash、PD 和 Backup & Restore (BR) 等不同 TiDB 组件支持的加密方式。 diff --git a/error-codes.md b/error-codes.md index 4b895f966ccd..87f15b9514a4 100644 --- a/error-codes.md +++ b/error-codes.md @@ -133,7 +133,7 @@ TiDB 兼容 MySQL 的错误码，在大多数情况下，返回和 MySQL 一样 * Error Number: 8050 - 设置了不支持的权限类型，遇到该错误请参考 [TiDB 权限说明](/privilege-management.md#tidb-各操作需要的权限)进行调整。 + 设置了不支持的权限类型，遇到该错误请参考 [测试数据库权限说明](/privilege-management.md#测试数据库各操作需要的权限)进行调整。 * Error Number: 8051 diff --git a/explain-overview.md b/explain-overview.md index 0c1c6d806027..adef365160de 100644 --- a/explain-overview.md +++ b/explain-overview.md @@ -3,7 +3,7 @@ title: TiDB 执行计划概览 summary: 了解 TiDB 中 EXPLAIN 语句返回的执行计划。 --- -# TiDB 执行计划概览 +# 测试数据库执行计划概览 > **注意：** > diff --git a/faq/backup-and-restore-faq.md b/faq/backup-and-restore-faq.md index ff853ab2c954..a615798bf8b4 100644 --- a/faq/backup-and-restore-faq.md +++ b/faq/backup-and-restore-faq.md @@ -296,7 +296,7 @@ br restore full -f 'mysql.usertable' -s $external_storage_url --with-sys-table 这个情况多数是因为备份时集群的数据压缩比率和恢复时的默认值不一致导致的，只要恢复的 checksum 阶段顺利通过，可以忽略这个问题，不影响正常使用。 -### 使用 BR 恢复数据后是否需要对表执行 `ANALYZE` 以更新 TiDB 在表和索引上留下的统计信息？ +### 使用 BR 恢复数据后是否需要对表执行 `ANALYZE` 以更新测试数据库在表和索引上留下的统计信息？ BR 不会备份统计信息（v4.0.9 除外）。所以在恢复存档后需要手动执行 `ANALYZE TABLE` 或等待 TiDB 自动进行 `ANALYZE`。 diff --git a/faq/deploy-and-maintain-faq.md b/faq/deploy-and-maintain-faq.md index 12e8d36ae007..f84252b6618a 100644 --- a/faq/deploy-and-maintain-faq.md +++ b/faq/deploy-and-maintain-faq.md @@ -3,17 +3,17 @@ title: TiDB 安装部署常见问题 summary: 介绍 TiDB 集群安装部署的常见问题、原因及解决方法。 --- -# TiDB 安装部署常见问题 +# 测试数据库安装部署常见问题 本文介绍 TiDB 集群安装部署的常见问题、原因及解决方法。 ## 软硬件要求 FAQ -### TiDB 支持哪些操作系统？ +### 测试数据库支持哪些操作系统？ 关于 TiDB 支持的操作系统，参见[操作系统及平台要求](/hardware-and-software-requirements.md#操作系统及平台要求)。 -### TiDB 对开发、测试、生产环境的服务器硬件配置有什么要求？ +### 测试数据库对开发、测试、生产环境的服务器硬件配置有什么要求？ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台。对于开发、测试、生产环境的服务器硬件配置，参见[服务器配置要求](/hardware-and-software-requirements.md#服务器配置要求)。 @@ -25,7 +25,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 资源可接受的话，我们建议做 RAID 10，如果资源有限，也可以不做 RAID。 -### TiDB 集群各个组件的配置推荐？ +### 测试数据库集群各个组件的配置推荐？ - TiDB 需要 CPU 和内存比较好的机器，参考官网配置要求； - PD 里面存了集群元信息，会有频繁的读写请求，对磁盘 I/O 要求相对比较高，磁盘太差会影响整个集群性能，推荐 SSD 磁盘，空间不用太大。另外集群 Region 数量越多对 CPU、内存的要求越高； @@ -41,7 +41,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 这种情况一般是因为没有使用 `--config` 参数来指定配置文件（目前只会出现在 binary 部署的场景），TiKV/PD 会按默认值来设置。如果要使用配置文件，请设置 TiKV/PD 的 `--config` 参数。对于 TiKV 组件，修改配置后重启服务即可；对于 PD 组件，只会在第一次启动时读取配置文件，之后可以使用 pd-ctl 的方式来修改配置，详情可参考 [PD 配置参数](/command-line-flags-for-pd-configuration.md)。 -### TiDB 监控框架 Prometheus + Grafana 监控机器建议单独还是多台部署？ +### 测试数据库监控框架 Prometheus + Grafana 监控机器建议单独还是多台部署？ 监控机建议单独部署。建议 CPU 8 core，内存 16 GB 以上，硬盘 500 GB 以上。 @@ -73,7 +73,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 | enable_slow_query_log | TiDB 慢查询日志记录到单独文件({{ deploy_dir }}/log/tidb_slow_query.log)，默认为 False，记录到 tidb 日志 | | deploy_without_tidb | KV 模式，不部署 TiDB 服务，仅部署 PD、TiKV 及监控服务，请将 inventory.ini 文件中 tidb_servers 主机组 IP 设置为空。 | -### 如何单独记录 TiDB 中的慢查询日志，如何定位慢查询 SQL？ +### 如何单独记录测试数据库中的慢查询日志，如何定位慢查询 SQL？ 1. TiDB 中，对慢查询的定义在 TiDB 的配置文件中。`tidb_slow_log_threshold: 300`，这个参数是配置慢查询记录阈值的，单位是 ms。 @@ -81,7 +81,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 3. 除了日志，还可以通过 `ADMIN SHOW SLOW` 命令查看，详情可参考 [`ADMIN SHOW SLOW` 命令](/identify-slow-queries.md#admin-show-slow-命令)。 -### 首次部署 TiDB 集群时，没有配置 tikv 的 Label 信息，在后续如何添加配置 Label？ +### 首次部署测试数据库集群时，没有配置 tikv 的 Label 信息，在后续如何添加配置 Label？ TiDB 的 Label 设置是与集群的部署架构相关的，是集群部署中的重要内容，是 PD 进行全局管理和调度的依据。如果集群在初期部署过程中没有设置 Label，需要在后期对部署结构进行调整，就需要手动通过 PD 的管理工具 pd-ctl 来添加 location-labels 信息，例如：`config set location-labels "zone,rack,host"`（根据实际的 label 层级名字配置）。 @@ -109,7 +109,7 @@ Direct 模式就是把写入请求直接封装成 I/O 指令发到磁盘，这 ./fio -ioengine=psync -bs=32k -fdatasync=1 -thread -rw=randrw -percentage_random=100,0 -size=10G -filename=fio_randread_write_test.txt -name='fio mixed randread and sequential write test' -iodepth=4 -runtime=60 -numjobs=4 -group_reporting --output-format=json --output=fio_randread_write_test.json ``` -## TiDB 支持在公有云上部署吗？ +## 测试数据库支持在公有云上部署吗？ TiDB 支持在 [Google Cloud GKE](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-gcp-gke)、[AWS EKS](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-aws-eks) 和[阿里云 ACK](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-alibaba-cloud) 上部署使用。 diff --git a/faq/faq-overview.md b/faq/faq-overview.md index eb4ab2f5cba6..1a6a56edfa13 100644 --- a/faq/faq-overview.md +++ b/faq/faq-overview.md @@ -3,7 +3,7 @@ title: TiDB 产品常见问题解答汇总 summary: 汇总 TiDB 产品的常见问题解答。 --- -# TiDB 产品常见问题解答汇总 +# 测试数据库产品常见问题解答汇总 本文整合汇总了 TiDB 使用过程中常见问题解答的 (FAQ) 文档。 diff --git a/faq/high-availability-faq.md b/faq/high-availability-faq.md index e636e9d03d5b..1f09123f09c6 100644 --- a/faq/high-availability-faq.md +++ b/faq/high-availability-faq.md @@ -7,12 +7,12 @@ summary: 介绍高可用相关的常见问题。 本文档介绍高可用相关的常见问题。 -## TiDB 数据是强一致的吗？ +## 测试数据库数据是强一致的吗？ 通过使用 [Raft 一致性算法](https://raft.github.io/)，数据在各 TiKV 节点间复制为多副本，以确保某个节点宕机时数据的安全性。 在底层，TiKV 使用复制日志 + 状态机 (State Machine) 的模型来复制数据。对于写入请求，数据被写入 Raft Leader，然后 Leader 以日志的形式将命令复制到它的 Follower 中。当集群中的大多数节点收到此日志时，日志会被提交，状态机会相应作出变更，以此来实现强一致。 -## TiDB 是否提供三中心跨机房多活部署的推荐方案？ +## 测试数据库是否提供三中心跨机房多活部署的推荐方案？ 从架构来看，TiDB 支持真正意义上的跨中心异地多活。从实现层面看，多地部署方案依赖数据中心之间的网络延迟和稳定性，一般建议延迟在 5ms 以下。目前 TiDB 已经有相似的客户部署方案，参见[两地三中心部署方案](/three-data-centers-in-two-cities-deployment.md)。 diff --git a/faq/high-reliability-faq.md b/faq/high-reliability-faq.md index f36d72f37ade..cdf30adb198a 100644 --- a/faq/high-reliability-faq.md +++ b/faq/high-reliability-faq.md @@ -7,11 +7,11 @@ summary: 介绍高可靠相关的常见问题。 本文档介绍高可靠相关的常见问题。 -## TiDB 是否支持数据加密？ +## 测试数据库是否支持数据加密？ 支持。要加密传输中的数据，可以[在 TiDB 客户端和服务器之间启用 TLS](/enable-tls-between-clients-and-servers.md)。要加密存储引擎中的数据，可以启用[透明数据加密 (TDE)](/encryption-at-rest.md)。 -## 我们的安全漏洞扫描工具对 MySQL version 有要求，TiDB 是否支持修改 server 版本号呢？ +## 我们的安全漏洞扫描工具对 MySQL version 有要求，测试数据库是否支持修改 server 版本号呢？ TiDB 在 v3.0.8 后支持通过 TiDB 配置文件中的 [`server-version`](/tidb-configuration-file.md#server-version) 配置项来修改 server 版本号。 @@ -25,7 +25,7 @@ server_configs: 修改完成后，使用 `tiup cluster reload -R tidb` 命令使得以上修改生效，以避免出现安全漏洞扫描不通过的问题。 -## TiDB 支持哪些认证协议？过程是怎样的？ +## 测试数据库支持哪些认证协议？过程是怎样的？ TiDB 和 MySQL 一样，在用户登录认证时使用 SASL 认证协议对密码进行处理。 diff --git a/faq/manage-cluster-faq.md b/faq/manage-cluster-faq.md index 394de80f24ee..f890cc004865 100644 --- a/faq/manage-cluster-faq.md +++ b/faq/manage-cluster-faq.md @@ -3,7 +3,7 @@ title: TiDB 集群管理常见问题 summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 --- -# TiDB 集群管理常见问题 +# 测试数据库集群管理常见问题 本文介绍管理 TiDB 集群时的常见问题、原因及解决方法。 @@ -11,7 +11,7 @@ summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 本小节介绍集群日程管理中的常见问题、原因及解决方法。 -### TiDB 如何登录？ +### 测试数据库如何登录？ 和 MySQL 登录方式一样，可以按照下面例子进行登录。 @@ -21,7 +21,7 @@ summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 mysql -h 127.0.0.1 -uroot -P4000 ``` -### TiDB 如何修改数据库系统变量？ +### 测试数据库如何修改数据库系统变量？ 和 MySQL 一样，TiDB 也分为静态参数和固态参数，静态参数可以直接通过 `SET GLOBAL xxx = n` 的方式进行修改，不过新参数值只限于该实例生命周期有效。 @@ -29,11 +29,11 @@ mysql -h 127.0.0.1 -uroot -P4000 默认在 [`--data-dir`](/command-line-flags-for-tikv-configuration.md#--data-dir) 目录下，其中包括 backup、db、raft、snap 四个目录，分别存储备份、数据、raft 数据及镜像数据。 -### TiDB 有哪些系统表？ +### 测试数据库有哪些系统表？ 和 MySQL 类似，TiDB 中也有系统表，用于存放数据库运行时所需信息，具体信息参考 [TiDB 系统表](/mysql-schema/mysql-schema-user.md)文档。 -### TiDB 各节点服务器下是否有日志文件，如何管理？ +### 测试数据库各节点服务器下是否有日志文件，如何管理？ 默认情况下各节点服务器会在日志中输出标准错误，如果启动的时候通过 `--log-file` 参数指定了日志文件，那么日志会输出到指定的文件中，并且按天做 rotation。 @@ -49,7 +49,7 @@ mysql -h 127.0.0.1 -uroot -P4000 - 若未使用 load balancer：执行 `SHUTDOWN` 语句，TiDB 组件会做 graceful shutdown。 -### TiDB 里面可以执行 kill 命令吗？ +### 测试数据库里面可以执行 kill 命令吗？ - Kill DML 语句： @@ -61,15 +61,15 @@ mysql -h 127.0.0.1 -uroot -P4000 - Kill DDL 语句：执行 `admin show ddl jobs`，查找需要 kill 的 DDL job ID，然后执行 `admin cancel ddl jobs 'job_id' [, 'job_id'] ...`。具体可以参考 [`ADMIN`](/sql-statements/sql-statement-admin.md)。 -### TiDB 是否支持会话超时？ +### 测试数据库是否支持会话超时？ TiDB 目前支持 [`wait_timeout`](/system-variables.md#wait_timeout)、[`interactive_timeout`](/system-variables.md#interactive_timeout) 和 [`tidb_idle_transaction_timeout`](/system-variables.md#tidb_idle_transaction_timeout-从-v760-版本开始引入) 三种超时。 -### TiDB 的版本管理策略是怎么样的？ +### 测试数据库的版本管理策略是怎么样的？ 关于 TiDB 版本的管理策略，可以参考 [TiDB 版本规则](/releases/versioning.md)。 -### 部署和维护 TiDB 集群的运营成本如何？ +### 部署和维护测试数据库集群的运营成本如何？ TiDB 提供了一些特性和[工具](/ecosystem-tool-user-guide.md)，可以帮助你以低成本管理集群： @@ -84,14 +84,14 @@ TiDB 目前社区非常活跃，同时，我们还在不断的优化和修改 BU - 通过 `select tidb_version()` 进行查看 - 通过执行 `tidb-server -V` 进行查看 -### 如何扩容 TiDB 集群？ +### 如何扩容测试数据库集群？ 可以在不影响线上服务的情况下，对 TiDB 集群进行扩容。 - 如果是使用 [TiUP](/production-deployment-using-tiup.md) 部署的集群，可以参考[使用 TiUP 扩容 TiDB 集群](/scale-tidb-using-tiup.md)。 - 如果是使用 [TiDB Operator](/tidb-operator-overview.md) 在 Kubernetes 上部署的集群，可以参考[在 Kubernetes 中手动扩容 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/scale-a-tidb-cluster)。 -### TiDB 如何进行水平扩展？ +### 测试数据库如何进行水平扩展？ 当您的业务不断增长时，数据库可能会面临三方面瓶颈，第一是存储空间，第二是计算资源，第三是读写容量，这时可以对 TiDB 集群做水平扩展。 @@ -103,7 +103,7 @@ TiDB 目前社区非常活跃，同时，我们还在不断的优化和修改 BU 详细可参考 [Percolator 和 TiDB 事务算法](https://pingcap.com/blog-cn/percolator-and-txn/)。 -### TiDB 为什么选用 gRPC 而不选用 Thrift，是因为 Google 在用吗？ +### 测试数据库为什么选用 gRPC 而不选用 Thrift，是因为 Google 在用吗？ 不只是因为 Google 在用，有一些比较好的特性我们需要，比如流控、加密还有 Streaming。 @@ -168,7 +168,7 @@ Client 连接只能通过 TiDB 访问集群，TiDB 负责连接 PD 与 TiKV，PD 本小节介绍 TiDB server 管理中的常见问题、原因及解决方法。 -### TiDB 的 lease 参数应该如何设置？ +### 测试数据库的 lease 参数应该如何设置？ 启动 TiDB Server 时，需要通过命令行参数设置 lease 参数 (`--lease=60`)，其值会影响 DDL 的速度（只会影响当前执行 DDL 的 session，其他的 session 不会受影响）。在测试阶段，lease 的值可以设为 1s，加快测试进度；在生产环境下，我们推荐这个值设为分钟级（一般可以设为 60），这样可以保证 DDL 操作的安全。 @@ -191,7 +191,7 @@ Client 连接只能通过 TiDB 访问集群，TiDB 负责连接 PD 与 TiKV，PD - 由于停 TiDB 时不能与 PD 正常通信（包括停电情况）或者用 `kill -9` 指令停 TiDB 导致 TiDB 没有及时从 PD 清理注册数据，那么会影响 TiDB 启动后 10min 内的 DDL 语句处理时间。这段时间内运行 DDL 语句时，每个 DDL 状态变化都需要等待 2 * lease（默认 lease = 45s）。 - 当集群中某个 TiDB 与 PD 之间发生通信问题，即 TiDB 不能从 PD 及时获取或更新版本信息，那么这时候 DDL 操作的每个状态处理需要等待 2 * lease。 -### TiDB 可以使用 S3 作为后端存储吗？ +### 测试数据库可以使用 S3 作为后端存储吗？ 不可以，目前 TiDB 只支持分布式存储引擎和 GolevelDB/RocksDB/BoltDB 引擎。 @@ -207,7 +207,7 @@ TiDB-server 与 TiKV-server 随时进行通信，在进行大量数据操作过 TiClient Region Error 该指标描述的是在 TiDB-server 作为客户端通过 KV 接口访问 TiKV-server 进行数据操作过程中，TiDB-server 操作 TiKV-server 中的 Region 数据出现的错误类型与 metric 指标，错误类型包括 not_leader、stale_epoch。出现这些错误的情况是当 TiDB-server 根据自己的缓存信息去操作 Region leader 数据的时候，Region leader 发生了迁移或者 TiKV 当前的 Region 信息与 TiDB 缓存的路由信息不一致而出现的错误提示。一般这种情况下，TiDB-server 都会自动重新从 PD 获取最新的路由数据，重做之前的操作。 -### TiDB 同时支持的最大并发连接数？ +### 测试数据库同时支持的最大并发连接数？ 默认情况下，每个 TiDB 服务器的最大连接数没有限制。如有需要，可以在 `config.toml` 文件中设置 `instance.max_connections`（或者系统变量 `max_connections`）来限制最大连接数。如果并发量过大导致响应时间增加，建议通过添加 TiDB 节点进行扩容。 @@ -215,11 +215,11 @@ TiClient Region Error 该指标描述的是在 TiDB-server 作为客户端通过 information_schema 库中的 tables 表里的 create_time 即为表的真实创建时间。 -### TiDB 的日志中 EXPENSIVE_QUERY 是什么意思？ +### 测试数据库的日志中 EXPENSIVE_QUERY 是什么意思？ TiDB 在执行 SQL 时，预估出来每个 operator 处理了超过 10000 条数据就认为这条 query 是 expensive query。可以通过修改 tidb-server 配置参数来对这个门限值进行调整，调整后需要重新启动 tidb-server。 -### 如何预估 TiDB 中一张表的大小？ +### 如何预估测试数据库中一张表的大小？ 要预估 TiDB 中一张表的大小，你可以参考使用以下查询语句： @@ -373,14 +373,14 @@ TiKV 支持单独进行接口调用，理论上也可以起个实例做为 Cache TiKV 的内存占用主要来自于 RocksDB 的 block-cache，默认为系统总内存的 40%。当 TiKV 容易出现 OOM 时，检查 `block-cache-size` 配置是否过高。还需要注意，当单机部署了多个 TiKV 实例时，需要显式地配置该参数，以防止多个实例占用过多系统内存导致 OOM。 -### TiDB 数据和 RawKV 数据可存储于同一个 TiKV 集群里吗？ +### 测试数据库数据和 RawKV 数据可存储于同一个 TiKV 集群里吗？ 这取决于你使用的 TiDB 版本以及是否启用了 TiKV API V2 （即 [`storage.api-version = 2`](/tikv-configuration-file.md#api-version-从-v610-版本开始引入)）。 - 如果你使用的是 v6.1.0 或之后版本的 TiDB，并且启用了 TiKV API V2，那么 TiDB 数据和 RawKV 数据可以共存于同一个 TiKV 集群。 - 否则，不可以将 TiDB 数据和 RawKV 数据存储于同一个 TiKV 集群中，因为 TiDB 数据（或使用事务 API 创建的数据）的 key 的格式与使用 RawKV API 创建的数据（或来自其他基于 RawKV 的服务生成的数据）不兼容。 -## TiDB 测试 +## 测试数据库测试 本小节介绍 TiDB 测试中的常见问题、原因及解决方法。 @@ -391,21 +391,21 @@ TiKV 的内存占用主要来自于 RocksDB 的 block-cache，默认为系统总 - 大家不要用过多精力纠结这类基准测试上，应该更多关注 TiDB 的场景上的区别。 - 大家可以直接参考 [TiDB Sysbench 性能测试报告](/benchmark/v3.0-performance-benchmarking-with-sysbench.md)。 -### TiDB 集群容量 QPS 与节点数之间关系如何，和 MySQL 对比如何？ +### 测试数据库集群容量 QPS 与节点数之间关系如何，和 MySQL 对比如何？ - 在 10 节点内，TiDB 写入能力 (Insert TPS) 和节点数量基本成 40% 线性递增，MySQL 由于是单节点写入，所以不具备写入扩展能力。 - MySQL 读扩容可以通过添加从库进行扩展，但写流量无法扩展，只能通过分库分表，而分库分表有很多问题，具体参考[方案虽好，成本先行：数据库 Sharding+Proxy 实践解析](http://dbaplus.cn/news-11-1854-1.html)。 - TiDB 不管是读流量、还是写流量都可以通过添加节点快速方便的进行扩展。 -### 我们的 DBA 测试过 MySQL 性能，单台 TiDB 的性能没有 MySQL 性能那么好？ +### 我们的 DBA 测试过 MySQL 性能，单台测试数据库的性能没有 MySQL 性能那么好？ TiDB 设计的目标就是针对 MySQL 单台容量限制而被迫做的分库分表的场景，或者需要强一致性和完整分布式事务的场景。它的优势是通过尽量下推到存储节点进行并行计算。对于小表（比如千万级以下），不适合 TiDB，因为数据量少，Region 有限，发挥不了并行的优势。其中最极端的例子就是计数器表，几行记录高频更新，这几行在 TiDB 里，会变成存储引擎上的几个 KV，然后只落在一个 Region 里，而这个 Region 只落在一个节点上。加上后台强一致性复制的开销，TiDB 引擎到 TiKV 引擎的开销，最后表现出来的就是没有单个 MySQL 好。 -## TiDB 备份恢复 +## 测试数据库备份恢复 本小节介绍 TiDB 备份恢复中的常见问题、原因及解决方法。 -### TiDB 主要备份方式？ +### 测试数据库主要备份方式？ 目前，数据量大时（大于 1 TB）推荐使用 [Backup & Restore (BR)](/br/backup-and-restore-overview.md) 进行备份。其他场景推荐使用 [Dumpling](/dumpling-overview.md) 进行备份。 diff --git a/faq/migration-tidb-faq.md b/faq/migration-tidb-faq.md index 7c025068a839..855de89fca5f 100644 --- a/faq/migration-tidb-faq.md +++ b/faq/migration-tidb-faq.md @@ -16,7 +16,7 @@ summary: 介绍 TiDB 迁移中的常见问题。 ## 全量数据导出导入 -### 如何将一个运行在 MySQL 上的应用迁移到 TiDB 上？ +### 如何将一个运行在 MySQL 上的应用迁移到测试数据库上？ TiDB 支持绝大多数 MySQL 语法，一般不需要修改代码。 @@ -69,11 +69,11 @@ iperf Done. 如果输出的各指标良好，请尝试更新各组件版本。如果更新后仍无法解决问题，请移步 [AskTUG 论坛](https://asktug.com/)寻求帮助。 -### 不小心把 MySQL 的 user 表导入到 TiDB 了，或者忘记密码，无法登录，如何处理？ +### 不小心把 MySQL 的 user 表导入到测试数据库了，或者忘记密码，无法登录，如何处理？ 重启 TiDB 服务，配置文件中增加 `-skip-grant-table=true` 参数，无密码登录集群后，可以根据情况重建用户，或者重建 mysql.user 表，具体表结构搜索官网。 -### 如何导出 TiDB 数据？ +### 如何导出测试数据库数据？ 你可以通过以下方式导出 TiDB 数据： @@ -91,7 +91,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 目前看来 OGG 最为合适。 -### 用 Sqoop 批量写入 TiDB 数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ +### 用 Sqoop 批量写入测试数据库数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ - 在 Sqoop 中，`--batch` 是指每个批次提交 100 条 statement，但是默认每个 statement 包含 100 条 SQL 语句，所以此时 100 * 100 = 10000 条 SQL 语句，超出了 TiDB 的事务限制 5000 条，可以增加选项 `-Dsqoop.export.records.per.statement=10` 来解决这个问题，完整的用法如下： @@ -119,7 +119,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 在上述情况下，Dumpling 划分导出子范围时，会划分出过大的子范围，从而向上游发送结果过大的查询。请联系 [AskTUG 社区专家](https://asktug.com/)获取实验版本的 Dumpling。 -### TiDB 有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ +### 测试数据库有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ 有，也支持 DDL。详细参考 [TiDB 历史数据回溯](/read-historical-data.md)。 @@ -135,7 +135,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 我们建议通过 [TiDB Data Migration](/dm/dm-overview.md) 进行 MySQL -> TiDB 的业务数据的迁移；业务读写可以按照需求分阶段通过修改网络配置进行流量迁移，建议 DB 上层部署一个稳定的网络 LB（HAproxy、LVS、F5、DNS 等），这样直接修改网络配置就能实现无缝流量迁移。 -### TiDB 总读写流量有限制吗？ +### 测试数据库总读写流量有限制吗？ TiDB 读流量可以通过增加 TiDB server 进行扩展，总读容量无限制，写流量可以通过增加 TiKV 节点进行扩容，基本上写容量也没有限制。 @@ -151,7 +151,7 @@ TiDB 限制了单条 KV entry 不超过 6MB，可以修改配置文件中的 [`t 导入数据的时候，可以分批插入，每批最好不要超过 1w 行。 -### TiDB 中删除数据后会立即释放空间吗？ +### 测试数据库中删除数据后会立即释放空间吗？ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DROP 操作，在达到 TiDB 的 GC (garbage collection) 时间后（默认 10 分钟），TiDB 的 GC 机制会删除数据并释放空间。对于 DELETE 操作 TiDB 的 GC 机制会删除数据，但不会释放空间，而是当后续数据写入 RocksDB 且进行 compact 时对空间重新利用。 @@ -159,7 +159,7 @@ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DRO 不可以，加载数据期间不能对目标表执行任何 DDL 操作，这会导致数据加载失败。 -### TiDB 是否支持 replace into 语法？ +### 测试数据库是否支持 replace into 语法？ 支持。 @@ -171,7 +171,7 @@ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DRO 在删除大量数据的时候，建议使用 `Delete from t where xx limit 5000`（xx 建议在满足业务过滤逻辑下，尽量加上强过滤索引列或者直接使用主键选定范围，如 `id >= 5000*n+m and id <= 5000*(n+1)+m` 这样的方案，通过循环来删除，用 `Affected Rows == 0` 作为循环结束条件，这样避免遇到事务大小的限制。如果一次删除的数据量非常大，这种循环的方式会越来越慢，因为每次删除都是从前向后遍历，前面的删除之后，短时间内会残留不少删除标记（后续会被 GC 掉），影响后面的 Delete 语句。如果有可能，建议把 Where 条件细化。可以参考官网[最佳实践](https://pingcap.com/blog-cn/tidb-best-practice/)。 -### TiDB 如何提高数据加载速度？ +### 测试数据库如何提高数据加载速度？ 主要有两个方面： diff --git a/faq/monitor-faq.md b/faq/monitor-faq.md index c947d972925a..1bd55e8c7a88 100644 --- a/faq/monitor-faq.md +++ b/faq/monitor-faq.md @@ -3,7 +3,7 @@ title: TiDB 监控常见问题 summary: 介绍在监控 TiDB 集群时的常见问题、原因及解决方法。 --- -# TiDB 监控常见问题 +# 测试数据库监控常见问题 本文介绍在监控 TiDB 集群时的常见问题、原因及解决方法。 diff --git a/faq/sql-faq.md b/faq/sql-faq.md index 18a578cbb7a6..ae20718dd97d 100644 --- a/faq/sql-faq.md +++ b/faq/sql-faq.md @@ -7,11 +7,11 @@ summary: 介绍 SQL 操作相关的常见问题。 本文档介绍 TiDB 中常见的 SQL 操作问题。 -## TiDB 是否支持二级键？ +## 测试数据库是否支持二级键？ 支持。你可以在具有唯一[二级索引](/develop/dev-guide-create-secondary-indexes.md)的非主键列上设置 [`NOT NULL` 约束](/constraints.md#非空约束)。在这种情况下，该列用作二级键。 -## TiDB 在对大表执行 DDL 操作时，性能表现如何？ +## 测试数据库在对大表执行 DDL 操作时，性能表现如何？ TiDB 在对大表执行 DDL 操作时，一般不会有什么问题。TiDB 支持在线 DDL 操作，且这些 DDL 操作不会阻塞 DML 操作。 @@ -56,11 +56,11 @@ DROP GLOBAL BINDING for SELECT * FROM t1, t2 WHERE t1.id = t2.id; ``` -## TiDB 对哪些 MySQL variables 兼容？ +## 测试数据库对哪些 MySQL variables 兼容？ 详细可参考[系统变量](/system-variables.md)。 -## 省略 `ORDER BY` 条件时 TiDB 中返回结果的顺序与 MySQL 中的不一致 +## 省略 `ORDER BY` 条件时测试数据库中返回结果的顺序与 MySQL 中的不一致 这不是 bug。返回结果的顺序视不同情况而定，不保证顺序统一。 @@ -124,7 +124,7 @@ MySQL 中，返回结果的顺序可能较为固定，因为查询是通过单 在 TiDB 中，你还可以使用系统变量 [`tidb_enable_ordered_result_mode`](/system-variables.md#tidb_enable_ordered_result_mode) 来指定是否对最终的输出结果进行自动排序。 -## TiDB 是否支持 `SELECT FOR UPDATE`？ +## 测试数据库是否支持 `SELECT FOR UPDATE`？ 支持。当 TiDB 使用悲观锁（自 TiDB v3.0.8 起默认使用）时，TiDB 中 `SELECT FOR UPDATE` 的行为与 MySQL 中的基本一致。 @@ -132,7 +132,7 @@ MySQL 中，返回结果的顺序可能较为固定，因为查询是通过单 详情参考 [SELECT 语句语法元素说明](/sql-statements/sql-statement-select.md#语法元素说明)。 -## TiDB 的 codec 能保证 UTF8 的字符串是 memcomparable 的吗？我们的 key 需要支持 UTF8，有什么编码建议吗？ +## 测试数据库的 codec 能保证 UTF8 的字符串是 memcomparable 的吗？我们的 key 需要支持 UTF8，有什么编码建议吗？ TiDB 的默认字符集是 `utf8mb4`，字符串是 memcomparable 格式。关于字符集的更多信息，参见[字符集和排序规则](/character-set-and-collation.md)。 @@ -142,18 +142,18 @@ TiDB 的默认字符集是 `utf8mb4`，字符串是 memcomparable 格式。关 在使用乐观事务并开启事务重试的情况下，默认限制 5000，可通过 [`stmt-count-limit`](/tidb-configuration-file.md#stmt-count-limit) 调整。 -## TiDB 中，为什么出现后插入数据的自增 ID 反而小？ +## 测试数据库中，为什么出现后插入数据的自增 ID 反而小？ TiDB 的自增 ID (`AUTO_INCREMENT`) 只保证自增且唯一，并不保证连续分配。TiDB 目前采用批量分配的方式，所以如果在多台 TiDB server 上同时插入数据，分配的自增 ID 会不连续。当多个线程并发往不同的 TiDB server 插入数据的时候，有可能会出现后插入的数据自增 ID 小的情况。此外，TiDB 允许给整型类型的字段指定 AUTO_INCREMENT，且一个表只允许一个属性为 `AUTO_INCREMENT` 的字段。详情可参考[自增 ID](/mysql-compatibility.md#自增-id)和 [AUTO_INCREMENT](/auto-increment.md)。 -## 如何在 TiDB 中修改 `sql_mode`？ +## 如何在测试数据库中修改 `sql_mode`？ TiDB 支持在会话或全局作用域上修改 [`sql_mode`](/system-variables.md#sql_mode) 系统变量。 - 对全局作用域变量的修改，设置后将作用于集群中的其它服务器，并且重启后更改依然有效。因此，你无需在每台 TiDB 服务器上都更改 `sql_mode` 的值。 - 对会话作用域变量的修改，设置后只影响当前会话，重启后更改消失。 -## 用 Sqoop 批量写入 TiDB 数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ +## 用 Sqoop 批量写入测试数据库数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ 问题原因：在 Sqoop 中，`--batch` 是指每个批次提交 100 条 statement，但是默认每个 statement 包含 100 条 SQL 语句，所以此时 100 * 100 = 10000 条 SQL 语句，超出了 TiDB 的事务限制 5000 条。 @@ -174,11 +174,11 @@ TiDB 支持在会话或全局作用域上修改 [`sql_mode`](/system-variables.m - 也可以选择增大 TiDB 的单个事物语句数量限制，不过此操作会导致内存增加。详情参见 [SQL 语句的限制](/tidb-limitations.md#sql-statements-的限制)。 -## TiDB 有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ +## 测试数据库有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ 有，也支持 DDL。详细参考[使用 AS OF TIMESTAMP 语法读取历史数据](/as-of-timestamp.md)。 -## TiDB 中删除数据后会立即释放空间吗？ +## 测试数据库中删除数据后会立即释放空间吗？ 在 TiDB 中使用 `DELETE`，`TRUNCATE` 和 `DROP` 语句删除数据都不会立即释放空间。对于 `TRUNCATE` 和 `DROP` 操作，在达到 TiDB 的 GC (garbage collection) 时间后（默认 10 分钟），TiDB 的 GC 机制会删除数据并释放空间。对于 DELETE 操作，TiDB 的 GC 机制会删除数据，但不会立即释放空间，而是等到后续进行 compaction 时释放空间。 @@ -198,7 +198,7 @@ TiDB 中的 `SHOW PROCESSLIST` 与 MySQL 中的 `SHOW PROCESSLIST` 显示内容 + 在查询执行期间，TiDB 中的 `State` 列不会持续更新。由于 TiDB 支持并行查询，每个语句可能同时处于多个状态，因此很难显示为某一种状态。 -## 在 TiDB 中如何控制或改变 SQL 提交的执行优先级？ +## 在测试数据库中如何控制或改变 SQL 提交的执行优先级？ TiDB 支持改变[全局](/system-variables.md#tidb_force_priority)或单个语句的优先级。优先级包括： @@ -224,7 +224,7 @@ TiDB 支持改变[全局](/system-variables.md#tidb_force_priority)或单个语 2. 全表扫会自动调整为低优先级，[`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 也是默认低优先级。 -## 在 TiDB 中 `auto analyze` 的触发策略是怎样的？ +## 在测试数据库中 `auto analyze` 的触发策略是怎样的？ 当一张表或分区表的单个分区达到 1000 条记录，且表或分区的（修改数/当前总行数）比例大于 [`tidb_auto_analyze_ratio`](/system-variables.md#tidb_auto_analyze_ratio) 的时候，会自动触发 [`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 语句。 @@ -326,7 +326,7 @@ TiDB 在执行 SQL 语句时，会根据隔离级别确定一个对象的 `schem ## SQL 优化 -### TiDB 执行计划解读 +### 测试数据库执行计划解读 详细解读[理解 TiDB 执行计划](/explain-overview.md)。 @@ -371,7 +371,7 @@ RUNNING_JOBS: ID:121, Type:add index, State:running, SchemaState:write reorganiz - `ADMIN SHOW DDL JOBS`：用于查看当前 DDL 作业队列中的所有结果（包括正在运行以及等待运行的任务）以及已执行完成的 DDL 作业队列中的最近十条结果。 - `ADMIN SHOW DDL JOBS QUERIES 'job_id' [, 'job_id'] ...`：用于显示 `job_id` 对应的 DDL 任务的原始 SQL 语句。此 `job_id` 只搜索正在执行中的任务以及 DDL 历史作业队列中的最近十条结果。 -### TiDB 是否支持基于 COST 的优化 (CBO)？如果支持，实现到什么程度？ +### 测试数据库是否支持基于 COST 的优化 (CBO)？如果支持，实现到什么程度？ 是的，TiDB 基于成本的优化器 (CBO) 对代价模型、统计信息进行持续优化。除此之外，TiDB 还支持 hash join、sort-merge join 等 join 算法。 @@ -383,7 +383,7 @@ RUNNING_JOBS: ID:121, Type:add index, State:running, SchemaState:write reorganiz ID 没什么规律，只要是唯一就行。不过在生成执行计划时，有一个计数器，生成一个计划 ID 后序号就加 1，执行的顺序和序号无关。整个执行计划是一颗树，执行时从根节点开始，不断地向上返回数据。要理解执行计划，请参考[理解 TiDB 执行计划](/explain-overview.md)。 -### TiDB 执行计划中，task cop 在一个 root 下，这个是并行的吗？ +### 测试数据库执行计划中，task cop 在一个 root 下，这个是并行的吗？ 目前 TiDB 的计算任务隶属于两种不同的 task：cop task 和 root task。cop task 是指被下推到 KV 端分布式执行的计算任务，root task 是指在 TiDB 端单点执行的计算任务。 @@ -393,11 +393,11 @@ ID 没什么规律，只要是唯一就行。不过在生成执行计划时， ## 数据库优化 -### TiDB 参数及调整 +### 测试数据库参数及调整 详情参考 [TiDB 配置参数](/command-line-flags-for-tidb-configuration.md)。 -### 如何避免热点问题并实现负载均衡？TiDB 中是否有热分区或热范围问题？ +### 如何避免热点问题并实现负载均衡？测试数据库中是否有热分区或热范围问题？ 要了解热点问题的场景，请参考[常见热点问题](/troubleshoot-hot-spot-issues.md#常见热点场景)。TiDB 的以下特性旨在帮助解决热点问题： diff --git a/faq/tidb-faq.md b/faq/tidb-faq.md index 1e8dae0804ff..be7f0614113b 100644 --- a/faq/tidb-faq.md +++ b/faq/tidb-faq.md @@ -3,19 +3,19 @@ title: TiDB 产品常见问题 summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型数据库，支持在线事务处理与在线分析处理，具备水平扩容、高可用、实时 HTAP、云原生的特性。TiDB 不是基于 MySQL 开发的，而是由 PingCAP 团队完全自主开发的产品。TiDB 易用性很高，支持绝大部分 MySQL 8.0 的语法，但不支持触发器、存储过程、自定义函数等。TiDB 支持分布式事务，兼容 MySQL Client/Driver 的编程语言，支持其他存储引擎，如 TiKV、UniStore 和 MockTiKV。获取 TiDB 知识的途径包括官方文档、官方博客、AskTUG 社区论坛和 PingCAP Education。用户名长度限制为 32 个字符，最大列数为 1017，单行大小不超过 6MB。TiDB 不支持 XA，但支持对列存储引擎的高并发 INSERT 或 UPDATE 操作。 --- -# TiDB 产品常见问题 +# 测试数据库产品常见问题 -## 1.1 TiDB 介绍及整体架构 +## 1.1 测试数据库介绍及整体架构 -### 1.1.1 TiDB 是什么？ +### 1.1.1 测试数据库是什么？ [TiDB](https://github.com/pingcap/tidb) 是 [PingCAP](https://pingcap.com/about-cn/) 公司自主设计、研发的开源分布式关系型数据库，是一款同时支持在线事务处理与在线分析处理 (Hybrid Transactional and Analytical Processing, HTAP) 的融合型分布式数据库产品，具备水平扩容或者缩容、金融级高可用、实时 HTAP、云原生的分布式数据库、兼容 MySQL 协议和 MySQL 生态等重要特性。目标是为用户提供一站式 OLTP (Online Transactional Processing)、OLAP (Online Analytical Processing)、HTAP 解决方案。TiDB 适合高可用、强一致要求较高、数据规模较大等各种应用场景。更多详细信息，请参阅 [TiDB 简介](/overview.md)。 -### 1.1.2 TiDB 整体架构 +### 1.1.2 测试数据库整体架构 参见 [TiDB 整体架构](/tidb-architecture.md)，以及 TiDB 数据库的[存储](/tidb-storage.md)、[计算](/tidb-computing.md)与[调度](/tidb-scheduling.md)。 -### 1.1.3 TiDB 是基于 MySQL 开发的吗？ +### 1.1.3 测试数据库是基于 MySQL 开发的吗？ 不是。虽然 TiDB 支持 MySQL 语法和协议，但是 TiDB 是由 PingCAP 团队完全自主开发的产品。 @@ -25,25 +25,25 @@ summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型 - TiKV 是分布式 Key-Value 存储引擎，用来存储真正的数据，简而言之，TiKV 是 TiDB 的存储引擎。 - PD 是 TiDB 集群的管理组件，负责存储 TiKV 的元数据，同时也负责分配时间戳以及对 TiKV 做负载均衡调度。 -### 1.1.5 TiDB 易用性如何？ +### 1.1.5 测试数据库易用性如何？ TiDB 使用起来很简单，可以将 TiDB 集群当成 MySQL 来用。你可以将 TiDB 用在任何以 MySQL 作为后台存储服务的应用中，并且基本上不需要修改应用代码，同时你可以用大部分流行的 MySQL 管理工具来管理 TiDB。 -### 1.1.6 TiDB 和 MySQL 兼容性如何？ +### 1.1.6 测试数据库和 MySQL 兼容性如何？ TiDB 支持绝大部分 MySQL 8.0 的语法，但目前还不支持触发器、存储过程、自定义函数等。详情参见[与 MySQL 兼容性对比](/mysql-compatibility.md)。 -### 1.1.7 TiDB 支持分布式事务吗？ +### 1.1.7 测试数据库支持分布式事务吗？ 支持。无论是一个地方的几个节点，还是[跨多个数据中心的多个节点](/multi-data-centers-in-one-city-deployment.md)，TiDB 均支持 ACID 分布式事务。 TiDB 事务模型灵感源自 Google Percolator 模型，主体是一个两阶段提交协议，并进行了一些实用的优化。该模型依赖于一个时间戳分配器，为每个事务分配单调递增的时间戳，这样就检测到事务冲突。在 TiDB 集群中，[PD](/tidb-scheduling.md) 承担时间戳分配器的角色。 -### 1.1.8 TiDB 支持哪些编程语言？ +### 1.1.8 测试数据库支持哪些编程语言？ 只要支持 MySQL Client/Driver 的编程语言，都可以直接使用 TiDB。 -### 1.1.9 TiDB 是否支持其他存储引擎？ +### 1.1.9 测试数据库是否支持其他存储引擎？ 是的，除了 TiKV 之外，TiDB 还支持一些单机存储引擎，比如 UniStore 和 MockTiKV。注意，TiDB 后续版本可能不再支持 MockTiKV。 @@ -70,25 +70,25 @@ Usage of ./bin/tidb-server: ...... ``` -### 1.1.10 除了官方文档，有没有其他 TiDB 知识获取途径？ +### 1.1.10 除了官方文档，有没有其他测试数据库知识获取途径？ - [官方文档](https://docs.pingcap.com/zh/)：获取 TiDB 相关知识最主要、最及时的途径。 - [官方博客](https://cn.pingcap.com/blog/)：了解产品技术解读、观点洞察、案例实践。 - [AskTUG 社区论坛](https://asktug.com)：与社区用户、技术专家互动交流。 - [PingCAP Education](https://cn.pingcap.com/education/)：学习线上课程，获得数据库能力认证。 -### 1.1.11 TiDB 用户名长度限制？ +### 1.1.11 测试数据库用户名长度限制？ 在 TiDB 中，用户名最长为 32 个字符。 -### 1.1.12 TiDB 中列数和行大小的限制是多少？ +### 1.1.12 测试数据库中列数和行大小的限制是多少？ - TiDB 中默认的最大列数为 1017。你可以调整这个限制，最大可调整到 4096 列。 - TiDB 中默认单行大小不超过 6 MB。你可以调整这个限制，最大可调整到 120 MB。 更多信息，请参考 [TiDB 限制](/tidb-limitations.md)。 -### 1.1.13 TiDB 是否支持 XA？ +### 1.1.13 测试数据库是否支持 XA？ 虽然 TiDB 的 JDBC 驱动用的就是 MySQL Connector/J，但是当使用 Atomikos 的时候，数据源要配置成类似这样的配置：`type="com.mysql.jdbc.jdbc2.optional.MysqlXADataSource"`。MySQL JDBC XADataSource 连接 TiDB 的模式目前是不支持的。MySQL JDBC 中配置好的 XADataSource 模式，只对 MySQL 数据库起作用（DML 去修改 redo 等）。 @@ -96,7 +96,7 @@ Atomikos 配好两个数据源后，JDBC 驱动都要设置成 XA 模式，然 MySQL 是单机数据库，只能通过 XA 来满足跨数据库事务，而 TiDB 本身就通过 Google 的 Percolator 事务模型支持分布式事务，性能稳定性比 XA 要高出很多，所以不会也不需要支持 XA。 -### 1.1.14 TiDB 如何在不影响性能的情况下支持对列存储引擎 (TiFlash) 的高并发 `INSERT` 或 `UPDATE` 操作？ +### 1.1.14 测试数据库如何在不影响性能的情况下支持对列存储引擎 (TiFlash) 的高并发 `INSERT` 或 `UPDATE` 操作？ - [TiFlash](/tiflash/tiflash-overview.md) 引入了 DeltaTree 这种特殊结构来处理列存引擎的修改。 - TiFlash 作为 Raft Group 中的 Learner 角色，不参与 log commit 选举，也不会写入数据。这意味着 DML 操作不需要等待 TiFlash 的确认，所以 TiFlash 不会影响 OLTP 的性能。另外，TiFlash 和 TiKV 分开部署在不同的实例上，不会相互影响。 @@ -105,13 +105,13 @@ MySQL 是单机数据库，只能通过 XA 来满足跨数据库事务，而 TiD TiFlash 默认保持数据强一致性。Raft Learner 流程会更新数据。此外 TSO 检查可以确保查询中的数据与事务完全一致。更多信息，请参考[异步复制](/tiflash/tiflash-overview.md#异步复制)和[一致性](/tiflash/tiflash-overview.md#一致性)。 -## 1.2 TiDB 原理 +## 1.2 测试数据库原理 ### 1.2.1 存储 TiKV 详细解读 [三篇文章了解 TiDB 技术内幕 - 说存储](https://cn.pingcap.com/blog/tidb-internal-1) -### 1.2.2 计算 TiDB 详细解读 +### 1.2.2 计算测试数据库详细解读 [三篇文章了解 TiDB 技术内幕 - 说计算](https://cn.pingcap.com/blog/tidb-internal-2) diff --git a/filter-binlog-event.md b/filter-binlog-event.md index 1bf5908aba01..6ded496d946a 100644 --- a/filter-binlog-event.md +++ b/filter-binlog-event.md @@ -97,7 +97,7 @@ filters: action: Do ``` -### 过滤 TiDB 不支持的 SQL 语句 +### 过滤测试数据库不支持的 SQL 语句 ``` filters: diff --git a/foreign-key.md b/foreign-key.md index ad1b96089a2f..a370767d57c7 100644 --- a/foreign-key.md +++ b/foreign-key.md @@ -283,7 +283,7 @@ mysql> explain analyze delete from parent where id = 1; ## 兼容性 -### TiDB 版本间兼容性 +### 测试数据库版本间兼容性 TiDB 在 v6.6.0 之前已经支持创建外键的语法，但创建的外键并不生效。如果将之前创建的 TiDB 集群升级到 v6.6.0 及之后的版本，之前创建的外键依然是不生效的，可以先删除不生效的外键后再创建外键使外键约束生效。只有在 v6.6.0 及之后版本中新创建的外键才生效。你可以使用 `SHOW CREATE TABLE` 语句查看外键是否生效，不生效的外键会有一条 `/* FOREIGN KEY INVALID */` 注释。 @@ -299,14 +299,14 @@ Create Table | CREATE TABLE `child` ( ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin ``` -### 与 TiDB 工具的兼容性 +### 与测试数据库工具的兼容性 - [DM](/dm/dm-overview.md) 不兼容外键功能。DM 在同步数据到下游 TiDB 时，会显式关闭下游 TiDB 的 [`foreign_key_checks`](/system-variables.md#foreign_key_checks)，所以由外键产生的级联操作不会从上游同步到下游，这会导致上下游数据不一致。 - [TiCDC](/ticdc/ticdc-overview.md) v6.6.0 兼容外键功能。旧版本的 TiCDC 在同步带外键的表时，可能会报错，建议使用 v6.6.0 之前版本 TiCDC 时先关闭下游 TiDB 集群的 `foreign_key_checks`。 - [BR](/br/backup-and-restore-overview.md) v6.6.0 兼容外键功能。之前版本的 BR 在恢复带外键的表到 v6.6.0 及之后版本的集群时，可能会报错，建议先关闭下游 TiDB 集群的 `foreign_key_checks` 后再恢复集群。 - [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 导入数据到 TiDB 前，如果目标表使用了外键，建议先关闭 TiDB 集群的 `foreign_key_checks`。对于 v6.6.0 之前的版本，关闭该系统变量也不会生效，你需要为下游数据库用户添加 `REFERENCES` 权限，或者提前手动在下游数据库中创建好目标表，以确保顺利导入数据。 - [Dumpling](/dumpling-overview.md) 兼容外键功能。 -- [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) 在对比上下游数据时，如果上下游数据库的版本不一样，且下游 TiDB 中存在[不生效的外键](#tidb-版本间兼容性)，则 sync-diff-inspector 可能会报上下游表结构不一致的错误。因为 TiDB v6.6.0 会对表结构中不生效的外键添加一条 `/* FOREIGN KEY INVALID */` 注释。 +- [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) 在对比上下游数据时，如果上下游数据库的版本不一样，且下游 TiDB 中存在[不生效的外键](测试数据库版本间兼容性)，则 sync-diff-inspector 可能会报上下游表结构不一致的错误。因为 TiDB v6.6.0 会对表结构中不生效的外键添加一条 `/* FOREIGN KEY INVALID */` 注释。 ### 与 MySQL 的兼容性 diff --git a/functions-and-operators/aggregate-group-by-functions.md b/functions-and-operators/aggregate-group-by-functions.md index b8424cf2c785..adb4dd8e1a36 100644 --- a/functions-and-operators/aggregate-group-by-functions.md +++ b/functions-and-operators/aggregate-group-by-functions.md @@ -7,7 +7,7 @@ summary: TiDB支持的聚合函数包括 COUNT、COUNT(DISTINCT)、SUM、AVG、M 本文将详细介绍 TiDB 支持的聚合函数。 -## TiDB 支持的聚合函数 +## 测试数据库支持的聚合函数 TiDB 支持的 MySQL `GROUP BY` 聚合函数如下所示： diff --git a/functions-and-operators/information-functions.md b/functions-and-operators/information-functions.md index c3bd28fd388a..23742f57c6d4 100644 --- a/functions-and-operators/information-functions.md +++ b/functions-and-operators/information-functions.md @@ -7,7 +7,7 @@ summary: TiDB 支持 MySQL 8.0 中提供的大部分信息函数。 TiDB 支持使用 MySQL 8.0 中提供的大部分[信息函数](https://dev.mysql.com/doc/refman/8.0/en/information-functions.html)。 -## TiDB 支持的 MySQL 信息函数 +## 测试数据库支持的 MySQL 信息函数 | 函数名 | 功能描述 | | ------ | ---------------------------------------- | @@ -279,7 +279,7 @@ Store: tikv 如需更改该函数返回的版本，可以修改 [`server-version`](/tidb-configuration-file.md#server-version) 配置项。 -## TiDB 特有的信息函数 +## 测试数据库特有的信息函数 下列函数为 TiDB 中特有的信息函数，MySQL 中无对应的函数。 @@ -287,7 +287,7 @@ Store: tikv | ------ | ---------------------------------------- | | [`CURRENT_RESOURCE_GROUP()`](/functions-and-operators/tidb-functions.md#current_resource_group) | 返回当前连接的资源组名 | -## TiDB 不支持的信息函数 +## 测试数据库不支持的信息函数 * `CHARSET()` * `COERCIBILITY()` diff --git a/functions-and-operators/tidb-functions.md b/functions-and-operators/tidb-functions.md index 8ff820badc69..a17a4aa75663 100644 --- a/functions-and-operators/tidb-functions.md +++ b/functions-and-operators/tidb-functions.md @@ -3,7 +3,7 @@ title: TiDB 特有的函数 summary: 学习使用 TiDB 特有的函数。 --- -# TiDB 特有的函数 +# 测试数据库特有的函数 以下函数为 TiDB 中特有的函数，与 MySQL 不兼容： diff --git a/get-started-with-tidb-lightning.md b/get-started-with-tidb-lightning.md index 3f74b6ae26bd..9f020bb7af8b 100644 --- a/get-started-with-tidb-lightning.md +++ b/get-started-with-tidb-lightning.md @@ -42,7 +42,7 @@ summary: TiDB Lightning 可快速将 MySQL 数据导入到 TiDB 集群中。首 导出的全量备份数据将保存在 `/data/my_database` 目录中。 -## 第 2 步：部署 TiDB 集群 +## 第 2 步：部署测试数据库集群 在开始导入数据之前，你需要先部署一个要进行导入的 TiDB 集群。如果你已经有 TiDB 集群，可以跳过这一步。 diff --git a/glossary.md b/glossary.md index 593fee6d2950..8dbf9e818162 100644 --- a/glossary.md +++ b/glossary.md @@ -21,7 +21,7 @@ ACID 是指数据库管理系统在写入或更新资料的过程中，为保证 * 原子性 (atomicity) 指一个事务中的所有操作，或者全部完成，或者全部不完成，不会结束在中间某个环节。TiDB 通过 Primary Key 所在 [Region](#regionpeerraft-group) 的原子性来保证分布式事务的原子性。 * 一致性 (consistency) 指在事务开始之前和结束以后，数据库的完整性没有被破坏。TiDB 在写入数据之前，会校验数据的一致性，校验通过才会写入内存并返回成功。 -* 隔离性 (isolation) 指数据库允许多个并发事务同时对其数据进行读写和修改的能力。隔离性可以防止多个事务并发执行时由于交叉执行而导致数据的不一致，主要用于处理并发场景。关于 TiDB 支持的隔离级别，请参考 [TiDB 事务隔离级别](/transaction-isolation-levels.md#tidb-事务隔离级别)。 +* 隔离性 (isolation) 指数据库允许多个并发事务同时对其数据进行读写和修改的能力。隔离性可以防止多个事务并发执行时由于交叉执行而导致数据的不一致，主要用于处理并发场景。关于 TiDB 支持的隔离级别，请参考 [测试数据库事务隔离级别](/transaction-isolation-levels.md#测试数据库事务隔离级别)。 * 持久性 (durability) 指事务处理结束后，对数据的修改就是永久的，即便系统故障也不会丢失。在 TiDB 中，事务一旦提交成功，数据全部持久化存储到 TiKV，此时即使 TiDB 服务器宕机也不会出现数据丢失。 ## B diff --git a/grafana-tidb-dashboard.md b/grafana-tidb-dashboard.md index c8bc4b57f9ae..c6bed930ff52 100644 --- a/grafana-tidb-dashboard.md +++ b/grafana-tidb-dashboard.md @@ -3,7 +3,7 @@ title: TiDB 监控指标 summary: 了解 Grafana Dashboard 中展示的关键指标。 --- -# TiDB 重要监控指标详解 +# 测试数据库重要监控指标详解 使用 TiUP 部署 TiDB 集群时，你可以一键部署监控系统 (Prometheus & Grafana)，参考监控架构 [TiDB 监控框架概述](/tidb-monitoring-framework.md)。 diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index 46bc3a1884b9..73f748ad44f8 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -3,7 +3,7 @@ title: TiDB 软件和硬件环境需求 summary: TiDB 是一款开源的一站式实时 HTAP 数据库，支持部署在多种硬件环境和操作系统上。软件和硬件环境建议配置包括操作系统要求、编译和运行依赖库、Docker 镜像依赖、软件配置要求、服务器建议配置、网络要求、磁盘空间要求、客户端 Web 浏览器要求以及 TiFlash 存算分离架构的软硬件要求。 --- -# TiDB 软件和硬件环境需求 +# 测试数据库软件和硬件环境需求 -# TiDB 配置文件描述 +# 测试数据库配置文件描述 TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/config.toml.example](https://github.com/pingcap/tidb/blob/release-8.5/pkg/config/config.toml.example) 找到默认值的配置文件，重命名为 `config.toml` 即可。本文档只介绍未包含在[命令行参数](/command-line-flags-for-tidb-configuration.md)中的参数。 diff --git a/tidb-distributed-execution-framework.md b/tidb-distributed-execution-framework.md index 5f09d8105d02..c132d6efed39 100644 --- a/tidb-distributed-execution-framework.md +++ b/tidb-distributed-execution-framework.md @@ -3,7 +3,7 @@ title: TiDB 分布式执行框架 summary: 了解 TiDB 分布式执行框架的使用场景、限制、使用方法和实现原理。 --- -# TiDB 分布式执行框架 +# 测试数据库分布式执行框架 TiDB 采用计算存储分离架构，具有出色的扩展性和弹性的扩缩容能力。从 v7.1.0 开始，TiDB 引入了一个分布式执行框架，以进一步发挥分布式架构的资源优势。该框架的目标是对基于该框架的任务进行统一调度与分布式执行，并提供整体和单个任务两个维度的资源管理能力，更好地满足用户对于资源使用的预期。 diff --git a/tidb-global-sort.md b/tidb-global-sort.md index 750f767b6973..66d29d4aa1a4 100644 --- a/tidb-global-sort.md +++ b/tidb-global-sort.md @@ -3,7 +3,7 @@ title: TiDB 全局排序 summary: 了解 TiDB 全局排序功能的使用场景、限制、使用方法和实现原理。 --- -# TiDB 全局排序 +# 测试数据库全局排序 > **注意：** > diff --git a/tidb-in-kubernetes.md b/tidb-in-kubernetes.md index 4de95ac839b8..85277f93d1fc 100644 --- a/tidb-in-kubernetes.md +++ b/tidb-in-kubernetes.md @@ -3,7 +3,7 @@ title: 在 Kubernetes 上部署 TiDB 集群 summary: 你可以使用 TiDB Operator 在 Kubernetes 上部署 TiDB。TiDB Operator 是 Kubernetes 上的 TiDB 集群自动运维系统，提供部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或自托管的 Kubernetes 集群上。TiDB Operator 的文档目前独立于 TiDB 文档。要查看如何在 Kubernetes 上部署 TiDB 的详细步骤，请参阅对应版本的 TiDB Operator 文档。 --- -# 在 Kubernetes 上部署 TiDB 集群 +# 在 Kubernetes 上部署测试数据库集群 你可以使用 [TiDB Operator](https://github.com/pingcap/tidb-operator) 在 Kubernetes 上部署 TiDB 集群。TiDB Operator 是 Kubernetes 上的 TiDB 集群自动运维系统，提供包括部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或自托管的 Kubernetes 集群上。 diff --git a/tidb-lightning/tidb-lightning-glossary.md b/tidb-lightning/tidb-lightning-glossary.md index e71868e3ec7e..7206e5df7c2c 100644 --- a/tidb-lightning/tidb-lightning-glossary.md +++ b/tidb-lightning/tidb-lightning-glossary.md @@ -119,7 +119,7 @@ TiDB Lightning 通过引擎将数据传送到 TiKV Importer 中。TiDB Lightning 导入模式。指通过降低读取速度和减少空间使用，来优化 TiKV 写入的配置模式。 -导入过程中，TiDB Lightning 自动在导入模式和[普通模式](#normal-mode)中来回切换。如果 TiKV 卡在导入模式，你可以使用 `tidb-lightning-ctl` [强制切换回普通模式](/tidb-lightning/troubleshoot-tidb-lightning.md#使用-tidb-lightning-后tidb-集群变慢cpu-占用高)。 +导入过程中，TiDB Lightning 自动在导入模式和[普通模式](#normal-mode)中来回切换。如果 TiKV 卡在导入模式，你可以使用 `tidb-lightning-ctl` [强制切换回普通模式](/tidb-lightning/troubleshoot-tidb-lightning.md#使用-tidb-lightning-后测试数据库集群变慢cpu-占用高)。 ### Index engine diff --git a/tidb-lightning/troubleshoot-tidb-lightning.md b/tidb-lightning/troubleshoot-tidb-lightning.md index ee9565901d3f..f4d2e8c11429 100644 --- a/tidb-lightning/troubleshoot-tidb-lightning.md +++ b/tidb-lightning/troubleshoot-tidb-lightning.md @@ -50,7 +50,7 @@ strict-format = true 另外，如果从 TiDB Lightning 的 log 的最后一条日志显示遇到的错误是 "Context canceled"，需要在日志中搜索第一条 "ERROR" 级别的日志。在这条日志之前，通常也会紧跟有一条 "got signal to exit"，表示 Lightning 是收到中断信号然后退出的。 -## 使用 TiDB Lightning 后，TiDB 集群变慢，CPU 占用高 +## 使用 TiDB Lightning 后，测试数据库集群变慢，CPU 占用高 如果 `tidb-lightning` 异常退出，集群可能仍处于“导入模式” (import mode)，该模式不适用于生产环境。此时可执行以下命令查看当前使用的模式： diff --git a/tidb-monitoring-api.md b/tidb-monitoring-api.md index 2d71118359e1..7a1dbedba354 100644 --- a/tidb-monitoring-api.md +++ b/tidb-monitoring-api.md @@ -3,7 +3,7 @@ title: TiDB 集群监控 API summary: TiDB 提供状态接口和 Metrics 接口来监控集群状态。状态接口可获取 TiDB Server 的运行状态和存储信息，PD 的状态接口可查看整个 TiKV 集群的详细信息。Metrics 接口用于监控整个集群的状态和性能。部署 Prometheus 和 Grafana 后，配置 Grafana 即可使用 Metrics 接口。 --- -# TiDB 集群监控 API +# 测试数据库集群监控 API TiDB 提供了以下几种接口来监控集群状态： diff --git a/tidb-monitoring-framework.md b/tidb-monitoring-framework.md index 31c6bf7ef82d..03e6349bb9e1 100644 --- a/tidb-monitoring-framework.md +++ b/tidb-monitoring-framework.md @@ -3,11 +3,11 @@ title: TiDB 监控框架概述 summary: TiDB 使用 Prometheus 作为监控和性能指标存储，Grafana 用于可视化展示。Prometheus 提供多个组件，包括 Prometheus Server、Client 代码库和 Alertmanager。Grafana 展示 TiDB 集群各组件的相关监控，分组包括备份恢复、Binlog、网络探活、磁盘性能、Kafka、TiDB Lightning 等。每个分组包含多个监控项页签，以及详细的监控指标看板。观看培训视频可快速了解监控与报警系统的体系、数据流转方式、系统管理方法和常用监控指标。 --- -# TiDB 监控框架概述 +# 测试数据库监控框架概述 TiDB 使用开源时序数据库 [Prometheus](https://prometheus.io) 作为监控和性能指标信息存储方案，使用 [Grafana](https://grafana.com/grafana) 作为可视化组件进行展示。 -## Prometheus 在 TiDB 中的应用 +## Prometheus 在测试数据库中的应用 Prometheus 是一个拥有多维度数据模型的、灵活的查询语句的时序数据库。Prometheus 作为热门的开源项目，拥有活跃的社区及众多的成功案例。 @@ -21,7 +21,7 @@ Prometheus 提供了多个组件供用户使用。目前，TiDB 使用了以下 ![Prometheus in TiDB](/media/prometheus-in-tidb.png) -## Grafana 在 TiDB 中的应用 +## Grafana 在测试数据库中的应用 Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana 来展示 TiDB 集群各组件的相关监控，监控项分组如下图所示： @@ -51,6 +51,6 @@ Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana ![Grafana Overview](/media/grafana_monitor_overview.png) -要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#tidb-报警规则)，请以文档内容为准。 +要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#测试数据库报警规则)，请以文档内容为准。 diff --git a/tidb-scheduling.md b/tidb-scheduling.md index b88a408d3d8d..24a4358b3b77 100644 --- a/tidb-scheduling.md +++ b/tidb-scheduling.md @@ -3,7 +3,7 @@ title: TiDB 数据库的调度 summary: TiDB 数据库的调度由 PD（Placement Driver）模块负责管理和实时调度集群数据。PD 需要收集节点和 Region 的状态信息，并根据调度策略制定调度计划，包括增加 / 删除副本、迁移 Leader 角色等基本操作。调度需满足副本数量、位置分布、负载均衡、存储空间利用等需求。PD 通过心跳包收集信息，并根据策略生成调度操作序列，但具体执行由 Region Leader 决定。 --- -# TiDB 数据库的调度 +# 测试数据库数据库的调度 [PD](https://github.com/tikv/pd) (Placement Driver) 是 TiDB 集群的管理模块，同时也负责集群数据的实时调度。本文档介绍一下 PD 的设计思想和关键概念。 diff --git a/tidb-storage.md b/tidb-storage.md index 29a06f473cdf..6d5499666cc5 100644 --- a/tidb-storage.md +++ b/tidb-storage.md @@ -3,7 +3,7 @@ title: TiDB 数据库的存储 summary: 了解 TiDB 数据库的存储层。 --- -# TiDB 数据库的存储 +# 测试数据库数据库的存储 本文主要介绍 [TiKV](https://github.com/tikv/tikv) 的一些设计思想和关键概念。 diff --git a/tidb-troubleshooting-map.md b/tidb-troubleshooting-map.md index 36f11525971e..a5314bb2a74a 100644 --- a/tidb-troubleshooting-map.md +++ b/tidb-troubleshooting-map.md @@ -3,7 +3,7 @@ title: TiDB 集群问题导图 summary: 了解如何处理 TiDB 集群常见问题。 --- -# TiDB 集群问题导图 +# 测试数据库集群问题导图 本篇文档总结了使用 TiDB 及其组件时的常见错误。遇到相关错误时，可以通过本文档的问题导图来排查错误原因并进行处理。 @@ -50,7 +50,7 @@ summary: 了解如何处理 TiDB 集群常见问题。 - 2.2.5 其他原因，请参考[读写延迟增加](/troubleshoot-cpu-issues.md)。 -## 3. TiDB 问题 +## 3. 测试数据库问题 ### 3.1 DDL @@ -179,7 +179,7 @@ TiDB 作为分布式数据库，内建负载均衡机制，尽可能将业务负 TiDB 提供了完整的方案用于排查、解决或规避这类热点。通过均衡负载热点，可以提升整体性能，包括提高 QPS 和降低延迟等。详情参见 [TiDB 热点问题处理](/troubleshoot-hot-spot-issues.md)。 -### 3.7 TiDB 磁盘 I/O 过高 +### 3.7 测试数据库磁盘 I/O 过高 当出现系统响应变慢的时候，如果已经排查了 CPU 的瓶颈、数据事务冲突的瓶颈后，问题仍存在，就需要从 I/O 来入手来辅助判断目前的系统瓶颈点。参考 [TiDB 磁盘 I/O 过高的处理办法](/troubleshoot-high-disk-io.md)了解如何定位和处理 TiDB 存储 I/O 过高的问题。 diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index eee253950c5a..a54612209a2d 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -338,7 +338,7 @@ delta_index_cache_size = 0 TiFlash 支持单节点多盘部署。如果你的部署节点上有多块硬盘，可以通过以下的方式配置参数，提高节点的硬盘 I/O 利用率。TiUP 中参数配置格式参照[详细 TiFlash 配置模版](/tiflash-deployment-topology.md#拓扑模版)。 -#### TiDB 集群版本低于 v4.0.9 +#### 测试数据库集群版本低于 v4.0.9 TiDB v4.0.9 之前的版本中，TiFlash 只支持将存储引擎中的主要数据分布在多盘上。通过 `path`（TiUP 中为 `data_dir`）和 `path_realtime_mode` 这两个参数配置多盘部署。 @@ -348,9 +348,9 @@ TiDB v4.0.9 之前的版本中，TiFlash 只支持将存储引擎中的主要数 如果节点上有多块规格不一致的硬盘，推荐把 `path_relatime_mode` 参数设置为 `true`，并且把性能最好的硬盘目录放在 `path` 参数内的最前面。这表示第一个目录只会存放最新数据，较旧的数据会在其他目录之间进行均衡。注意此情况下，第一个目录规划的容量大小需要占总容量的约 10%。 -#### TiDB 集群版本为 v4.0.9 及以上 +#### 测试数据库集群版本为 v4.0.9 及以上 -TiDB v4.0.9 及之后的版本中，TiFlash 支持将存储引擎的主要数据和新数据都分布在多盘上。多盘部署时，推荐使用 `[storage]` 中的参数，以更好地利用节点的 I/O 性能。但 TiFlash 仍然支持 [TiDB 集群版本低于 v4.0.9](#tidb-集群版本低于-v409) 中的参数。 +TiDB v4.0.9 及之后的版本中，TiFlash 支持将存储引擎的主要数据和新数据都分布在多盘上。多盘部署时，推荐使用 `[storage]` 中的参数，以更好地利用节点的 I/O 性能。但 TiFlash 仍然支持 [测试数据库集群版本低于 v4.0.9](测试数据库集群版本低于-v409) 中的参数。 如果节点上有多块相同规格的硬盘，推荐把硬盘目录填到 `storage.main.dir` 列表中，`storage.latest.dir` 列表留空。TiFlash 会在所有存储目录之间分摊 I/O 压力以及进行数据均衡。 diff --git a/tiflash/tune-tiflash-performance.md b/tiflash/tune-tiflash-performance.md index f9f4433c62c5..5bf6238a8761 100644 --- a/tiflash/tune-tiflash-performance.md +++ b/tiflash/tune-tiflash-performance.md @@ -11,7 +11,7 @@ summary: 介绍 TiFlash 性能调优的方法，包括机器资源规划和 TiDB 对于希望节省机器资源，并且完全没有隔离要求的场景，可以使用 TiKV 和 TiFlash 联合部署。建议为 TiKV 与 TiFlash 分别留够资源，同时避免共享磁盘。 -## TiDB 相关参数调优 +## 测试数据库相关参数调优 本部分介绍如何通过调整 TiDB 相关参数来提升 TiFlash 性能，具体包括如下几个方面： diff --git a/tiflash/use-tidb-to-read-tiflash.md b/tiflash/use-tidb-to-read-tiflash.md index 65ab251169a9..7f6f9f22e780 100644 --- a/tiflash/use-tidb-to-read-tiflash.md +++ b/tiflash/use-tidb-to-read-tiflash.md @@ -3,7 +3,7 @@ title: 使用 TiDB 读取 TiFlash summary: 了解如何使用 TiDB 读取 TiFlash 副本。 --- -# 使用 TiDB 读取 TiFlash +# 使用测试数据库读取 TiFlash 本文档介绍如何使用 TiDB 读取 TiFlash 副本。 diff --git a/time-to-live.md b/time-to-live.md index 7cb14c226c59..5bed0035b6b9 100644 --- a/time-to-live.md +++ b/time-to-live.md @@ -218,7 +218,7 @@ TiDB 会定时采集 TTL 的运行时信息，并在 Grafana 中提供了相关 其中列 `table_id` 为分区表 ID，而 `parent_table_id` 为表的 ID，与 `information_schema.tables` 表中的 ID 对应。`table_schema`、`table_name`、`partition_name` 分别对应表示数据库、表名、分区名。`create_time`、`finish_time`、`ttl_expire` 分别表示 TTL 任务的创建时间、结束时间和过期时间。`expired_rows` 与 `deleted_rows` 表示过期行数与成功删除的行数。 -## TiDB 数据迁移工具兼容性 +## 测试数据库数据迁移工具兼容性 TTL 功能能够与 TiDB 的迁移、备份、恢复工具一同使用。 @@ -228,7 +228,7 @@ TTL 功能能够与 TiDB 的迁移、备份、恢复工具一同使用。 | TiDB Lightning | v6.6.0 | 导入后如果表中有 TTL 属性，会自动将表的 `TTL_ENABLE` 属性设置为 `OFF`，关闭 TTL。这样可以防止 TiDB 在导入后立即删除过期的数据。此时你需要手动重新配置 `TTL_ENABLE` 属性来重新开启各个表的 TTL。 | | TiCDC | v7.0.0 | 上游的 TTL 删除将会同步至下游。因此，为了防止重复删除，下游表的 `TTL_ENABLE` 属性将被强制设置为 `OFF`。 | -## 与 TiDB 其他特性的兼容性 +## 与测试数据库其他特性的兼容性 | 特性名称 | 说明 | | :-- | :---- | diff --git a/tiproxy/tiproxy-load-balance.md b/tiproxy/tiproxy-load-balance.md index 37350cdb215f..fbe50481fca0 100644 --- a/tiproxy/tiproxy-load-balance.md +++ b/tiproxy/tiproxy-load-balance.md @@ -129,7 +129,7 @@ TiProxy 根据自身与 TiDB server 的地理位置，将连接优先路由到 TiProxy 根据自身和 TiDB server 的 `zone` 标签确定各自的地理位置。你需要同时设置以下配置项： -- 在 TiDB server 的 [`labels`](/tidb-configuration-file.md#labels) 配置项中将 `zone` 设置为当前可用区。配置方式请参阅[设置 TiDB 的 `labels`](/schedule-replicas-by-topology-labels.md#设置-tidb-的-labels可选)。 +- 在 TiDB server 的 [`labels`](/tidb-configuration-file.md#labels) 配置项中将 `zone` 设置为当前可用区。配置方式请参阅[设置测试数据库的 `labels`](/schedule-replicas-by-topology-labels.md#设置测试数据库的-labels可选)。 - 在 TiProxy 的 [`labels`](/tiproxy/tiproxy-configuration.md#labels) 配置项中将 `zone` 设置为当前可用区。 如果是使用 TiDB Operator 部署的集群，请参考[数据的高可用](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/configure-a-tidb-cluster#数据的高可用)进行配置。 diff --git a/tiproxy/tiproxy-overview.md b/tiproxy/tiproxy-overview.md index 183b7989b720..9a4e9e28c368 100644 --- a/tiproxy/tiproxy-overview.md +++ b/tiproxy/tiproxy-overview.md @@ -140,7 +140,7 @@ TiProxy 不适用于以下场景： tiup cluster upgrade --tiproxy-version ``` -### 重启 TiDB 集群 +### 重启测试数据库集群 使用 [`tiup cluster restart`](/tiup/tiup-component-cluster-restart.md) 重启 TiDB 集群时，TiDB server 不是滚动重启，会导致连接断开，请尽量避免使用。 diff --git a/tiup/tiup-cluster-topology-reference.md b/tiup/tiup-cluster-topology-reference.md index 37685e12f08f..8ac4474283cc 100644 --- a/tiup/tiup-cluster-topology-reference.md +++ b/tiup/tiup-cluster-topology-reference.md @@ -3,7 +3,7 @@ title: 通过 TiUP 部署 TiDB 集群的拓扑文件配置 summary: 介绍通过 TiUP 部署或扩容 TiDB 集群时提供的拓扑文件配置和示例。 --- -# 通过 TiUP 部署 TiDB 集群的拓扑文件配置 +# 通过 TiUP 部署测试数据库集群的拓扑文件配置 通过 TiUP 部署或扩容 TiDB 集群时，需要提供一份拓扑文件（[示例](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)）来描述集群拓扑。 diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index abd55090ce3a..725b2f02af37 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -3,7 +3,7 @@ title: 使用 TiUP 部署运维 TiDB 线上集群 summary: 使用 TiUP 的 cluster 组件可以快速部署生产集群，并提供强大的生产集群管理功能，包括升级、缩容、扩容、操作、审计等。部署集群的命令为 tiup cluster deploy，部署完成后可以通过 tiup cluster list 查看集群列表。启动集群的命令为 tiup cluster start，查看集群状态的命令为 tiup cluster display。可以使用 tiup cluster scale-in 进行集群缩容，tiup cluster scale-out 进行集群扩容。另外，还可以使用 tiup cluster upgrade 进行滚动升级，使用 tiup cluster edit-config 进行配置更新。最后，可以使用 tiup cluster exec 在集群节点机器上执行命令。 --- -# 使用 TiUP 部署运维 TiDB 线上集群 +# 使用 TiUP 部署运维测试数据库线上集群 本文重在介绍如何使用 TiUP 的 cluster 组件，如果需要线上部署的完整步骤，可参考[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。 diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 3b3087babc7b..4de65a1d8798 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -3,7 +3,7 @@ title: 本地快速部署 TiDB 集群 summary: TiDB 集群是分布式系统，由多个组件构成。想要快速体验 TiDB，可以使用 TiUP 中的 playground 组件快速搭建本地测试环境。通过命令行参数可以设置各组件的数量和配置，也可以启动多个组件实例。使用 `tiup client` 可以快速连接到本地启动的 TiDB 集群。还可以查看已启动集群的信息，扩容或缩容集群。 --- -# 本地快速部署 TiDB 集群 +# 本地快速部署测试数据库集群 TiDB 集群是由多个组件构成的分布式系统，一个典型的 TiDB 集群至少由 3 个 PD 节点、3 个 TiKV 节点和 2 个 TiDB 节点构成。对于想要快速体验 TiDB 的用户来说，手工部署这么多组件是非常耗时且麻烦的事情。本文介绍 TiUP 中的 playground 组件，以及如何通过 playground 组件快速搭建一套本地的 TiDB 测试环境。 @@ -31,7 +31,7 @@ tiup playground --help ## 使用示例 -### 查看可用的 TiDB 版本 +### 查看可用的测试数据库版本 {{< copyable "shell-regular" >}} @@ -39,7 +39,7 @@ tiup playground --help tiup list tidb ``` -### 启动一个指定版本的 TiDB 集群 +### 启动一个指定版本的测试数据库集群 {{< copyable "shell-regular" >}} @@ -49,7 +49,7 @@ tiup playground ${version} 将 `${version}` 替换为所需的版本号。 -### 启动一个每日构建版的 TiDB 集群 +### 启动一个每日构建版的测试数据库集群 {{< copyable "shell-regular" >}} @@ -99,7 +99,7 @@ tiup playground --tag ${tag_name} 以这种方式启动的集群，在集群关闭以后，数据文件会保留。下一次可以继续使用该 tag 启动集群，从而使用从上一次集群关闭时的数据。 -## 快速连接到由 playground 启动的 TiDB 集群 +## 快速连接到由 playground 启动的测试数据库集群 TiUP 提供了 `client` 组件，用于自动寻找并连接 playground 在本地启动的 TiDB 集群，使用方式为： diff --git a/transaction-isolation-levels.md b/transaction-isolation-levels.md index 9de6d8209605..0f26a8a11613 100644 --- a/transaction-isolation-levels.md +++ b/transaction-isolation-levels.md @@ -3,7 +3,7 @@ title: TiDB 事务隔离级别 summary: 了解 TiDB 事务的隔离级别。 --- -# TiDB 事务隔离级别 +# 测试数据库事务隔离级别 事务隔离级别是数据库事务处理的基础，[ACID](/glossary.md#acid) 中的 “I”，即 Isolation，指的就是事务的隔离性。 diff --git a/transaction-overview.md b/transaction-overview.md index e83722f6548f..1887922312da 100644 --- a/transaction-overview.md +++ b/transaction-overview.md @@ -3,7 +3,7 @@ title: TiDB 事务概览 summary: 了解 TiDB 中的事务。 --- -# TiDB 事务概览 +# 测试数据库事务概览 TiDB 支持分布式事务，提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。TiDB 3.0.8 及以后版本，TiDB 默认采用悲观事务模式。 diff --git a/troubleshoot-cpu-issues.md b/troubleshoot-cpu-issues.md index 78ef2460868e..06ea1e39169d 100644 --- a/troubleshoot-cpu-issues.md +++ b/troubleshoot-cpu-issues.md @@ -9,7 +9,7 @@ summary: 介绍读写延时增加、抖动时的排查思路，可能的原因 ## 常见原因 -### TiDB 执行计划不对导致延迟增高 +### 测试数据库执行计划不对导致延迟增高 查询语句的执行计划不稳定，偶尔执行计划选择错误的索引，导致查询延迟增加。 diff --git a/troubleshoot-high-disk-io.md b/troubleshoot-high-disk-io.md index 2c60d916ca4d..899878db7cb7 100644 --- a/troubleshoot-high-disk-io.md +++ b/troubleshoot-high-disk-io.md @@ -3,7 +3,7 @@ title: TiDB 磁盘 I/O 过高的处理办法 summary: 了解如何定位和处理 TiDB 存储 I/O 过高的问题。 --- -# TiDB 磁盘 I/O 过高的处理办法 +# 测试数据库磁盘 I/O 过高的处理办法 本文主要介绍如何定位和处理 TiDB 存储 I/O 过高的问题。 diff --git a/troubleshoot-hot-spot-issues.md b/troubleshoot-hot-spot-issues.md index 0ba60941ad97..a6112d64b0a1 100644 --- a/troubleshoot-hot-spot-issues.md +++ b/troubleshoot-hot-spot-issues.md @@ -3,7 +3,7 @@ title: TiDB 热点问题处理 summary: TiDB 热点问题处理：介绍定位和解决读写热点问题，包括常见热点场景、确定存在热点问题的方法、使用 TiDB Dashboard 定位热点表、使用 SHARD_ROW_ID_BITS 处理热点表、使用 AUTO_RANDOM 处理自增主键热点表、小表热点的优化、打散读热点。 --- -# TiDB 热点问题处理 +# 测试数据库热点问题处理 本文介绍如何定位和解决读写热点问题。 @@ -13,7 +13,7 @@ TiDB 提供了完整的方案用于排查、解决或规避这类热点。通过 ## 常见热点场景 -### TiDB 编码规则回顾 +### 测试数据库编码规则回顾 TiDB 对每个表分配一个 TableID，每一个索引都会分配一个 IndexID，每一行分配一个 RowID（默认情况下，如果表使用整数型的 Primary Key，那么会用 Primary Key 的值当做 RowID）。其中 TableID 在整个集群内唯一，IndexID/RowID 在表内唯一，这些 ID 都是 int64 类型。 diff --git a/troubleshoot-lock-conflicts.md b/troubleshoot-lock-conflicts.md index a21f79f6fccd..fe0989bf960b 100644 --- a/troubleshoot-lock-conflicts.md +++ b/troubleshoot-lock-conflicts.md @@ -3,7 +3,7 @@ title: TiDB 锁冲突问题处理 summary: 了解 TiDB 锁冲突问题以及处理方式。 --- -# TiDB 锁冲突问题处理 +# 测试数据库锁冲突问题处理 TiDB 支持完整的分布式事务，自 v3.0 版本起，提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。本文介绍如何使用 Lock View 排查锁相关的问题，以及如何处理使用乐观事务或者悲观事务的过程中常见的锁冲突问题。 diff --git a/troubleshoot-tidb-cluster.md b/troubleshoot-tidb-cluster.md index af0b255677f3..fe3b783ac751 100644 --- a/troubleshoot-tidb-cluster.md +++ b/troubleshoot-tidb-cluster.md @@ -3,7 +3,7 @@ title: TiDB 集群故障诊断 summary: TiDB 集群故障诊断包括收集出错信息、组件状态、日志信息、机器配置和 dmesg 中的问题。解决数据库连接问题需要确认服务是否启动，查看 tidb-server 日志并清空数据重新部署服务。解决 tidb-server 启动报错需检查参数、端口占用和 pd-server 连接。解决 tikv-server 启动报错需检查参数、端口占用和 pd-server 连接。解决 pd-server 启动报错需检查参数和端口占用。进程异常退出需检查是否在前台启动，使用 nohup+& 方式运行或写在脚本中。TiKV 进程异常重启需检查 OOM 信息和 panic log。连接被拒绝需确保网络参数正确。解决文件打开过多问题需确保 ulimit -n 足够大。数据库访问超时需检查拓扑结构、硬件配置、其他服务、操作、CPU 线程、网络 /IO 监控数据。 --- -# TiDB 集群故障诊断 +# 测试数据库集群故障诊断 当试用 TiDB 遇到问题时，请先参考本篇文档。如果问题未解决，请收集以下信息并通过 [TiDB 支持资源](/support.md)解决： diff --git a/tso.md b/tso.md index a36d0c77a673..f942c15410fa 100644 --- a/tso.md +++ b/tso.md @@ -3,7 +3,7 @@ title: TiDB 中的 TimeStamp Oracle (TSO) summary: 了解 TiDB 中的 TimeStamp Oracle (TSO)。 --- -# TiDB 中的 TimeStamp Oracle (TSO) +# 测试数据库中的 TimeStamp Oracle (TSO) 在 TiDB 中，Placement Driver (PD) 承担着 TSO 时间戳分配器的角色，负责为集群内各组件分配时间戳。这些时间戳用于为事务和数据分配时间标记。该分配机制对于在 TiDB 中启用 [Percolator](https://research.google.com/pubs/pub36726.html) 模型至关重要。Percolator 模型用于支持多版本并发控制（Multi-Version Concurrency Control, MVCC）和[事务管理](/transaction-overview.md)。 diff --git a/upgrade-monitoring-services.md b/upgrade-monitoring-services.md index 63ee4a2e8203..59b2a63c7133 100644 --- a/upgrade-monitoring-services.md +++ b/upgrade-monitoring-services.md @@ -3,7 +3,7 @@ title: 升级集群监控组件 summary: 介绍如何升级 TiDB 集群监控组件 Prometheus、Grafana 和 Alertmanager。 --- -# 升级 TiDB 集群监控组件 +# 升级测试数据库集群监控组件 使用 TiUP 部署 TiDB 集群时，TiUP 会同时自动部署 Prometheus、Grafana 和 Alertmanager 等监控组件，并且在集群扩容中自动为新增节点添加监控配置。通过 TiUP 自动部署的监控组件并不是这些三方组件的最新版本，如果你需要使用最新的三方组件，可以按照本文的方法升级所需的监控组件。 @@ -26,7 +26,7 @@ summary: 介绍如何升级 TiDB 集群监控组件 Prometheus、Grafana 和 Ale 从 [Prometheus 官网下载页面](https://prometheus.io/download/)下载组件安装包，并解压。 -### 第 2 步：下载 TiDB 官方 Prometheus 安装包 +### 第 2 步：下载测试数据库官方 Prometheus 安装包 1. 在 [TiDB 官网下载页面](https://cn.pingcap.com/product/#SelectProduct)下载 `TiDB-community-server` 软件包，并解压。 2. 在解压文件中，找到 `prometheus-v{version}-linux-amd64.tar.gz`，并解压。 @@ -66,7 +66,7 @@ tiup cluster patch prometheus-v{new-version}.tar.gz -R prometheus 1. 从 [Grafana 官网下载页面](https://grafana.com/grafana/download?pg=get&plcmt=selfmanaged-box1-cta1)下载组件安装包。你可以根据需要选择下载 `OSS` 版或 `Enterprise` 版。 2. 解压下载的软件包。 -### 第 2 步：下载 TiDB 官方 Grafana 安装包 +### 第 2 步：下载测试数据库官方 Grafana 安装包 1. 在 [TiDB 官网下载页面](https://cn.pingcap.com/product/#SelectProduct)下载 `TiDB-community-server` 软件包，并解压。 2. 在解压文件中，找到 `grafana-v{version}-linux-amd64.tar.gz`，并解压。 diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index 65da650608f5..5165868d5cb1 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -173,7 +173,7 @@ tiup cluster check --cluster 执行结束后，最后会输出 region status 检查结果。如果结果为 "All regions are healthy"，则说明当前集群中所有 region 均为健康状态，可以继续执行升级；如果结果为 "Regions are not fully healthy: m miss-peer, n pending-peer" 并提示 "Please fix unhealthy regions before other operations."，则说明当前集群中有 region 处在异常状态，应先排除相应异常状态，并再次检查结果为 "All regions are healthy" 后再继续升级。 -## 3. 升级 TiDB 集群 +## 3. 升级测试数据库集群 本部分介绍如何滚动升级 TiDB 集群以及如何进行升级后的验证。 @@ -297,7 +297,7 @@ Cluster version: v8.5.0 ### 4.2 升级到 v6.2.0 及以上版本时，如何解决升级卡住的问题 -从 v6.2.0 开始，TiDB 默认开启[并发 DDL 框架](/ddl-introduction.md#tidb-在线-ddl-异步变更的原理)执行并发 DDL。该框架改变了 DDL 作业存储方式，由 KV 队列变为表队列。这一变化可能会导致部分升级场景卡住。下面是一些会触发该问题的场景及解决方案： +从 v6.2.0 开始，TiDB 默认开启[并发 DDL 框架](/ddl-introduction.md#测试数据库在线-ddl-异步变更的原理)执行并发 DDL。该框架改变了 DDL 作业存储方式，由 KV 队列变为表队列。这一变化可能会导致部分升级场景卡住。下面是一些会触发该问题的场景及解决方案： - 加载插件导致的卡住 diff --git a/user-account-management.md b/user-account-management.md index 921e1ea978f7..93f99123b57a 100644 --- a/user-account-management.md +++ b/user-account-management.md @@ -3,7 +3,7 @@ title: TiDB 用户账户管理 summary: TiDB 用户账户管理主要包括用户名和密码设置、添加用户、删除用户、保留用户账户、设置资源限制、设置密码、忘记密码处理和刷新权限。用户可以通过 SQL 语句或图形化界面工具进行用户管理，同时可以使用 `FLUSH PRIVILEGES` 命令立即生效修改。 TiDB 在数据库初始化时会生成一个默认账户。 --- -# TiDB 用户账户管理 +# 测试数据库用户账户管理 本文档主要介绍如何管理 TiDB 用户账户。 diff --git a/vector-search-get-started-using-python.md b/vector-search-get-started-using-python.md index a29a0f2c8c02..ffa79c854fc5 100644 --- a/vector-search-get-started-using-python.md +++ b/vector-search-get-started-using-python.md @@ -51,7 +51,7 @@ pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv - `tidb-vector`：用于与 TiDB 向量搜索交互的 Python 客户端。 - [`sentence-transformers`](https://sbert.net)：提供预训练模型的 Python 库，用于从文本生成[向量嵌入](/vector-search-overview.md#向量嵌入)。 -### 第 3 步：配置 TiDB 集群的连接字符串 +### 第 3 步：配置测试数据库集群的连接字符串 根据不同的 TiDB 集群部署方式，配置集群的连接字符串。 @@ -134,7 +134,7 @@ def text_to_embedding(text): return embedding.tolist() ``` -### 第 5 步：连接到 TiDB 集群 +### 第 5 步：连接到测试数据库集群 使用 `TiDBVectorClient` 类连接到 TiDB 集群，并创建一个包含向量列的表 `embedded_documents`。 diff --git a/vector-search-get-started-using-sql.md b/vector-search-get-started-using-sql.md index d79a5d7e32ad..68355914ed47 100644 --- a/vector-search-get-started-using-sql.md +++ b/vector-search-get-started-using-sql.md @@ -32,7 +32,7 @@ TiDB 扩展了 MySQL 语法以支持[向量搜索](/vector-search-overview.md) ## 快速开始 -### 第 1 步：连接到 TiDB 集群 +### 第 1 步：连接到测试数据库集群 根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB 集群。 diff --git a/vector-search-integrate-with-django-orm.md b/vector-search-integrate-with-django-orm.md index 6f6d262a43f9..a36847aed01e 100644 --- a/vector-search-integrate-with-django-orm.md +++ b/vector-search-integrate-with-django-orm.md @@ -3,7 +3,7 @@ title: 在 Django ORM 中使用 TiDB 向量搜索 summary: 了解如何在 Django ORM 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 Django ORM 中使用 TiDB 向量搜索 +# 在 Django ORM 中使用测试数据库向量搜索 本文档将展示如何使用 [Django](https://www.djangoproject.com/) ORM 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -175,7 +175,7 @@ python manage.py runserver 你可以参考以下示例代码片段来完成自己的应用程序开发。 -### 连接到 TiDB 集群 +### 连接到测试数据库集群 打开 `sample_project/settings.py` 文件，添加以下配置： diff --git a/vector-search-integrate-with-jinaai-embedding.md b/vector-search-integrate-with-jinaai-embedding.md index ddc26e79bcf7..9c16103f0058 100644 --- a/vector-search-integrate-with-jinaai-embedding.md +++ b/vector-search-integrate-with-jinaai-embedding.md @@ -3,7 +3,7 @@ title: 结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索 summary: 了解如何结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索，以存储向量嵌入信息并执行语义搜索。 --- -# 结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索 +# 结合 Jina AI 嵌入模型 API 使用测试数据库向量搜索 本文档将展示如何使用 [Jina AI](https://jina.ai/) 为文本数据生成向量嵌入，然后将向量嵌入存储在 TiDB 中，并根据向量嵌入搜索相似文本。 @@ -174,7 +174,7 @@ def generate_embeddings(text: str): return response.json()['data'][0]['embedding'] ``` -### 连接到 TiDB 集群 +### 连接到测试数据库集群 通过 SQLAlchemy 连接 TiDB 集群： @@ -249,7 +249,7 @@ with Session(engine) as session: session.commit() ``` -### 使用 Jina AI 生成的向量嵌入在 TiDB 中执行语义搜索 +### 使用 Jina AI 生成的向量嵌入在测试数据库中执行语义搜索 通过 Jina AI 的嵌入 API 生成查询文本的向量嵌入，然后根据**查询文本的向量嵌入**和**向量表中各个向量嵌入**之间的余弦距离搜索最相关的 `document`： diff --git a/vector-search-integrate-with-langchain.md b/vector-search-integrate-with-langchain.md index b91a7591935d..18661dc07de6 100644 --- a/vector-search-integrate-with-langchain.md +++ b/vector-search-integrate-with-langchain.md @@ -3,7 +3,7 @@ title: 在 LangChain 中使用 TiDB 向量搜索 summary: 展示如何在 LangChain 中使用 TiDB 向量搜索 --- -# 在 LangChain 中使用 TiDB 向量搜索 +# 在 LangChain 中使用测试数据库向量搜索 本文档将展示如何在 [LangChain](https://python.langchain.com/) 中使用 [TiDB 向量搜索](/vector-search-overview.md)。 diff --git a/vector-search-integrate-with-llamaindex.md b/vector-search-integrate-with-llamaindex.md index d3408d396d4e..539ee9be87e5 100644 --- a/vector-search-integrate-with-llamaindex.md +++ b/vector-search-integrate-with-llamaindex.md @@ -3,7 +3,7 @@ title: 在 LlamaIndex 中使用 TiDB 向量搜索 summary: 了解如何在 LlamaIndex 中使用 TiDB 向量搜索。 --- -# 在 LlamaIndex 中使用 TiDB 向量搜索 +# 在 LlamaIndex 中使用测试数据库向量搜索 本文档将展示如何在 [LlamaIndex](https://www.llamaindex.ai) 中使用 [TiDB 向量搜索](/vector-search-overview.md)。 @@ -168,7 +168,7 @@ for index, document in enumerate(documents): ### 第 5 步：生成并存储文档向量 -#### 5.1 初始化 TiDB 向量存储 +#### 5.1 初始化测试数据库向量存储 以下代码将在 TiDB 中创建一个 `paul_graham_test` 表，该表针对向量搜索进行了优化。 diff --git a/vector-search-integrate-with-peewee.md b/vector-search-integrate-with-peewee.md index 064d951dd222..189f4849fdaa 100644 --- a/vector-search-integrate-with-peewee.md +++ b/vector-search-integrate-with-peewee.md @@ -3,7 +3,7 @@ title: 在 peewee 中使用 TiDB 向量搜索 summary: 了解如何在 peewee 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 peewee 中使用 TiDB 向量搜索 +# 在 peewee 中使用测试数据库向量搜索 本文档将展示如何使用 [peewee](https://docs.peewee-orm.com/) 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -168,7 +168,7 @@ Get documents within a certain distance: ### 创建向量表 -#### 连接到 TiDB 集群 +#### 连接到测试数据库集群 ```python import os diff --git a/vector-search-integrate-with-sqlalchemy.md b/vector-search-integrate-with-sqlalchemy.md index 6f25678c9c98..218c6ebf8e82 100644 --- a/vector-search-integrate-with-sqlalchemy.md +++ b/vector-search-integrate-with-sqlalchemy.md @@ -3,7 +3,7 @@ title: 在 SQLAlchemy 中使用 TiDB 向量搜索 summary: 了解如何在 SQLAlchemy 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 SQLAlchemy 中使用 TiDB 向量搜索 +# 在 SQLAlchemy 中使用测试数据库向量搜索 本文档将展示如何使用 [SQLAlchemy](https://www.sqlalchemy.org/) 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -152,7 +152,7 @@ Get documents within a certain distance: ### 创建向量表 -#### 连接到 TiDB 集群 +#### 连接到测试数据库集群 ```python import os From b248f984de99bcc1ae4f3f067a00643bc35cd370 Mon Sep 17 00:00:00 2001 From: qiancai Date: Wed, 25 Dec 2024 16:03:24 +0800 Subject: [PATCH 2/3] Revert "test2" This reverts commit faeb1a5a0f0daa9746fc2cbbacbca9a200272760. --- .vaunt/add-tidb-docs-dash-badge.md | 2 +- CONTRIBUTING.md | 4 +- README.md | 4 +- accelerated-table-creation.md | 4 +- alert-rules.md | 4 +- analyze-slow-queries.md | 2 +- auto-increment.md | 2 +- auto-random.md | 2 +- basic-features.md | 2 +- benchmark/benchmark-sysbench-v2.md | 2 +- benchmark/benchmark-sysbench-v3.md | 4 +- .../benchmark-sysbench-v5.1.0-vs-v5.0.2.md | 4 +- .../benchmark-sysbench-v5.2.0-vs-v5.1.1.md | 4 +- .../benchmark-sysbench-v5.3.0-vs-v5.2.2.md | 4 +- .../benchmark-sysbench-v5.4.0-vs-v5.3.0.md | 4 +- .../benchmark-sysbench-v6.0.0-vs-v5.4.0.md | 4 +- .../benchmark-sysbench-v6.1.0-vs-v6.0.0.md | 4 +- .../benchmark-sysbench-v6.2.0-vs-v6.1.0.md | 4 +- benchmark/benchmark-tidb-using-ch.md | 2 +- benchmark/benchmark-tidb-using-sysbench.md | 4 +- benchmark/benchmark-tidb-using-tpcc.md | 2 +- benchmark/benchmark-tpch.md | 2 +- ...line-workloads-and-add-index-operations.md | 2 +- ...-performance-benchmarking-with-sysbench.md | 4 +- ...v3.0-performance-benchmarking-with-tpcc.md | 4 +- ...v5.1-performance-benchmarking-with-tpcc.md | 4 +- ...v5.2-performance-benchmarking-with-tpcc.md | 4 +- ...v5.3-performance-benchmarking-with-tpcc.md | 4 +- ...v5.4-performance-benchmarking-with-tpcc.md | 4 +- ...v6.0-performance-benchmarking-with-tpcc.md | 4 +- ...v6.1-performance-benchmarking-with-tpcc.md | 4 +- ...v6.2-performance-benchmarking-with-tpcc.md | 4 +- best-practices-for-security-configuration.md | 4 +- best-practices-on-public-cloud.md | 6 +-- .../grafana-monitor-best-practices.md | 2 +- best-practices/haproxy-best-practices.md | 2 +- .../high-concurrency-best-practices.md | 4 +- best-practices/java-app-best-practices.md | 2 +- best-practices/readonly-nodes.md | 2 +- best-practices/three-dc-local-read.md | 2 +- .../three-nodes-hybrid-deployment.md | 2 +- best-practices/tidb-best-practices.md | 4 +- binary-package.md | 2 +- br/backup-and-restore-design.md | 2 +- br/backup-and-restore-overview.md | 2 +- br/backup-and-restore-use-cases.md | 4 +- br/br-incremental-guide.md | 2 +- br/br-log-architecture.md | 2 +- br/br-pitr-guide.md | 2 +- br/br-pitr-manual.md | 2 +- br/br-snapshot-architecture.md | 2 +- br/br-snapshot-guide.md | 2 +- br/br-snapshot-manual.md | 6 +-- br/br-use-overview.md | 2 +- cached-tables.md | 4 +- certificate-authentication.md | 8 ++-- character-set-and-collation.md | 2 +- check-before-deployment.md | 2 +- clinic/clinic-collect-sql-query-plan.md | 2 +- clinic/clinic-data-instruction-for-tiup.md | 8 ++-- clinic/clinic-user-guide-for-tiup.md | 2 +- clinic/quick-start-with-clinic.md | 2 +- clustered-indexes.md | 4 +- command-line-flags-for-tidb-configuration.md | 2 +- comment-syntax.md | 2 +- configure-memory-usage.md | 2 +- credits.md | 6 +-- dashboard/dashboard-diagnostics-report.md | 2 +- dashboard/dashboard-ops-security.md | 2 +- ddl-introduction.md | 2 +- deploy-monitoring-services.md | 2 +- develop/dev-guide-build-cluster-in-cloud.md | 2 +- develop/dev-guide-overview.md | 8 ++-- develop/dev-guide-proxysql-integration.md | 8 ++-- develop/dev-guide-third-party-support.md | 2 +- ...v-guide-third-party-tools-compatibility.md | 8 ++-- develop/dev-guide-tidb-crud-sql.md | 2 +- develop/dev-guide-timeouts-in-tidb.md | 2 +- develop/dev-guide-use-temporary-tables.md | 2 +- dm/dm-binlog-event-filter.md | 2 +- dm/dm-enable-tls.md | 4 +- dm/dm-faq.md | 2 +- dm/dm-task-configuration-guide.md | 4 +- download-ecosystem-tools.md | 6 +-- dr-secondary-cluster.md | 4 +- dr-solution-introduction.md | 4 +- dumpling-overview.md | 4 +- dynamic-config.md | 2 +- ecosystem-tool-user-case.md | 6 +-- ecosystem-tool-user-guide.md | 4 +- enable-disk-spill-encrypt.md | 2 +- enable-tls-between-clients-and-servers.md | 4 +- enable-tls-between-components.md | 2 +- encryption-at-rest.md | 2 +- error-codes.md | 2 +- explain-overview.md | 2 +- faq/backup-and-restore-faq.md | 2 +- faq/deploy-and-maintain-faq.md | 16 +++---- faq/faq-overview.md | 2 +- faq/high-availability-faq.md | 4 +- faq/high-reliability-faq.md | 6 +-- faq/manage-cluster-faq.md | 46 +++++++++---------- faq/migration-tidb-faq.md | 18 ++++---- faq/monitor-faq.md | 2 +- faq/sql-faq.md | 36 +++++++-------- faq/tidb-faq.md | 34 +++++++------- filter-binlog-event.md | 2 +- foreign-key.md | 6 +-- .../aggregate-group-by-functions.md | 2 +- .../information-functions.md | 6 +-- functions-and-operators/tidb-functions.md | 2 +- get-started-with-tidb-lightning.md | 2 +- glossary.md | 2 +- grafana-tidb-dashboard.md | 2 +- hardware-and-software-requirements.md | 4 +- identify-slow-queries.md | 4 +- information-schema/information-schema.md | 2 +- log-redaction.md | 2 +- migrate-from-tidb-to-mysql.md | 2 +- migrate-from-tidb-to-tidb.md | 2 +- migration-overview.md | 2 +- mysql-compatibility.md | 2 +- mysql-schema/mysql-schema-user.md | 2 +- optimistic-transaction.md | 2 +- oracle-functions-to-tidb.md | 2 +- overview.md | 2 +- partitioned-table.md | 4 +- password-management.md | 4 +- pd-recover.md | 6 +-- performance-schema/performance-schema.md | 2 +- performance-tuning-methods.md | 10 ++-- performance-tuning-overview.md | 2 +- pessimistic-transaction.md | 2 +- post-installation-check.md | 4 +- privilege-management.md | 2 +- production-deployment-using-tiup.md | 4 +- quick-start-with-tidb.md | 2 +- read-historical-data.md | 2 +- releases/release-5.0.0.md | 4 +- releases/release-5.2.0.md | 2 +- releases/release-5.3.0.md | 4 +- releases/release-5.4.0.md | 2 +- releases/release-6.0.0-dmr.md | 2 +- releases/release-6.4.0.md | 4 +- releases/release-7.3.0.md | 2 +- releases/release-7.4.0.md | 2 +- releases/release-notes.md | 2 +- releases/release-timeline.md | 2 +- releases/versioning.md | 4 +- resources/tidb-pdf-generation-tutorial.md | 4 +- resources/tidb-terms.md | 2 +- scale-tidb-using-tiup.md | 2 +- schedule-replicas-by-topology-labels.md | 4 +- .../sql-statement-admin-show-ddl.md | 2 +- system-variables.md | 2 +- temporary-tables.md | 8 ++-- ticdc/deploy-ticdc.md | 6 +-- ticdc/integrate-confluent-using-ticdc.md | 2 +- ticdc/ticdc-avro-protocol.md | 6 +-- ticdc/ticdc-canal-json.md | 2 +- ticdc/ticdc-client-authentication.md | 2 +- ticdc/ticdc-faq.md | 4 +- ticdc/ticdc-manage-changefeed.md | 2 +- ticdc/ticdc-sink-to-cloud-storage.md | 2 +- ticdc/ticdc-sink-to-kafka.md | 2 +- ticdc/ticdc-upstream-downstream-check.md | 2 +- tidb-architecture.md | 2 +- tidb-computing.md | 2 +- tidb-configuration-file.md | 2 +- tidb-distributed-execution-framework.md | 2 +- tidb-global-sort.md | 2 +- tidb-in-kubernetes.md | 2 +- tidb-lightning/tidb-lightning-glossary.md | 2 +- tidb-lightning/troubleshoot-tidb-lightning.md | 2 +- tidb-monitoring-api.md | 2 +- tidb-monitoring-framework.md | 8 ++-- tidb-scheduling.md | 2 +- tidb-storage.md | 2 +- tidb-troubleshooting-map.md | 6 +-- tiflash/tiflash-configuration.md | 6 +-- tiflash/tune-tiflash-performance.md | 2 +- tiflash/use-tidb-to-read-tiflash.md | 2 +- time-to-live.md | 4 +- tiproxy/tiproxy-load-balance.md | 2 +- tiproxy/tiproxy-overview.md | 2 +- tiup/tiup-cluster-topology-reference.md | 2 +- tiup/tiup-cluster.md | 2 +- tiup/tiup-playground.md | 10 ++-- transaction-isolation-levels.md | 2 +- transaction-overview.md | 2 +- troubleshoot-cpu-issues.md | 2 +- troubleshoot-high-disk-io.md | 2 +- troubleshoot-hot-spot-issues.md | 4 +- troubleshoot-lock-conflicts.md | 2 +- troubleshoot-tidb-cluster.md | 2 +- tso.md | 2 +- upgrade-monitoring-services.md | 6 +-- upgrade-tidb-using-tiup.md | 4 +- user-account-management.md | 2 +- vector-search-get-started-using-python.md | 4 +- vector-search-get-started-using-sql.md | 2 +- vector-search-integrate-with-django-orm.md | 4 +- ...-search-integrate-with-jinaai-embedding.md | 6 +-- vector-search-integrate-with-langchain.md | 2 +- vector-search-integrate-with-llamaindex.md | 4 +- vector-search-integrate-with-peewee.md | 4 +- vector-search-integrate-with-sqlalchemy.md | 4 +- 207 files changed, 393 insertions(+), 393 deletions(-) diff --git a/.vaunt/add-tidb-docs-dash-badge.md b/.vaunt/add-tidb-docs-dash-badge.md index 02487c898700..a58e6368d1ba 100644 --- a/.vaunt/add-tidb-docs-dash-badge.md +++ b/.vaunt/add-tidb-docs-dash-badge.md @@ -1,4 +1,4 @@ -# 如何在你的 GitHub 个人资料页上添加测试数据库文档挑战赛徽章 +# 如何在你的 GitHub 个人资料页上添加 TiDB 文档挑战赛徽章 [GitHub 个人资料页](https://docs.github.com/zh/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)不仅仅是你的 GitHub 仓库的集合，更是你在编程领域中的专业身份标志。 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25675323b52c..a6d6e70f9983 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# 测试数据库中文文档贡献指南 +# TiDB 中文文档贡献指南 无论你是热爱技术的程序员，还是擅长书面表达的语言爱好者，亦或是纯粹想帮 TiDB 改进文档的热心小伙伴，都欢迎来为 TiDB 文档做贡献，一起打造更加易用友好的 TiDB 文档！ -## 我能为测试数据库文档做什么贡献？ +## 我能为 TiDB 文档做什么贡献？ 你可以在提升 TiDB 文档质量、易用性、维护效率、翻译效率等方面做贡献，比如： diff --git a/README.md b/README.md index 29b0b76cea73..859a99cc5792 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 测试数据库文档 +# TiDB 文档 欢迎来到 [TiDB](https://github.com/pingcap/tidb) 文档仓库！ @@ -8,7 +8,7 @@ 如果你想在本地定制输出符合特定场景需求的 PDF 格式的 TiDB 文档，例如对 TiDB 文档目录进行自由排序和删减，请参考[自助生成 TiDB 文档 PDF 教程](/resources/tidb-pdf-generation-tutorial.md)。 -## 测试数据库文档维护方式及版本说明 +## TiDB 文档维护方式及版本说明 目前，TiDB 的文档维护在以下 branch，对应着官网文档的不同版本： diff --git a/accelerated-table-creation.md b/accelerated-table-creation.md index 26322a1fefa4..8dc306dcff4c 100644 --- a/accelerated-table-creation.md +++ b/accelerated-table-creation.md @@ -3,7 +3,7 @@ title: 提升 TiDB 建表性能 summary: 介绍 TiDB 加速建表中的概念、原理、实现和影响。 --- -# 提升测试数据库建表性能 +# 提升 TiDB 建表性能 TiDB v7.6.0 引入了系统变量 [`tidb_ddl_version`](https://docs.pingcap.com/zh/tidb/v7.6/system-variables#tidb_ddl_version-从-v760-版本开始引入) 实现支持加速建表，可提升大批量建表的速度。从 v8.0.0 开始，该系统变量更名为 [`tidb_enable_fast_create_table`](/system-variables.md#tidb_enable_fast_create_table-从-v800-版本开始引入)。 @@ -11,7 +11,7 @@ TiDB v7.6.0 引入了系统变量 [`tidb_ddl_version`](https://docs.pingcap.com/ 合并后的批量建表语句在同一个事务内执行，如果其中一个语句失败，所有语句都会失败。 -## 与测试数据库工具的兼容性 +## 与 TiDB 工具的兼容性 - 在 TiDB v8.3.0 之前的版本中，[TiCDC](/ticdc/ticdc-overview.md) 不支持同步通过 TiDB 加速创建的表。从 v8.3.0 开始，TiCDC 可以正常同步这类表。 diff --git a/alert-rules.md b/alert-rules.md index 950dd48295e9..7dccc166eda6 100644 --- a/alert-rules.md +++ b/alert-rules.md @@ -3,7 +3,7 @@ title: TiDB 集群报警规则 summary: TiDB 集群中各组件的报警规则详解。 --- -# 测试数据库集群报警规则 +# TiDB 集群报警规则 本文介绍了 TiDB 集群中各组件的报警规则，包括 TiDB、TiKV、PD、TiFlash、TiCDC、Node_exporter 和 Blackbox_exporter 的各报警项的规则描述及处理方法。 @@ -15,7 +15,7 @@ summary: TiDB 集群中各组件的报警规则详解。 | 严重级别 | 服务可用性下降，需要用户密切关注异常指标 | | 警告级别 | 对某一问题或错误的提醒 | -## 测试数据库报警规则 +## TiDB 报警规则 本节介绍了 TiDB 组件的报警项。 diff --git a/analyze-slow-queries.md b/analyze-slow-queries.md index 3028b51662c9..8005c593560e 100644 --- a/analyze-slow-queries.md +++ b/analyze-slow-queries.md @@ -159,7 +159,7 @@ mysql> explain analyze select count(*) from t where a=(select max(t1.a) from t t 可以看到有 1 个子查询被提前执行，花费了 `7.76s`。 -### 测试数据库执行慢 +### TiDB 执行慢 这里我们假设 TiDB 的执行计划正确（不正确的情况在[分析优化器问题](#分析优化器问题)这一节中说明），但是执行上很慢； diff --git a/auto-increment.md b/auto-increment.md index 3c6ec80bbdb9..0894b3efac63 100644 --- a/auto-increment.md +++ b/auto-increment.md @@ -9,7 +9,7 @@ summary: 介绍 TiDB 的 `AUTO_INCREMENT` 列属性。 > **注意：** > -> 使用 `AUTO_INCREMENT` 可能会给生产环境带热点问题，因此推荐使用 [`AUTO_RANDOM`](/auto-random.md) 代替。详情请参考 [测试数据库热点问题处理](/troubleshoot-hot-spot-issues.md#测试数据库热点问题处理)。 +> 使用 `AUTO_INCREMENT` 可能会给生产环境带热点问题，因此推荐使用 [`AUTO_RANDOM`](/auto-random.md) 代替。详情请参考 [TiDB 热点问题处理](/troubleshoot-hot-spot-issues.md#tidb-热点问题处理)。 在 [`CREATE TABLE`](/sql-statements/sql-statement-create-table.md) 语句中也可以使用 `AUTO_INCREMENT` 参数来指定自增字段的初始值。 diff --git a/auto-random.md b/auto-random.md index 886980e31d1d..84bf027cce63 100644 --- a/auto-random.md +++ b/auto-random.md @@ -27,7 +27,7 @@ CREATE TABLE t (a BIGINT AUTO_RANDOM(5, 54), b VARCHAR(255), PRIMARY KEY (a)); CREATE TABLE t (a BIGINT AUTO_RANDOM(5, 54), b VARCHAR(255), PRIMARY KEY (a, b)); ``` -`AUTO_RANDOM` 关键字可以被包裹在 TiDB 可执行注释中，注释语法请参考 [测试数据库可执行注释](/comment-syntax.md#测试数据库可执行的注释语法)。 +`AUTO_RANDOM` 关键字可以被包裹在 TiDB 可执行注释中，注释语法请参考 [TiDB 可执行注释](/comment-syntax.md#tidb-可执行的注释语法)。 ```sql CREATE TABLE t (a bigint /*T![auto_rand] AUTO_RANDOM */, b VARCHAR(255), PRIMARY KEY (a)); diff --git a/basic-features.md b/basic-features.md index 8a5dec791e5b..8eb2b0eef0ae 100644 --- a/basic-features.md +++ b/basic-features.md @@ -3,7 +3,7 @@ title: TiDB 功能概览 summary: 了解 TiDB 的功能概览。 --- -# 测试数据库功能概览 +# TiDB 功能概览 本文列出了 TiDB 功能在不同版本中的支持变化情况，包括[长期支持版本 (LTS)](/releases/versioning.md#长期支持版本) 和最新的 LTS 版本之后的[开发里程碑版本 (DMR)](/releases/versioning.md#开发里程碑版本)。 diff --git a/benchmark/benchmark-sysbench-v2.md b/benchmark/benchmark-sysbench-v2.md index 7c9a47f8c9a4..ef5ce303a384 100644 --- a/benchmark/benchmark-sysbench-v2.md +++ b/benchmark/benchmark-sysbench-v2.md @@ -30,7 +30,7 @@ IDC 机器 ## 测试方案 -### 测试数据库版本信息 +### TiDB 版本信息 ### v1.0.8 diff --git a/benchmark/benchmark-sysbench-v3.md b/benchmark/benchmark-sysbench-v3.md index 88985e56e283..30c8f7050118 100644 --- a/benchmark/benchmark-sysbench-v3.md +++ b/benchmark/benchmark-sysbench-v3.md @@ -34,7 +34,7 @@ Sysbench 版本：1.1.0 使用 Sysbench 向集群导入 **16 张表，每张数据 1000 万**。通过 HAProxy 代理，分别以递增并发数向集群发送请求，单次并发测试时间 5 分钟。 -### 测试数据库版本信息 +### TiDB 版本信息 ### v2.1.0-rc.2 @@ -52,7 +52,7 @@ Sysbench 版本：1.1.0 | TiKV | 57c83dc4ebc93d38d77dc8f7d66db224760766cc | | PD | b64716707b7279a4ae822be767085ff17b5f3fea | -### 测试数据库参数配置 +### TiDB 参数配置 两版本 TiDB 均使用**默认配置**。 diff --git a/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md b/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md index f1075f528f31..a45240256eb9 100644 --- a/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md +++ b/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md @@ -33,7 +33,7 @@ summary: TiDB v5.1.0 在 OLTP 场景下的 Sysbench 性能表现对比 v5.0.2。 两个版本使用相同的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -63,7 +63,7 @@ pessimistic-txn.pipelined: true server.enable-request-batch: false ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md b/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md index b39458914047..e7c4769ac2fe 100644 --- a/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md +++ b/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md @@ -33,7 +33,7 @@ summary: TiDB v5.2.0 在 OLTP 场景下的 Sysbench 性能对比测试显示，P 两个版本使用相同的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -63,7 +63,7 @@ pessimistic-txn.pipelined: true server.enable-request-batch: false ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md b/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md index 7deb7a9ed790..6ab0cb0d16d2 100644 --- a/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md +++ b/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md @@ -33,7 +33,7 @@ summary: TiDB v5.3.0 和 v5.2.2 在 OLTP 场景下的 Sysbench 性能对比测 两个版本使用相同的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -62,7 +62,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md b/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md index fd60ec76a3f1..edf021fb5224 100644 --- a/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md +++ b/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md @@ -33,7 +33,7 @@ summary: TiDB v5.4.0 在 OLTP 场景下的 Sysbench 性能比 v5.3.0 有所提 两个版本使用相同的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -62,7 +62,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md b/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md index 72105f82d251..4a9ea0df0ebc 100644 --- a/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md +++ b/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.0.0 在 OLTP 场景下的 Sysbench 性能表现对比 v5.4.0。 两个版本使用相同的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -59,7 +59,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md b/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md index 8bef1b58ad76..3b8953af1e02 100644 --- a/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md +++ b/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.1.0 在 OLTP 场景下的 Sysbench 性能表现优于 v6.0.0。 两个版本使用相同的配置。 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -56,7 +56,7 @@ server.grpc-concurrency: 6 readpool.storage.normal-concurrency: 10 ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md b/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md index 3346893862c0..37c4b5ae941f 100644 --- a/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md +++ b/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.2.0 和 v6.1.0 在 OLTP 场景下的 Sysbench 性能对比测 两个版本使用相同的配置。 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -56,7 +56,7 @@ server.grpc-concurrency: 6 readpool.unified.max-thread-count: 10 ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-tidb-using-ch.md b/benchmark/benchmark-tidb-using-ch.md index 8ffbd7f995bf..d652ae304764 100644 --- a/benchmark/benchmark-tidb-using-ch.md +++ b/benchmark/benchmark-tidb-using-ch.md @@ -3,7 +3,7 @@ title: 如何对 TiDB 进行 CH-benCHmark 测试 summary: 本文介绍如何对 TiDB 进行 CH-benCHmark 测试。 --- -# 如何对测试数据库进行 CH-benCHmark 测试 +# 如何对 TiDB 进行 CH-benCHmark 测试 本文介绍如何对 TiDB 进行 CH-benCHmark 测试。 diff --git a/benchmark/benchmark-tidb-using-sysbench.md b/benchmark/benchmark-tidb-using-sysbench.md index b9218c0e0ea8..a12be2bcf992 100644 --- a/benchmark/benchmark-tidb-using-sysbench.md +++ b/benchmark/benchmark-tidb-using-sysbench.md @@ -9,7 +9,7 @@ summary: 使用 Sysbench 1.0 或更新版本测试 TiDB 性能。调整 TiDB 和 ## 测试方案 -### 测试数据库配置 +### TiDB 配置 升高日志级别，可以减少打印日志数量，对 TiDB 的性能有积极影响。具体在 TiUP 配置文件中加入： @@ -182,7 +182,7 @@ TiKV 的其他模块，如 storage readpool、coprocessor 和 gRPC 的最大并 通过 Grafana 的 TiKV Thread CPU 监控面板可以观察到其实际使用率。如出现多线程模块瓶颈，可以通过增加该模块并发度进行调整。 -### 在高并发压力下，TiKV 也未达到 CPU 使用瓶颈，为什么测试数据库的 CPU 利用率依然很低？ +### 在高并发压力下，TiKV 也未达到 CPU 使用瓶颈，为什么 TiDB 的 CPU 利用率依然很低？ 在某些高端设备上，使用的是 NUMA 架构的 CPU，跨 CPU 访问远端内存将极大降低性能。TiDB 默认将使用服务器所有 CPU，goroutine 的调度不可避免地会出现跨 CPU 内存访问。 diff --git a/benchmark/benchmark-tidb-using-tpcc.md b/benchmark/benchmark-tidb-using-tpcc.md index cf0020fa37d7..b53217be3696 100644 --- a/benchmark/benchmark-tidb-using-tpcc.md +++ b/benchmark/benchmark-tidb-using-tpcc.md @@ -3,7 +3,7 @@ title: 如何对 TiDB 进行 TPC-C 测试 summary: 本文介绍了如何对 TiDB 进行 TPC-C 测试。TPC-C 是一个对 OLTP 系统进行测试的规范，使用商品销售模型对系统进行测试，包含五类事务：NewOrder、Payment、OrderStatus、Delivery、StockLevel。测试使用 tpmC 值衡量系统最大有效吞吐量，以 NewOrder Transaction 为准。使用 go-tpc 进行测试实现，通过 TiUP 命令下载测试程序。测试包括数据导入、运行测试和清理测试数据。 --- -# 如何对测试数据库进行 TPC-C 测试 +# 如何对 TiDB 进行 TPC-C 测试 本文介绍如何对 TiDB 进行 [TPC-C](http://www.tpc.org/tpcc/) 测试。 diff --git a/benchmark/benchmark-tpch.md b/benchmark/benchmark-tpch.md index 996edd48cdfa..d9bd01120f39 100644 --- a/benchmark/benchmark-tpch.md +++ b/benchmark/benchmark-tpch.md @@ -53,7 +53,7 @@ summary: TiDB TPC-H 50G 性能测试报告显示，TiDB 2.0 在大部分查询 | 172.16.31.10 | PD \* 1 | | 172.16.31.4 | TiDB \* 1 | -### 测试数据库版本信息 +### TiDB 版本信息 TiDB 1.0: diff --git a/benchmark/online-workloads-and-add-index-operations.md b/benchmark/online-workloads-and-add-index-operations.md index c547d8fdca47..1a894ee40b48 100644 --- a/benchmark/online-workloads-and-add-index-operations.md +++ b/benchmark/online-workloads-and-add-index-operations.md @@ -31,7 +31,7 @@ TiDB 版本：v3.0.1 Sysbench 版本：1.0.17 -### 测试数据库参数配置 +### TiDB 参数配置 TiDB、TiKV 和 PD 均使用 [TiDB Operator](https://github.com/pingcap/tidb-operator) 默认配置。 diff --git a/benchmark/v3.0-performance-benchmarking-with-sysbench.md b/benchmark/v3.0-performance-benchmarking-with-sysbench.md index b0cb3504c8d8..de7ed220039f 100644 --- a/benchmark/v3.0-performance-benchmarking-with-sysbench.md +++ b/benchmark/v3.0-performance-benchmarking-with-sysbench.md @@ -70,7 +70,7 @@ sysbench $testname \ run --tables=16 --table-size=10000000 ``` -### 测试数据库版本信息 +### TiDB 版本信息 ### v3.0.0 @@ -88,7 +88,7 @@ sysbench $testname \ | TiKV | `b3cf3c8d642534ea6fa93d475a46da285cc6acbf` | | PD | `886362ebfb26ef0834935afc57bcee8a39c88e54` | -### 测试数据库参数配置 +### TiDB 参数配置 2.1 和 3.0 中开启 prepared plan cache（出于优化考虑，2.1 的 point select 与 read write 并未开启）： diff --git a/benchmark/v3.0-performance-benchmarking-with-tpcc.md b/benchmark/v3.0-performance-benchmarking-with-tpcc.md index 8c6d6673c797..b01fa9692b8a 100644 --- a/benchmark/v3.0-performance-benchmarking-with-tpcc.md +++ b/benchmark/v3.0-performance-benchmarking-with-tpcc.md @@ -40,7 +40,7 @@ git clone -b 5.0-mysql-support-opt https://github.com/pingcap/benchmarksql.git 使用 BenchmarkSQL 向集群导入 **1000 warehouse** 的数据。通过 HAProxy 代理，分别以递增并发数向集群发送请求，单次并发测试时间 10 分钟。 -### 测试数据库版本信息 +### TiDB 版本信息 ### v3.0.0 @@ -58,7 +58,7 @@ git clone -b 5.0-mysql-support-opt https://github.com/pingcap/benchmarksql.git | TiKV | b3cf3c8d642534ea6fa93d475a46da285cc6acbf | | PD | 886362ebfb26ef0834935afc57bcee8a39c88e54 | -### 测试数据库参数配置 +### TiDB 参数配置 ```toml [log] diff --git a/benchmark/v5.1-performance-benchmarking-with-tpcc.md b/benchmark/v5.1-performance-benchmarking-with-tpcc.md index 48f3ec9bdaca..8a523f3cf0a3 100644 --- a/benchmark/v5.1-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.1-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.1.0 在 TPC-C 性能上提升了 2.8%，测试环境为 AWS EC2 两个版本使用同样的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -65,7 +65,7 @@ storage.scheduler-worker-pool-size: 20 server.enable-request-batch: false ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.2-performance-benchmarking-with-tpcc.md b/benchmark/v5.2-performance-benchmarking-with-tpcc.md index 75b3017a2b02..f82f66b87c69 100644 --- a/benchmark/v5.2-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.2-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.2.0 在 TPC-C 性能上下降了 4.22%，测试环境为 AWS EC 两个版本使用同样的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -65,7 +65,7 @@ storage.scheduler-worker-pool-size: 20 server.enable-request-batch: false ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.3-performance-benchmarking-with-tpcc.md b/benchmark/v5.3-performance-benchmarking-with-tpcc.md index de98a300e2e2..2130833a9c44 100644 --- a/benchmark/v5.3-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.3-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.3.0 在 TPC-C 性能上略下降了 2.99%，与 v5.2.2 相比 两个版本使用同样的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -64,7 +64,7 @@ server.grpc-concurrency: 6 storage.scheduler-worker-pool-size: 20 ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.4-performance-benchmarking-with-tpcc.md b/benchmark/v5.4-performance-benchmarking-with-tpcc.md index c5166fbaf765..3831300d64f6 100644 --- a/benchmark/v5.4-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.4-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.4.0 在 TPC-C 性能上提升了 3.16%，测试结果显示不 两个版本使用同样的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -64,7 +64,7 @@ server.grpc-concurrency: 6 storage.scheduler-worker-pool-size: 20 ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.0-performance-benchmarking-with-tpcc.md b/benchmark/v6.0-performance-benchmarking-with-tpcc.md index 0d5207654bd3..033c382ddc37 100644 --- a/benchmark/v6.0-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.0-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.0.0 在 TPC-C 性能上比 v5.4.0 提升了 24.20%，表现更 两个版本使用同样的配置 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -61,7 +61,7 @@ rocksdb.max-background-jobs: 8 server.grpc-concurrency: 6 ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.1-performance-benchmarking-with-tpcc.md b/benchmark/v6.1-performance-benchmarking-with-tpcc.md index 93c316367adf..045caf09cc99 100644 --- a/benchmark/v6.1-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.1-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.1.0 在 TPC-C 性能上平均提升了 2.85%，分别为：50 两个版本使用同样的配置。 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -57,7 +57,7 @@ readpool.storage.normal-concurrency: 10 server.grpc-concurrency: 6 ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.2-performance-benchmarking-with-tpcc.md b/benchmark/v6.2-performance-benchmarking-with-tpcc.md index 9f85e2c0418d..0b83fbe7e552 100644 --- a/benchmark/v6.2-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.2-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.2.0 在 TPC-C 性能测试中相比 v6.1.0 下降了 2.00%， 两个版本使用同样的配置。 -#### 测试数据库参数配置 +#### TiDB 参数配置 {{< copyable "" >}} @@ -57,7 +57,7 @@ readpool.storage.normal-concurrency: 10 server.grpc-concurrency: 6 ``` -#### 测试数据库全局变量配置 +#### TiDB 全局变量配置 {{< copyable "sql" >}} diff --git a/best-practices-for-security-configuration.md b/best-practices-for-security-configuration.md index a8ce9940848c..daca3966fd3e 100644 --- a/best-practices-for-security-configuration.md +++ b/best-practices-for-security-configuration.md @@ -3,7 +3,7 @@ title: TiDB 安全配置最佳实践 summary: 介绍 TiDB 安全配置的最佳实践，帮助你降低潜在的安全风险。 --- -# 测试数据库安全配置最佳实践 +# TiDB 安全配置最佳实践 TiDB 的安全性对于保护数据完整性和机密性至关重要。本文提供了 TiDB 集群部署时的安全配置指南。遵循这些最佳实践可以有效降低潜在安全风险、防范数据泄露，并确保 TiDB 数据库系统能够持续稳定、可靠地运行。 @@ -118,6 +118,6 @@ sudo iptables -P INPUT DROP ## 解决第三方扫描器 MySQL 漏洞误报 -大多数漏洞扫描器在检测 MySQL 漏洞时，会根据版本信息来匹配 CVE 漏洞。由于 TiDB 仅兼容 MySQL 协议而非 MySQL 本身，基于版本信息的漏洞扫描可能导致误报。建议漏洞扫描应以原理扫描为主。当合规漏洞扫描工具要求 MySQL 版本时，你可以[修改服务器版本号](/faq/high-reliability-faq.md#我们的安全漏洞扫描工具对-mysql-version-有要求测试数据库是否支持修改-server-版本号呢)，以满足其要求。 +大多数漏洞扫描器在检测 MySQL 漏洞时，会根据版本信息来匹配 CVE 漏洞。由于 TiDB 仅兼容 MySQL 协议而非 MySQL 本身，基于版本信息的漏洞扫描可能导致误报。建议漏洞扫描应以原理扫描为主。当合规漏洞扫描工具要求 MySQL 版本时，你可以[修改服务器版本号](/faq/high-reliability-faq.md#我们的安全漏洞扫描工具对-mysql-version-有要求tidb-是否支持修改-server-版本号呢)，以满足其要求。 通过修改服务器版本号，可避免漏洞扫描器产生误报。[`server-version`](/tidb-configuration-file.md#server-version) 的值会被 TiDB 节点用于验证当前 TiDB 的版本。在进行 TiDB 集群升级前，请将 `server-version` 的值设置为空或者当前 TiDB 真实的版本值，避免出现非预期行为。 diff --git a/best-practices-on-public-cloud.md b/best-practices-on-public-cloud.md index 36f5f02a9bf1..619ffc0e0e7f 100644 --- a/best-practices-on-public-cloud.md +++ b/best-practices-on-public-cloud.md @@ -3,7 +3,7 @@ title: 在公有云上部署 TiDB 的最佳实践 summary: 了解在公有云上部署 TiDB 的最佳实践。 --- -# 在公有云上部署测试数据库的最佳实践 +# 在公有云上部署 TiDB 的最佳实践 随着公有云基础设施的普及，越来越多的用户选择在公有云上部署和管理 TiDB。然而，要想在公有云上充分发挥 TiDB 的性能，需要关注多个方面，包括性能优化、成本控制、系统可靠性和可扩展性。 @@ -160,7 +160,7 @@ Google Cloud 的[实时迁移功能](https://cloud.google.com/compute/docs/insta 通过使用该监控脚本，并在维护事件期间采取必要的措施，TiDB 集群可以更好地应对 Google Cloud 上的实时迁移事件，确保对查询处理和响应时间的影响最小以及系统的平稳运行。 -## 为具有高 QPS 的大规模测试数据库集群优化 PD 性能 +## 为具有高 QPS 的大规模 TiDB 集群优化 PD 性能 在 TiDB 集群中，一个活跃的 Placement Driver (PD) Server 承担着许多关键任务，例如处理提供 TSO (Timestamp Oracle) 和处理请求。然而，依赖单个活跃 PD Server 可能会限制 TiDB 集群的扩展性。 @@ -183,7 +183,7 @@ Google Cloud 的[实时迁移功能](https://cloud.google.com/compute/docs/insta tso-update-physical-interval = "10ms" # 默认值为 50ms ``` -#### 调整测试数据库全局变量 +#### 调整 TiDB 全局变量 除了 PD 配置外，启用 TSO 客户端攒批操作的等待功能可以进一步优化 TSO 客户端的行为。要启用此功能，可以将全局变量 [`tidb_tso_client_batch_max_wait_time`](/system-variables.md#tidb_tso_client_batch_max_wait_time-从-v530-版本开始引入) 设置为非零值： diff --git a/best-practices/grafana-monitor-best-practices.md b/best-practices/grafana-monitor-best-practices.md index 64afd2ffb41b..6fda9d06ece0 100644 --- a/best-practices/grafana-monitor-best-practices.md +++ b/best-practices/grafana-monitor-best-practices.md @@ -3,7 +3,7 @@ title: 使用 Grafana 监控 TiDB 的最佳实践 summary: 了解高效利用 Grafana 监控 TiDB 的七个技巧。 --- -# 使用 Grafana 监控测试数据库的最佳实践 +# 使用 Grafana 监控 TiDB 的最佳实践 [使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)时，如果在拓扑配置中添加了 Grafana 和 Prometheus，会部署一套 [Grafana + Prometheus 的监控平台](/tidb-monitoring-framework.md)，用于收集和展示 TiDB 集群各个组件和机器的 metric 信息。本文主要介绍使用 TiDB 监控的最佳实践，旨在帮助 TiDB 用户高效利用丰富的 metric 信息来分析 TiDB 的集群状态或进行故障诊断。 diff --git a/best-practices/haproxy-best-practices.md b/best-practices/haproxy-best-practices.md index 26eb037f6179..85879e9a9741 100644 --- a/best-practices/haproxy-best-practices.md +++ b/best-practices/haproxy-best-practices.md @@ -3,7 +3,7 @@ title: HAProxy 在 TiDB 中的最佳实践 summary: HAProxy 是 TiDB 中实现负载均衡的最佳实践。它提供 TCP 协议下的负载均衡能力，通过连接 HAProxy 提供的浮动 IP 对数据进行操作，实现 TiDB Server 层的负载均衡。HAProxy 提供高可用性、负载均衡、健康检查、会话保持、SSL 支持和监控统计等核心功能。部署 HAProxy 需要满足一定的硬件和软件要求，配置和启动 HAProxy 后即可实现数据库负载均衡。 --- -# HAProxy 在测试数据库中的最佳实践 +# HAProxy 在 TiDB 中的最佳实践 本文介绍 [HAProxy](https://github.com/haproxy/haproxy) 在 TiDB 中的最佳配置和使用方法。HAProxy 提供 TCP 协议下的负载均衡能力，TiDB 客户端通过连接 HAProxy 提供的浮动 IP 即可对数据进行操作，实现 TiDB Server 层的负载均衡。 diff --git a/best-practices/high-concurrency-best-practices.md b/best-practices/high-concurrency-best-practices.md index 9738cfac9dc2..e738aac014a4 100644 --- a/best-practices/high-concurrency-best-practices.md +++ b/best-practices/high-concurrency-best-practices.md @@ -3,7 +3,7 @@ title: TiDB 高并发写入场景最佳实践 summary: 了解 TiDB 在高并发写入场景下的最佳实践。 --- -# 测试数据库高并发写入场景最佳实践 +# TiDB 高并发写入场景最佳实践 在 TiDB 的使用过程中，一个典型场景是高并发批量写入数据到 TiDB。本文阐述了该场景中的常见问题，旨在给出一个业务的最佳实践，帮助读者避免因使用 TiDB 不当而影响业务开发。 @@ -26,7 +26,7 @@ summary: 了解 TiDB 在高并发写入场景下的最佳实践。 对于分布式数据库来说，除了本身的基础性能外，最重要的就是充分利用所有节点能力，避免让单个节点成为瓶颈。 -## 测试数据库数据分布原理 +## TiDB 数据分布原理 如果要解决以上挑战，需要从 TiDB 数据切分以及调度的原理开始讲起。这里只作简单说明，详情可参阅[谈调度](https://pingcap.com/blog-cn/tidb-internal-3/)。 diff --git a/best-practices/java-app-best-practices.md b/best-practices/java-app-best-practices.md index f657f1e78371..eb44c002eb9b 100644 --- a/best-practices/java-app-best-practices.md +++ b/best-practices/java-app-best-practices.md @@ -3,7 +3,7 @@ title: 开发 Java 应用使用 TiDB 的最佳实践 summary: 本文介绍了开发 Java 应用程序使用 TiDB 的常见问题与解决办法。TiDB 是高度兼容 MySQL 协议的数据库，基于 MySQL 开发的 Java 应用的最佳实践也多适用于 TiDB。 --- -# 开发 Java 应用使用测试数据库的最佳实践 +# 开发 Java 应用使用 TiDB 的最佳实践 本文主要介绍如何开发 Java 应用程序以更好地使用 TiDB，包括开发中的常见问题与最佳实践。 diff --git a/best-practices/readonly-nodes.md b/best-practices/readonly-nodes.md index 10af0000abba..c43f1fbb3093 100644 --- a/best-practices/readonly-nodes.md +++ b/best-practices/readonly-nodes.md @@ -107,7 +107,7 @@ tikv_servers: ### 3. 使用 Follower Read 功能读取只读节点 -#### 3.1 在测试数据库中使用 Follower Read +#### 3.1 在 TiDB 中使用 Follower Read 你可以将系统变量 [`tidb_replica_read`](/system-variables.md#tidb_replica_read-从-v40-版本开始引入) 设置为 `learner` 来读取只读节点上的数据： diff --git a/best-practices/three-dc-local-read.md b/best-practices/three-dc-local-read.md index 3788543a36f1..00209d00e2d6 100644 --- a/best-practices/three-dc-local-read.md +++ b/best-practices/three-dc-local-read.md @@ -7,7 +7,7 @@ summary: 了解通过 Stale Read 功能在三数据中心下就近读取数据 在三数据中心模式下，Region 的三个副本都会隔离在各个数据中心里。然而在强一致读的要求下，TiDB 的每一个查询都需要访问对应数据的 Leader 副本，而查询的来源可能和 Leader 所在的数据中心不一致，这就会引起跨数据中心的数据访问，从而造成访问的延迟上升。本文主要介绍使用 [Stale Read](/stale-read.md) 功能，以牺牲数据实时性的方式，避免跨数据中心的访问，从而降低访问的延迟。 -## 部署三数据中心的测试数据库集群 +## 部署三数据中心的 TiDB 集群 部署三数据中心的方法，参考[同城多数据中心部署 TiDB](/multi-data-centers-in-one-city-deployment.md)。 diff --git a/best-practices/three-nodes-hybrid-deployment.md b/best-practices/three-nodes-hybrid-deployment.md index 44f9cf2c419b..4b07847ff3df 100644 --- a/best-practices/three-nodes-hybrid-deployment.md +++ b/best-practices/three-nodes-hybrid-deployment.md @@ -114,7 +114,7 @@ tiup ctl:v tikv --host=${ip:port} modify-tikv-config -n gc.max_ > > 对于更新频繁的业务场景，限制 GC 流量可能会导致 MVCC 版本堆积，进而影响读取性能。所以这个参数的取值需要进行多次尝试，在性能抖动和性能衰退之间找一个比较平衡的取值。 -### 测试数据库参数调整 +### TiDB 参数调整 一般通过系统变量调整 TiDB 执行算子的优化参数，例如 `tidb_hash_join_concurrency`、`tidb_index_lookup_join_concurrency` 等。 diff --git a/best-practices/tidb-best-practices.md b/best-practices/tidb-best-practices.md index 60155f27541c..d917546b41ad 100644 --- a/best-practices/tidb-best-practices.md +++ b/best-practices/tidb-best-practices.md @@ -3,7 +3,7 @@ title: TiDB 最佳实践 summary: TiDB 最佳实践总结了使用 TiDB 的一些优化技巧，包括 Raft 一致性协议、分布式事务、数据分片、负载均衡、SQL 到 KV 的映射方案、二级索引的实现方法等。建议阅读官方文档和知乎专栏了解更多细节。部署时推荐使用 TiUP，导入数据时可对 TiKV 参数进行调优。在写入和查询时需注意事务大小限制和并发度设置。监控系统和日志查看也是了解系统状态的重要方法。适用场景包括数据量大、不希望做 Sharding、需要事务和强一致性等。 --- -# 测试数据库最佳实践 +# TiDB 最佳实践 本文档总结使用 TiDB 时的一些最佳实践，主要涉及 SQL 使用和 OLAP/OLTP 优化技巧，特别是一些 TiDB 专有的优化开关。 @@ -187,7 +187,7 @@ TiDB [使用 Grafana + Prometheus 监控系统状态](/tidb-monitoring-framework + 知乎专栏：[TiDB 的后花园](https://zhuanlan.zhihu.com/newsql) + [官方博客](https://pingcap.com/blog-cn/) -## 测试数据库的最佳适用场景 +## TiDB 的最佳适用场景 简单来说，TiDB 适合具备下面这些特点的场景： diff --git a/binary-package.md b/binary-package.md index 4298d7a95c65..bbc355251a4a 100644 --- a/binary-package.md +++ b/binary-package.md @@ -3,7 +3,7 @@ title: TiDB 离线包 summary: 了解 TiDB 离线包及其包含的内容。 --- -# 测试数据库离线包 +# TiDB 离线包 在[使用 TiUP 离线部署 TiDB](/production-deployment-using-tiup.md#离线部署) 前，你需要在[官方下载页面](https://cn.pingcap.com/product-community/)选择对应版本的 TiDB server 离线镜像包（包含 TiUP 离线组件包）。 diff --git a/br/backup-and-restore-design.md b/br/backup-and-restore-design.md index 7e07409e3f6c..2bf7d685d97b 100644 --- a/br/backup-and-restore-design.md +++ b/br/backup-and-restore-design.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复功能架构概述 summary: 了解 TiDB 的备份与恢复功能的架构设计。 --- -# 测试数据库备份与恢复功能架构概述 +# TiDB 备份与恢复功能架构概述 正如 [TiDB 备份与恢复概述](/br/backup-and-restore-overview.md)所介绍，TiDB 备份恢复功能包含了多种不同类型的集群数据对象的备份与恢复实现。这些功能都以 Backup & Restore (BR) 和 TiDB Operator 为使用入口，创建相应的任务从 TiKV 节点上备份数据，或者恢复数据到 TiKV 节点。 diff --git a/br/backup-and-restore-overview.md b/br/backup-and-restore-overview.md index b735a9463457..4d58e2cfec8e 100644 --- a/br/backup-and-restore-overview.md +++ b/br/backup-and-restore-overview.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复概述 summary: 了解不同场景下如何使用 TiDB 的备份与恢复功能，以及不同功能、版本间的兼容性。 --- -# 测试数据库备份与恢复概述 +# TiDB 备份与恢复概述 基于 Raft 协议和合理的部署拓扑规划，TiDB 实现了集群的高可用，当集群中少数节点挂掉时，集群依然能对外提供服务。在此基础上，为了更进一步保证用户数据的安全，TiDB 还提供了集群的备份与恢复 (Backup & Restore, BR) 功能，作为数据安全的最后一道防线，使得集群能够免于严重的自然灾害，提供业务误操作“复原”的能力。 diff --git a/br/backup-and-restore-use-cases.md b/br/backup-and-restore-use-cases.md index a71db907a203..11d9894cb370 100644 --- a/br/backup-and-restore-use-cases.md +++ b/br/backup-and-restore-use-cases.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复实践示例 summary: 介绍 TiDB 备份与恢复的具体使用示例，包括推荐环境配置、存储配置、备份策略及如何进行备份与恢复。 --- -# 测试数据库备份与恢复实践示例 +# TiDB 备份与恢复实践示例 [TiDB 快照备份与恢复使用指南](/br/br-snapshot-guide.md)及 [TiDB 日志备份与 PITR 使用指南](/br/br-pitr-guide.md)系统介绍了 TiDB 提供的备份与恢复方案，即快照（全量）备份与恢复、日志备份和恢复到指定时间点 (Point-in-time recovery, PITR)。本文档将基于具体的使用场景，介绍如何快速上手使用 TiDB 的备份与恢复方案。 @@ -14,7 +14,7 @@ summary: 介绍 TiDB 备份与恢复的具体使用示例，包括推荐环境 通过 TiDB 提供的 PITR 功能，你可以满足业务团队的需求。 -## 部署测试数据库集群和 br 命令行工具 +## 部署 TiDB 集群和 br 命令行工具 使用 PITR 功能，需要部署 v6.2.0 或以上版本的 TiDB 集群，并且更新 br 命令行工具到与 TiDB 集群相同的版本，本文假设使用的是 v8.5.0 版本。 diff --git a/br/br-incremental-guide.md b/br/br-incremental-guide.md index 183b61a40797..57644c845957 100644 --- a/br/br-incremental-guide.md +++ b/br/br-incremental-guide.md @@ -3,7 +3,7 @@ title: TiDB 增量备份与恢复使用指南 summary: 了解 TiDB 的增量备份与恢复功能使用。 --- -# 测试数据库增量备份与恢复使用指南 +# TiDB 增量备份与恢复使用指南 TiDB 集群增量数据包含在某个时间段的起始和结束两个快照的变化差异的数据，以及之间的 DDL。增量备份的数据相对比全量备份数据而言数据量更小，适合配合快照备份一起使用，减少备份的数据量。进行增量备份的时候，需要保证备份时间范围内的多版本数据没有被 [TiDB GC 机制](/garbage-collection-overview.md)回收。例如，每个小时进行一次增量备份，则需要[调整 TiDB 集群的 GC Lifetime 设置](/system-variables.md#tidb_gc_life_time-从-v50-版本开始引入)至少大于 1 小时。 diff --git a/br/br-log-architecture.md b/br/br-log-architecture.md index 82f071b574a7..9e3eed959724 100644 --- a/br/br-log-architecture.md +++ b/br/br-log-architecture.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 功能架构 summary: 了解 TiDB 的日志备份与 PITR 的架构设计。 --- -# 测试数据库日志备份与 PITR 功能架构 +# TiDB 日志备份与 PITR 功能架构 本文以使用 BR 工具进行备份与恢复为例，介绍 TiDB 集群日志备份与 Point-in-time recovery (PITR) 的架构设计与流程。 diff --git a/br/br-pitr-guide.md b/br/br-pitr-guide.md index 7e07299f4397..e4eb1e10d8f0 100644 --- a/br/br-pitr-guide.md +++ b/br/br-pitr-guide.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 使用指南 summary: 了解 TiDB 的日志备份与 PITR 功能使用。 --- -# 测试数据库日志备份与 PITR 使用指南 +# TiDB 日志备份与 PITR 使用指南 全量备份包含集群某个时间点的全量数据，但是不包含其他时间点的更新数据，而 TiDB 日志备份能够将业务写入 TiDB 的数据记录及时备份到指定存储中。如果你需要灵活的选择恢复的时间点，即实现 Point-in-time recovery (PITR)，可以开启[日志备份](#开启日志备份)，并[定期执行快照（全量）备份](#定期执行全量备份)。 diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index 2b916f0f6656..df3bb468b7d4 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 命令行手册 summary: 介绍 TiDB 日志备份与 PITR 的命令行。 --- -# 测试数据库日志备份与 PITR 命令行手册 +# TiDB 日志备份与 PITR 命令行手册 本文介绍 TiDB 日志备份和 PITR (Point-in-time recovery) 命令行。 diff --git a/br/br-snapshot-architecture.md b/br/br-snapshot-architecture.md index b65b1b86dae2..800a8e34ab1e 100644 --- a/br/br-snapshot-architecture.md +++ b/br/br-snapshot-architecture.md @@ -3,7 +3,7 @@ title: TiDB 快照备份与恢复功能架构 summary: 了解 TiDB 快照备份与恢复功能的架构设计。 --- -# 测试数据库快照备份与恢复功能架构 +# TiDB 快照备份与恢复功能架构 本文以使用 BR 工具进行备份与恢复为例，介绍 TiDB 集群快照数据备份和恢复的架构设计与流程。 diff --git a/br/br-snapshot-guide.md b/br/br-snapshot-guide.md index 392036d53284..09f700cefd94 100644 --- a/br/br-snapshot-guide.md +++ b/br/br-snapshot-guide.md @@ -3,7 +3,7 @@ title: TiDB 快照备份与恢复使用指南 summary: 了解如何使用 br 命令行工具进行 TiDB 快照备份与恢复。 --- -# 测试数据库快照备份与恢复使用指南 +# TiDB 快照备份与恢复使用指南 本文介绍如何使用 br 命令行工具进行 TiDB 快照备份和恢复。使用前，请先[安装 br 命令行工具](/br/br-use-overview.md#部署和使用-br)。 diff --git a/br/br-snapshot-manual.md b/br/br-snapshot-manual.md index 4ab8bee74ac1..73da418d22e7 100644 --- a/br/br-snapshot-manual.md +++ b/br/br-snapshot-manual.md @@ -3,12 +3,12 @@ title: TiDB 快照备份与恢复命令行手册 summary: 介绍备份与恢复 TiDB 集群快照的命令行。 --- -# 测试数据库快照备份与恢复命令行手册 +# TiDB 快照备份与恢复命令行手册 本文按备份恢复的场景介绍快照备份和恢复的命令行，包括： - [备份集群快照](#备份集群快照) -- [备份测试数据库集群指定库表的数据](备份测试数据库集群指定库表的数据) +- [备份 TiDB 集群指定库表的数据](#备份-tidb-集群指定库表的数据) - [备份单个数据库的数据](#备份单个数据库的数据) - [备份单张表的数据](#备份单张表的数据) - [使用表库过滤功能备份多张表的数据](#使用表库过滤功能备份多张表的数据) @@ -57,7 +57,7 @@ tiup br backup full \ Full Backup <---------/................................................> 17.12%. ``` -## 备份测试数据库集群指定库表的数据 +## 备份 TiDB 集群指定库表的数据 br 工具支持只备份集群快照和增量数据中指定库或表的局部数据。在快照备份和增量数据备份的基础上，该功能可过滤掉不需要的数据，只备份关键业务的数据。 diff --git a/br/br-use-overview.md b/br/br-use-overview.md index 767f9c46ce4d..aa260efd00cd 100644 --- a/br/br-use-overview.md +++ b/br/br-use-overview.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复功能使用概述 summary: 了解如何部署和使用 TiDB 集群的备份与恢复。 --- -# 测试数据库备份与恢复功能使用概述 +# TiDB 备份与恢复功能使用概述 本文介绍使用 TiDB 备份与恢复功能的最佳实践，包括如何选择备份方案、如何管理备份数据，以及如何安装和部署备份恢复工具。 diff --git a/cached-tables.md b/cached-tables.md index 33d840d241c3..5d9d88abbdf9 100644 --- a/cached-tables.md +++ b/cached-tables.md @@ -217,7 +217,7 @@ Query OK, 0 rows affected (0.00 sec) 目前 TiDB 对于每张缓存表的大小限制为 64 MB。如果表的数据超过了 64 MB，执行 `ALTER TABLE t CACHE` 会失败。 -## 与其他测试数据库功能的兼容性限制 +## 与其他 TiDB 功能的兼容性限制 以下是缓存表不支持的功能： @@ -232,7 +232,7 @@ Query OK, 0 rows affected (0.00 sec) - 设置系统变量 `tidb_snapshot` 读取历史数据 - 执行修改操作期间，已有缓存会失效，直到数据被再次加载 -## 测试数据库数据迁移工具兼容性 +## TiDB 数据迁移工具兼容性 缓存表并不是标准的 MySQL 功能，而是 TiDB 扩展。只有 TiDB 能识别 `ALTER TABLE ... CACHE` 语句。所有的 TiDB 数据迁移工具均不支持缓存表功能，包括 Backup & Restore (BR)、TiCDC、Dumpling 等组件，它们会将缓存表当作普通表处理。 diff --git a/certificate-authentication.md b/certificate-authentication.md index c62127c273b0..ecac63f38f61 100644 --- a/certificate-authentication.md +++ b/certificate-authentication.md @@ -3,7 +3,7 @@ title: TiDB 证书鉴权使用指南 summary: 了解使用 TiDB 的证书鉴权功能。 --- -# 测试数据库证书鉴权使用指南 +# TiDB 证书鉴权使用指南 TiDB 支持基于证书鉴权的登录方式。采用这种方式，TiDB 对不同用户签发证书，使用加密连接来传输数据，并在用户登录时验证证书。相比 MySQL 用户常用的用户名密码验证方式，与 MySQL 相兼容的证书鉴权方式更安全，因此越来越多的用户使用证书鉴权来代替用户名密码验证。 @@ -212,11 +212,11 @@ server-cert.pem: OK client-cert.pem: OK ``` -## 配置测试数据库和客户端使用证书 +## 配置 TiDB 和客户端使用证书 在生成证书后，需要在 TiDB 中配置服务端所使用的证书，同时让客户端程序使用客户端证书。 -### 配置测试数据库服务端 +### 配置 TiDB 服务端 修改 TiDB 配置文件中的 `[security]` 段。这一步指定 CA 证书、服务端密钥和服务端证书存放的路径。可将 `path/to/server-cert.pem`、`path/to/server-key.pem` 和 `path/to/ca-cert.pem` 替换成实际的路径。 @@ -487,7 +487,7 @@ CA 证书是客户端和服务端相互校验的依据，所以如果需要替 sudo openssl x509 -req -in server-req.new.pem -days 365000 -CA ca-cert.pem -CAkey ca-key.pem -set_serial 01 -out server-cert.new.pem ``` -3. 配置 TiDB 使用上面新生成的服务端密钥和证书并重启。参见[配置测试数据库服务端](配置测试数据库服务端)。 +3. 配置 TiDB 使用上面新生成的服务端密钥和证书并重启。参见[配置 TiDB 服务端](#配置-tidb-服务端)。 ## 基于策略的证书访问控制 diff --git a/character-set-and-collation.md b/character-set-and-collation.md index 4b4a2cfb4471..eda681ab7b80 100644 --- a/character-set-and-collation.md +++ b/character-set-and-collation.md @@ -142,7 +142,7 @@ SHOW COLLATION WHERE Charset = 'utf8mb4'; TiDB 对 GBK 字符集的支持详情见 [GBK](/character-set-gbk.md)。 -## 测试数据库中的 `utf8` 和 `utf8mb4` +## TiDB 中的 `utf8` 和 `utf8mb4` MySQL 限制字符集 `utf8` 为最多 3 个字节。这足以存储在基本多语言平面 (BMP) 中的字符，但不足以存储表情符号 (emoji) 等字符。因此，建议改用字符集`utf8mb4`。 diff --git a/check-before-deployment.md b/check-before-deployment.md index 8a2b930290d6..cb4348d8f5b9 100644 --- a/check-before-deployment.md +++ b/check-before-deployment.md @@ -3,7 +3,7 @@ title: TiDB 环境与系统配置检查 summary: 了解部署 TiDB 前的环境检查操作。 --- -# 测试数据库环境与系统配置检查 +# TiDB 环境与系统配置检查 本文介绍部署 TiDB 前的环境检查操作，以下各项操作按优先级排序。 diff --git a/clinic/clinic-collect-sql-query-plan.md b/clinic/clinic-collect-sql-query-plan.md index 8ed34b6a82b9..cc095633c149 100644 --- a/clinic/clinic-collect-sql-query-plan.md +++ b/clinic/clinic-collect-sql-query-plan.md @@ -117,6 +117,6 @@ roles = [ diag collect --profile= --explain-sql= ``` -### 将结果导入到测试数据库集群 +### 将结果导入到 TiDB 集群 采集结果中的 `plan_replayer.zip` 可以通过 `PLAN REPLAYER LOAD` 语句直接导入到 TiDB 集群中进行信息查看，具体方法可参考[使用 `PLAN REPLAYER` 导入集群信息](/sql-plan-replayer.md#使用-plan-replayer-导入集群信息) diff --git a/clinic/clinic-data-instruction-for-tiup.md b/clinic/clinic-data-instruction-for-tiup.md index 1d82f4a4b57c..f06d1a5bd525 100644 --- a/clinic/clinic-data-instruction-for-tiup.md +++ b/clinic/clinic-data-instruction-for-tiup.md @@ -14,18 +14,18 @@ Clinic Server 是部署在云端的云服务，根据数据存储的位置不同 - [Clinic Server 中国区](https://clinic.pingcap.com.cn)：如果你把采集的数据上传到了 Clinic Server 中国区，这些数据将存储于 PingCAP 设立在 AWS 中国区（北京）的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。 - [Clinic Server 美国区](https://clinic.pingcap.com)：如果你把采集的数据上传到了 Clinic Server 美国区，这些数据将存储于 PingCAP 设立在 AWS 美国区的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。 -## 测试数据库集群 +## TiDB 集群 本节列出了 [Diag](https://github.com/pingcap/diag) 在使用 TiUP 部署的 TiDB 集群中能够采集的诊断数据类型。 -### 测试数据库集群信息 +### TiDB 集群信息 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | | 集群基础信息，包括集群 ID | `cluster.json` | 每次收集默认采集 | | 集群详细信息 | `meta.yaml` | 每次收集默认采集 | -### 测试数据库诊断数据 +### TiDB 诊断数据 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | @@ -80,7 +80,7 @@ Clinic Server 是部署在云端的云服务，根据数据存储的位置不同 | 所有的 Metrics 数据 | `{metric_name}.json` | `--include=monitor` | | Alert 列表 | `alerts.json` | `--include=monitor` | -### 测试数据库系统变量 +### TiDB 系统变量 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | diff --git a/clinic/clinic-user-guide-for-tiup.md b/clinic/clinic-user-guide-for-tiup.md index c4d947df0a1a..916cd028ec9a 100644 --- a/clinic/clinic-user-guide-for-tiup.md +++ b/clinic/clinic-user-guide-for-tiup.md @@ -119,7 +119,7 @@ summary: 详细介绍在使用 TiUP 部署的 TiDB 集群或 DM 集群上如何 4. 开启日志脱敏配置（可选步骤）。 - TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#测试数据库组件日志脱敏)。 + TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#tidb-组件日志脱敏)。 ## 远程定位集群问题 diff --git a/clinic/quick-start-with-clinic.md b/clinic/quick-start-with-clinic.md index 0fac2dead1e1..f746e87ab9d4 100644 --- a/clinic/quick-start-with-clinic.md +++ b/clinic/quick-start-with-clinic.md @@ -104,7 +104,7 @@ PingCAP Clinic 由 [Diag 诊断客户端](https://github.com/pingcap/diag)（以 6. 开启日志脱敏配置（可选步骤）。 - TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#测试数据库组件日志脱敏)。 + TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#tidb-组件日志脱敏)。 ## 体验步骤 diff --git a/clustered-indexes.md b/clustered-indexes.md index 2b0c2f8221e5..a48325ae9fb9 100644 --- a/clustered-indexes.md +++ b/clustered-indexes.md @@ -171,7 +171,7 @@ TiDB v5.0 完成了所有类型主键的支持，但默认行为与 TiDB v3.0 TiDB 支持使用可执行注释的语法来包裹 `CLUSTERED` 或 `NONCLUSTERED` 关键字，且 `SHOW CREATE TABLE` 的结果均包含 TiDB 特有的可执行注释，这些注释在 MySQL 或低版本的 TiDB 中会被忽略。 -### 测试数据库数据迁移工具兼容性 +### TiDB 数据迁移工具兼容性 聚簇索引仅与 v5.0 及以后版本的以下数据迁移工具兼容： @@ -180,7 +180,7 @@ TiDB 支持使用可执行注释的语法来包裹 `CLUSTERED` 或 `NONCLUSTERED v5.0 的 BR 不能通过备份恢复将非聚簇索引表转换成聚簇索引表，反之亦然。 -### 与测试数据库其他特性的兼容性 +### 与 TiDB 其他特性的兼容性 在非单整数列作为主键的表中，从非聚簇索引变为聚簇索引之后，在 v5.0 之前版本的 TiDB 能够执行的 `SPLIT TABLE BY/BETWEEN` 语句在 v5.0 及以后版本的 TiDB 上不再可用，原因是行数据键的构成发生了变化。在聚簇索引表上执行 `SPLIT TABLE BY/BETWEEN` 时需要依据主键列指定值，而不是指定一个整数值。例如： diff --git a/command-line-flags-for-tidb-configuration.md b/command-line-flags-for-tidb-configuration.md index 1377327d266a..c57f49cf029b 100644 --- a/command-line-flags-for-tidb-configuration.md +++ b/command-line-flags-for-tidb-configuration.md @@ -3,7 +3,7 @@ title: TiDB 配置参数 summary: TiDB 配置参数包括启动参数和环境变量。启动参数包括 advertise-address、config、config-check、config-strict、cors 等。其中默认端口为 4000 和 10080。其他参数包括 log-file、metrics-addr、metrics-interval 等。注意配置文件的有效性和安全模式下的启动。 --- -# 测试数据库配置参数 +# TiDB 配置参数 在启动 TiDB 时，你可以使用命令行参数或环境变量来配置 TiDB。 diff --git a/comment-syntax.md b/comment-syntax.md index cf909107a205..4130d2564883 100644 --- a/comment-syntax.md +++ b/comment-syntax.md @@ -121,7 +121,7 @@ TiDB 也跟 MySQL 保持一致，支持一种 C 风格注释的变体： 如果注释中指定了 Server 版本号，例如 `/*!50110 KEY_BLOCK_SIZE=1024 */`，在 MySQL 中表示只有 MySQL 的版本大于等于 5.1.10 才会处理这个 comment 中的内容。但是在 TiDB 中，这个 MySQL 版本号不会起作用，所有的 comment 都被会处理。 -## 测试数据库可执行的注释语法 +## TiDB 可执行的注释语法 TiDB 也有独立的注释语法，称为 TiDB 可执行注释语法。主要分为两种： diff --git a/configure-memory-usage.md b/configure-memory-usage.md index 51d81a1b439a..14dda46a8405 100644 --- a/configure-memory-usage.md +++ b/configure-memory-usage.md @@ -3,7 +3,7 @@ title: TiDB 内存控制文档 summary: TiDB 内存控制文档介绍了如何追踪和控制 SQL 查询过程中的内存使用情况，以及配置内存使用阈值和 tidb-server 实例的内存使用阈值。还介绍了使用 INFORMATION_SCHEMA 系统表查看内存使用情况，以及降低写入事务内存使用的方法。另外还介绍了流量控制和数据落盘的内存控制策略，以及通过设置环境变量 GOMEMLIMIT 缓解 OOM 问题。 --- -# 测试数据库内存控制文档 +# TiDB 内存控制文档 目前 TiDB 已经能够做到追踪单条 SQL 查询过程中的内存使用情况，当内存使用超过一定阈值后也能采取一些操作来预防 OOM 或者排查 OOM 原因。你可以使用系统变量 [`tidb_mem_oom_action`](/system-variables.md#tidb_mem_oom_action-从-v610-版本开始引入) 来控制查询超过内存限制后所采取的操作： diff --git a/credits.md b/credits.md index 8537d356b243..906d0eae7277 100644 --- a/credits.md +++ b/credits.md @@ -3,11 +3,11 @@ title: TiDB 社区荣誉列表 summary: 了解 TiDB 社区贡献者列表及角色。 --- -# 测试数据库社区荣誉列表 +# TiDB 社区荣誉列表 每一位贡献者都是推动 TiDB 健壮发展的重要成员，我们感谢所有为 TiDB 提交代码、撰写或翻译文档的贡献者。 -## 测试数据库开发者 +## TiDB 开发者 TiDB 开发者为 TiDB 的新功能开发、性能优化、稳定性保障做出了贡献。以下链接包含了 TiDB 相关 repo 的贡献者名单： @@ -25,7 +25,7 @@ TiDB 开发者为 TiDB 的新功能开发、性能优化、稳定性保障做出 - [tidb-incubator/TiBigData](https://github.com/tidb-incubator/TiBigData/graphs/contributors) - [ti-community-infra](https://github.com/orgs/ti-community-infra/people) -## 测试数据库文档写作者和译员 +## TiDB 文档写作者和译员 TiDB 文档写作者和译员为 TiDB 及相关项目撰写文档、提供翻译。以下链接包含了 TiDB 文档相关 repo 的贡献者名单： diff --git a/dashboard/dashboard-diagnostics-report.md b/dashboard/dashboard-diagnostics-report.md index 73e42da66150..8f31ed10328e 100644 --- a/dashboard/dashboard-diagnostics-report.md +++ b/dashboard/dashboard-diagnostics-report.md @@ -216,7 +216,7 @@ TiDB 内置自动诊断的结果，具体各字段含义以及介绍可以参考 这部分包括了 TiDB/PD/TiKV 更多的具体的监控信息。 -#### 测试数据库相关监控信息 +#### TiDB 相关监控信息 ##### Time Consumed by TiDB Component diff --git a/dashboard/dashboard-ops-security.md b/dashboard/dashboard-ops-security.md index 6ce2a988ec9f..4c921d52d7b9 100644 --- a/dashboard/dashboard-ops-security.md +++ b/dashboard/dashboard-ops-security.md @@ -7,7 +7,7 @@ summary: TiDB Dashboard 需要提高安全性。建议为 `root` 用户设置强 尽管访问 TiDB Dashboard 需要登录，但它被设计为默认供可信的用户实体访问。当你希望将 TiDB Dashboard 提供给外部网络用户或不可信用户访问时，需要注意采取以下措施以避免安全漏洞。 -## 提高测试数据库用户安全性 +## 提高 TiDB 用户安全性 ### 为 `root` 用户设置强密码 diff --git a/ddl-introduction.md b/ddl-introduction.md index bca75f3dfc51..32d810258406 100644 --- a/ddl-introduction.md +++ b/ddl-introduction.md @@ -60,7 +60,7 @@ ADMIN SHOW DDL; 1 row in set (0.00 sec) ``` -### 测试数据库在线 DDL 异步变更的原理 +### TiDB 在线 DDL 异步变更的原理 TiDB DDL 模块从设计之初就选择了在线异步变更的模式，为 TiDB 的用户提供了不停机变更业务的服务能力。 diff --git a/deploy-monitoring-services.md b/deploy-monitoring-services.md index ead88d8795ec..4e5724b53e95 100644 --- a/deploy-monitoring-services.md +++ b/deploy-monitoring-services.md @@ -3,7 +3,7 @@ title: 集群监控部署 summary: 本文适用于手动部署 TiDB 监控报警系统的用户。假设 TiDB 的拓扑结构如下：Node1 主机 IP 为 192.168.199.113，服务包括 PD1、TiDB、node_export、Prometheus、Grafana；Node2 主机 IP 为 192.168.199.114，服务包括 PD2、node_export；Node3 主机 IP 为 192.168.199.115，服务包括 PD3、node_export；Node4 主机 IP 为 192.168.199.116，服务包括 TiKV1、node_export；Node5 主机 IP 为 192.168.199.117，服务包括 TiKV2、node_export；Node6 主机 IP 为 192.168.199.118，服务包括 TiKV3、node_export。具体部署步骤包括下载二进制包、启动 node_exporter 服务、启动 Prometheus 服务、启动 Grafana 服务、配置 Grafana 数据源和导入 Grafana 面板。可查看 TiDB Server、PD Server 和 TiKV Server 的监控信息。 --- -# 测试数据库集群监控部署 +# TiDB 集群监控部署 本文档适用于希望手动部署 TiDB 监控报警系统的用户。TiUP 部署方式，会同时自动部署监控报警系统，无需手动部署。 diff --git a/develop/dev-guide-build-cluster-in-cloud.md b/develop/dev-guide-build-cluster-in-cloud.md index 2ecd778962af..5caf762868f6 100644 --- a/develop/dev-guide-build-cluster-in-cloud.md +++ b/develop/dev-guide-build-cluster-in-cloud.md @@ -5,7 +5,7 @@ summary: 使用 TiDB Cloud Serverless 构建 TiDB 集群，并连接 TiDB Cloud -# 使用 TiDB Cloud Serverless 构建测试数据库集群 +# 使用 TiDB Cloud Serverless 构建 TiDB 集群 本文将介绍如何以最快的方式开始使用 TiDB。你将创建并启动一个 [TiDB Cloud Serverless](https://www.pingcap.com/tidb-serverless/) 集群，使用 TiDB SQL 客户端，插入数据。随后将从示例程序读取出数据。 diff --git a/develop/dev-guide-overview.md b/develop/dev-guide-overview.md index 1a64dcab9398..0cc72ac21562 100644 --- a/develop/dev-guide-overview.md +++ b/develop/dev-guide-overview.md @@ -11,15 +11,15 @@ summary: 整体叙述了开发者手册，罗列了开发者手册的大致脉 此外，你还可以通过视频的形式学习免费的 [TiDB SQL 开发在线课程](https://cn.pingcap.com/courses-catalog/category/back-end-developer/?utm_source=docs-cn-dev-guide)。 -## 测试数据库基础 +## TiDB 基础 在你开始使用 TiDB 之前，你需要了解一些关于 TiDB 数据库的一些重要工作机制： - 阅读 [TiDB 事务概览](/transaction-overview.md)来了解 TiDB 的事务运作方式或查看[为应用开发程序员准备的事务说明](/develop/dev-guide-transaction-overview.md)查看应用开发程序员需要了解的事务部分。 - 学习免费在线课程 [TiDB 架构与特点](https://learn.pingcap.com/learner/course/600003/?utm_source=docs-cn-dev-guide)，了解构建 TiDB 分布式数据库集群的核心组件及其概念。 -- 了解[应用程序与测试数据库交互的方式](应用程序与测试数据库交互的方式)。 +- 了解[应用程序与 TiDB 交互的方式](#应用程序与-tidb-交互的方式)。 -## 测试数据库事务机制 +## TiDB 事务机制 TiDB 支持分布式事务，而且提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。TiDB 当前版本中默认采用 **悲观事务** 模式，这让你在 TiDB 事务时可以像使用传统的单体数据库 (如: MySQL) 事务一样。 @@ -29,7 +29,7 @@ TiDB 会为你保证 `BEGIN` 开始到 `COMMIT` 或 `ROLLBACK` 结束间的所 若你不清楚**乐观事务**是什么，请暂时不要使用它。因为使用**乐观事务**的前提是需要应用程序可以正确的处理 `COMMIT` 语句所返回的[所有错误](/error-codes.md)。如果不确定应用程序如何处理，请直接使用**悲观事务**。 -## 应用程序与测试数据库交互的方式 +## 应用程序与 TiDB 交互的方式 TiDB 高度兼容 MySQL 协议，TiDB 支持[大多数 MySQL 的语法及特性](/mysql-compatibility.md)，因此大部分的 MySQL 的连接库都与 TiDB 兼容。如果你的应用程序框架或语言无 PingCAP 的官方适配，那么建议你使用 MySQL 的客户端库。同时，也有越来越多的三方数据库主动支持 TiDB 的差异特性。 diff --git a/develop/dev-guide-proxysql-integration.md b/develop/dev-guide-proxysql-integration.md index 360c47a82c8d..93f1b9d63cbe 100644 --- a/develop/dev-guide-proxysql-integration.md +++ b/develop/dev-guide-proxysql-integration.md @@ -40,7 +40,7 @@ ProxySQL 的设计目标是快速、高效且易于使用。它完全兼容 MySQ 本节介绍如何在开发环境中将 TiDB 与 ProxySQL 集成。在满足[前提条件](#前提条件)的情况下，你可以根据 TiDB 集群类型选择以下选项之一开始集成 ProxySQL： - 选项 1：[集成 TiDB Cloud 与 ProxySQL](#选项-1-集成-tidb-cloud-与-proxysql) -- 选项 2：[集成本地部署的测试数据库与 ProxySQL](选项-2-集成本地部署的测试数据库与-proxysql) +- 选项 2：[集成本地部署的 TiDB 与 ProxySQL](#选项-2-集成本地部署的-tidb-与-proxysql) ### 前提条件 @@ -350,7 +350,7 @@ systemctl start docker comment: ``` -#### 步骤 4. 通过 ProxySQL 连接到测试数据库集群 +#### 步骤 4. 通过 ProxySQL 连接到 TiDB 集群 1. 运行 `proxysql-connect.py` 连接到你的 TiDB 集群。该脚本将自动启动 MySQL 客户端并使用你在[步骤 2](#步骤-2-生成-proxysql-配置文件) 中指定的用户名和密码进行连接。 @@ -427,7 +427,7 @@ systemctl start docker -### 选项 2: 集成本地部署的测试数据库与 ProxySQL +### 选项 2: 集成本地部署的 TiDB 与 ProxySQL 在这个集成中，你将使用 [TiDB](https://hub.docker.com/r/pingcap/tidb) 和 [ProxySQL](https://hub.docker.com/r/proxysql/proxysql) 的 Docker 镜像设置环境。你也可以尝试[其他方式安装 TiDB](/quick-start-with-tidb.md)。 @@ -803,7 +803,7 @@ systemctl start docker > **注意：** > -> 以下步骤使用 TiDB 和 ProxySQL 的容器镜像配置查询规则。如果你还没有拉取这些镜像，请参考[集成本地部署的测试数据库与 ProxySQL](选项-2-集成本地部署的测试数据库与-proxysql) 部分的详细步骤。 +> 以下步骤使用 TiDB 和 ProxySQL 的容器镜像配置查询规则。如果你还没有拉取这些镜像，请参考[集成本地部署的 TiDB 与 ProxySQL](#选项-2-集成本地部署的-tidb-与-proxysql) 部分的详细步骤。 1. 克隆 TiDB 和 ProxySQL 的集成示例代码仓库 [`pingcap-inc/tidb-proxysql-integration`](https://github.com/pingcap-inc/tidb-proxysql-integration)。如果你已经在前面的步骤中克隆了它，请跳过这一步。 diff --git a/develop/dev-guide-third-party-support.md b/develop/dev-guide-third-party-support.md index 37eaca4328c4..bd5386062a53 100644 --- a/develop/dev-guide-third-party-support.md +++ b/develop/dev-guide-third-party-support.md @@ -3,7 +3,7 @@ title: TiDB 支持的第三方工具 summary: TiDB 支持的第三方工具主要包括驱动、ORM 框架和 GUI。支持等级分为 Full 和 Compatible，其中 Full 表示绝大多数功能兼容性已得到支持，Compatible 表示大部分功能可使用但未经完整验证。对于支持的 Driver 或 ORM 框架并不包括应用端事务重试和错误处理。如果在使用工具连接 TiDB 时出现问题，可在 GitHub 上提交包含详细信息的 issue 以获得进展。 --- -# 测试数据库支持的第三方工具 +# TiDB 支持的第三方工具 > **注意：** > diff --git a/develop/dev-guide-third-party-tools-compatibility.md b/develop/dev-guide-third-party-tools-compatibility.md index 7a60ea887da4..fa9713bcd716 100644 --- a/develop/dev-guide-third-party-tools-compatibility.md +++ b/develop/dev-guide-third-party-tools-compatibility.md @@ -22,7 +22,7 @@ summary: 介绍在测试中发现的 TiDB 与第三方工具的兼容性问题 ## 通用 -### 测试数据库中 `SELECT CONNECTION_ID()` 返回结果类型为 64 位整型 +### TiDB 中 `SELECT CONNECTION_ID()` 返回结果类型为 64 位整型 **描述** @@ -32,7 +32,7 @@ TiDB 中 `SELECT CONNECTION_ID()` 的返回值为 64 位，如 `2199023260887` 在 TiDB 应用程序中，请注意使用各语言的 64 位整型类型（或字符串类型）存储 `SELECT CONNECTION_ID()` 的结果，防止溢出。如 Java 应使用 `Long` 或 `String` 进行接收，JavaScript/TypeScript 应使用 `string` 类型进行接收。 -### 测试数据库未设置 `Com_*` 计数器 +### TiDB 未设置 `Com_*` 计数器 **描述** @@ -42,7 +42,7 @@ MySQL 维护了一系列 [`Com_` 开头的服务端变量](https://dev.mysql.com 请勿使用这样的变量。在 MySQL 中 `Com_*` 常见的使用场景之一是监控。TiDB 的可观测性较为完善，无需从服务端变量进行查询。如需定制监控工具，可阅读 [TiDB 监控框架概述](/tidb-monitoring-framework.md)来获得更多信息。 -### 测试数据库错误日志区分 `TIMESTAMP` 与 `DATETIME` 类型 +### TiDB 错误日志区分 `TIMESTAMP` 与 `DATETIME` 类型 **描述** @@ -52,7 +52,7 @@ TiDB 错误日志区分 `TIMESTAMP` 与 `DATETIME`，而 MySQL 不区分，全 请勿使用错误日志进行字符串匹配，要使用[错误码](/error-codes.md)进行故障诊断。 -### 测试数据库不支持 `CHECK TABLE` 语句 +### TiDB 不支持 `CHECK TABLE` 语句 **描述** diff --git a/develop/dev-guide-tidb-crud-sql.md b/develop/dev-guide-tidb-crud-sql.md index d17aeae84abd..2108dd10e104 100644 --- a/develop/dev-guide-tidb-crud-sql.md +++ b/develop/dev-guide-tidb-crud-sql.md @@ -3,7 +3,7 @@ title: 使用 TiDB 的增删改查 SQL summary: 简单介绍 TiDB 的增删改查 SQL。 --- -# 使用测试数据库的增删改查 SQL +# 使用 TiDB 的增删改查 SQL 本章将简单介绍 TiDB 的增删改查 SQL 的使用方法。 diff --git a/develop/dev-guide-timeouts-in-tidb.md b/develop/dev-guide-timeouts-in-tidb.md index 87e06325ba91..daaac2d24d6f 100644 --- a/develop/dev-guide-timeouts-in-tidb.md +++ b/develop/dev-guide-timeouts-in-tidb.md @@ -3,7 +3,7 @@ title: TiDB 中的各种超时 summary: 简单介绍 TiDB 中的各种超时，为排查错误提供依据。 --- -# 测试数据库中的各种超时 +# TiDB 中的各种超时 本章将介绍 TiDB 中的各种超时，为排查错误提供依据。 diff --git a/develop/dev-guide-use-temporary-tables.md b/develop/dev-guide-use-temporary-tables.md index 95f5d790e9cb..4d449aa53a38 100644 --- a/develop/dev-guide-use-temporary-tables.md +++ b/develop/dev-guide-use-temporary-tables.md @@ -252,7 +252,7 @@ DROP GLOBAL TEMPORARY TABLE top_50_eldest_authors_global; ## 限制 -关于 TiDB 在临时表功能上的一些限制，你可以通过阅读参考文档中的[临时表与其他测试数据库功能的兼容性限制](/temporary-tables.md#与其他测试数据库功能的兼容性限制)小节进行了解。 +关于 TiDB 在临时表功能上的一些限制，你可以通过阅读参考文档中的[临时表与其他 TiDB 功能的兼容性限制](/temporary-tables.md#与其他-tidb-功能的兼容性限制)小节进行了解。 ## 扩展阅读 diff --git a/dm/dm-binlog-event-filter.md b/dm/dm-binlog-event-filter.md index f64e116a4131..978a8058b58e 100644 --- a/dm/dm-binlog-event-filter.md +++ b/dm/dm-binlog-event-filter.md @@ -138,7 +138,7 @@ filters: action: Do ``` -### 过滤测试数据库不支持的 SQL 语句 +### 过滤 TiDB 不支持的 SQL 语句 可设置如下规则过滤 TiDB 不支持的 `PROCEDURE` 语句： diff --git a/dm/dm-enable-tls.md b/dm/dm-enable-tls.md index 06e1ea29d93e..c3eb77aca5a5 100644 --- a/dm/dm-enable-tls.md +++ b/dm/dm-enable-tls.md @@ -107,9 +107,9 @@ DM-master、DM-worker 和 dmctl 都会在每次新建相互通讯的连接时重 ssl-key: "/path/to/mysql-client-key.pem" ``` -### 为下游测试数据库连接开启加密传输 +### 为下游 TiDB 连接开启加密传输 -1. 配置下游 TiDB 启用加密连接支持，具体可参考[配置测试数据库启用加密连接支持](/enable-tls-between-clients-and-servers.md#配置测试数据库服务端启用安全连接) +1. 配置下游 TiDB 启用加密连接支持，具体可参考[配置 TiDB 启用加密连接支持](/enable-tls-between-clients-and-servers.md#配置-tidb-服务端启用安全连接) 2. 在 task 配置文件中设置 TiDB Client 证书： diff --git a/dm/dm-faq.md b/dm/dm-faq.md index ac91aa83b859..2ef1af2067ba 100644 --- a/dm/dm-faq.md +++ b/dm/dm-faq.md @@ -32,7 +32,7 @@ DM 会尝试将包含多个 DDL 变更操作的单条语句拆分成只包含一 > > TiDB 目前并不兼容 MySQL 支持的所有 DDL 语句。 -## DM 是否会将视图的 DDL 语句和对视图的 DML 语句同步到下游的测试数据库中？ +## DM 是否会将视图的 DDL 语句和对视图的 DML 语句同步到下游的 TiDB 中？ 目前 DM 不会将视图的 DDL 语句同步到下游的 TiDB 集群，也不会将针对视图的 DML 语句同步到下游。 diff --git a/dm/dm-task-configuration-guide.md b/dm/dm-task-configuration-guide.md index 43e30416d944..f66f3d83a5ab 100644 --- a/dm/dm-task-configuration-guide.md +++ b/dm/dm-task-configuration-guide.md @@ -29,7 +29,7 @@ mysql-instances: - source-id: "mysql-replica-02" # 从 source-id = mysql-replica-02 的数据源迁移数据 ``` -## 配置迁移的目标测试数据库集群 +## 配置迁移的目标 TiDB 集群 仿照下面的 `target-database:` 示例定义迁移的目标 TiDB 集群。 @@ -119,7 +119,7 @@ target-database: # 目标 TiDB 配置 filter-rules: ["filter-rule-2"] # 过滤数据源特定操作的规则，可以配置多个过滤规则 ``` -## 配置需要数据源表到目标测试数据库表的映射 +## 配置需要数据源表到目标 TiDB 表的映射 如果不需要将数据源表路由到不同名的目标 TiDB 表，可以跳过该项配置。分库分表合并迁移的场景必须配置该规则。 diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index 44166b3074f4..446492b4782a 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -3,11 +3,11 @@ title: TiDB 工具下载 summary: 本文介绍如何下载 TiDB 工具包。TiDB 工具包包含常用工具如 Dumpling、TiDB Lightning、BR 等。如果部署环境能访问互联网，可直接通过 TiUP 命令一键部署所需的 TiDB 工具。操作系统需为 Linux，架构为 amd64 或 arm64。下载步骤包括访问 TiDB 社区版页面，找到 TiDB-community-toolkit 软件包并点击立即下载。注意，点击立即下载后默认下载当前 TiDB 的最新发布版本。根据要使用的工具选择安装对应的离线包。 --- -# 测试数据库工具下载 +# TiDB 工具下载 本文介绍如何下载 TiDB 工具包。关于 TiDB 工具包的内容，请查看 [TiDB 离线包](/binary-package.md)。 -## 测试数据库工具包下载 +## TiDB 工具包下载 TiDB 工具包中包含了一些常用的 TiDB 工具，例如数据导出工具 Dumpling、数据导入工具 TiDB Lightning、备份恢复工具 BR。 @@ -31,7 +31,7 @@ TiDB 工具包中包含了一些常用的 TiDB 工具，例如数据导出工具 > - 如需在 Kubernetes 上部署运维 TiDB，无需下载 TiDB-community-toolkit 软件包，请参考[离线安装 TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tidb-operator#离线安装-tidb-operator)。 > - 如需使用 [PD Control](/pd-control.md) 工具 `pd-ctl`，请下载 **TiDB-community-server 软件包**。 -### 测试数据库工具包说明 +### TiDB 工具包说明 在 TiDB 工具包中，你可以依据要使用的工具，选择安装对应的离线包。 diff --git a/dr-secondary-cluster.md b/dr-secondary-cluster.md index cdffb96c54df..d25c6aefabb5 100644 --- a/dr-secondary-cluster.md +++ b/dr-secondary-cluster.md @@ -22,7 +22,7 @@ summary: 了解如何使用 TiCDC 构建主备集群进行容灾。 同时，本文还介绍了如何在备用集群上进行业务查询，以及如何在主备集群间进行双向同步。 -## 基于 TiCDC 构建测试数据库主备集群 +## 基于 TiCDC 构建 TiDB 主备集群 ### 架构概览 @@ -64,7 +64,7 @@ summary: 了解如何使用 TiCDC 构建主备集群进行容灾。 部署 TiCDC 组件需要注意的是，Secondary Cluster 和 TiCDC 需要在一起部署和管理，并且它们之间的网络需要能够连通。 -- 如果需要在已有的 Primary Cluster 上部署 TiCDC，请参考[部署 TiCDC 组件](/ticdc/deploy-ticdc.md#使用-tiup-在原有测试数据库集群上新增或扩容-ticdc-组件)。 +- 如果需要在已有的 Primary Cluster 上部署 TiCDC，请参考[部署 TiCDC 组件](/ticdc/deploy-ticdc.md#使用-tiup-在原有-tidb-集群上新增或扩容-ticdc-组件)。 - 如果部署全新的 Primary Cluster 和 TiCDC 组件，则可以使用以下 TiUP 部署模版，并按照需要修改配置参数： ```yaml diff --git a/dr-solution-introduction.md b/dr-solution-introduction.md index 2c99cb8e3c75..ecdc783489d4 100644 --- a/dr-solution-introduction.md +++ b/dr-solution-introduction.md @@ -3,7 +3,7 @@ title: TiDB 容灾方案概述 summary: 了解 TiDB 提供的几种容灾方案，包括基于主备集群的容灾、基于多副本的单集群容灾和基于备份与恢复的容灾。 --- -# 测试数据库容灾方案概述 +# TiDB 容灾方案概述 本文将以如下结构系统介绍 TiDB 容灾解决方案： @@ -28,7 +28,7 @@ summary: 了解 TiDB 提供的几种容灾方案，包括基于主备集群的 在介绍具体的容灾方案之前，本部分将从容灾角度介绍容灾系统中的组件架构，包括 TiDB、TiCDC 和 BR。 -### 测试数据库架构 +### TiDB 架构 ![TiDB architecture](/media/dr/tidb-architecture.png) diff --git a/dumpling-overview.md b/dumpling-overview.md index 2e3e4f5786cd..8a8986bde7c4 100644 --- a/dumpling-overview.md +++ b/dumpling-overview.md @@ -291,7 +291,7 @@ $ ls -lh /tmp/test | awk '{print $5 "\t" $9}' 190K test.sbtest3.0.sql ``` -### 导出测试数据库的历史数据快照 +### 导出 TiDB 的历史数据快照 Dumpling 可以通过 `--snapshot` 指定导出某个 [tidb_snapshot](/read-historical-data.md#操作流程) 的数据。 @@ -306,7 +306,7 @@ tiup dumpling --snapshot "2020-07-02 17:12:45" 即可导出 TSO 为 `417773951312461825` 或 `2020-07-02 17:12:45` 时的 TiDB 历史数据快照。 -### 控制导出测试数据库大表（超过 1 TB）时的内存使用 +### 控制导出 TiDB 大表（超过 1 TB）时的内存使用 Dumpling 导出 TiDB 较大单表（超过 1 TB）时，可能会因为导出数据过大导致 TiDB 内存溢出 (OOM)，从而使连接中断导出失败。可以通过以下参数减少 TiDB 的内存使用。 diff --git a/dynamic-config.md b/dynamic-config.md index d54a2bc838fd..52cc175a566b 100644 --- a/dynamic-config.md +++ b/dynamic-config.md @@ -306,7 +306,7 @@ Query OK, 0 rows affected (0.01 sec) 具体配置项意义可参考 [PD 配置文件描述](/pd-configuration-file.md)。 -### 在线修改测试数据库配置 +### 在线修改 TiDB 配置 在线修改 TiDB 配置的方式和 TiKV/PD 有所不同，你可以通过修改[系统变量](/system-variables.md)来实现。 diff --git a/ecosystem-tool-user-case.md b/ecosystem-tool-user-case.md index 5012a3fd1ed2..be7939a4dcfb 100644 --- a/ecosystem-tool-user-case.md +++ b/ecosystem-tool-user-case.md @@ -3,7 +3,7 @@ title: TiDB 工具的使用场景 summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 --- -# 测试数据库工具的使用场景 +# TiDB 工具的使用场景 本文档从数据迁移工具的使用场景出发，介绍部分常见场景下的迁移工具的选择。 @@ -29,7 +29,7 @@ summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 如果全量数据量较大（TB 级别），则可先使用 [Dumpling](/dumpling-overview.md) 与 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 完成全量数据的迁移，再使用 DM 完成增量数据的迁移。 -## 测试数据库集群备份与恢复 +## TiDB 集群备份与恢复 当需要对 TiDB 集群进行备份或在之后对 TiDB 集群进行恢复时，可使用 [BR](/br/backup-and-restore-overview.md)。 @@ -39,6 +39,6 @@ summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 如果还需要执行增量数据的迁移，则可使用 [TiCDC](/ticdc/ticdc-overview.md)。 -## 测试数据库增量数据订阅 +## TiDB 增量数据订阅 当需要订阅 TiDB 增量数据的变更时，可使用 [TiCDC](/ticdc/ticdc-overview.md)。 diff --git a/ecosystem-tool-user-guide.md b/ecosystem-tool-user-guide.md index 5d4831a53071..3f593f406cfb 100644 --- a/ecosystem-tool-user-guide.md +++ b/ecosystem-tool-user-guide.md @@ -3,7 +3,7 @@ title: TiDB 工具功能概览 summary: TiDB 提供了丰富的工具，包括部署运维工具 TiUP 和 TiDB Operator，数据管理工具如 TiDB Data Migration（DM）、Dumpling、TiDB Lightning、Backup & Restore（BR）、TiCDC、sync-diff-inspector，以及 OLAP 分析工具 TiSpark。这些工具可用于部署、数据迁移、备份恢复、数据校验等多种操作，满足不同需求。 --- -# 测试数据库工具功能概览 +# TiDB 工具功能概览 TiDB 提供了丰富的工具，可以帮助你进行部署运维、数据管理（例如，数据迁移、备份恢复、数据校验）、在 TiKV 上运行 Spark SQL。请根据需要选择适用的工具。 @@ -110,7 +110,7 @@ TiDB 提供了 TiUP 和 TiDB Operator 部署运维工具，满足你在不同系 - 适用 TiDB 版本：v4.0 及以上 - Kubernetes 支持：[使用 BR 工具备份 TiDB 集群数据到兼容 S3 的存储](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/backup-to-aws-s3-using-br)，[使用 BR 工具恢复 S3 兼容存储上的备份数据](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/restore-from-aws-s3-using-br) -### 测试数据库增量数据同步 - TiCDC +### TiDB 增量数据同步 - TiCDC [TiCDC](/ticdc/ticdc-overview.md) 是一款通过拉取 TiKV 变更日志实现的 TiDB 增量数据同步工具，具有将数据还原到与上游任意 TSO 一致状态的能力，同时提供开放数据协议 (TiCDC Open Protocol)，支持其他系统订阅数据变更。 diff --git a/enable-disk-spill-encrypt.md b/enable-disk-spill-encrypt.md index 09e02a86bad8..62c8b227830a 100644 --- a/enable-disk-spill-encrypt.md +++ b/enable-disk-spill-encrypt.md @@ -3,7 +3,7 @@ title: 为 TiDB 落盘文件开启加密 summary: 了解如何为 TiDB 落盘文件开启加密。 --- -# 为测试数据库落盘文件开启加密 +# 为 TiDB 落盘文件开启加密 当系统变量 [`tidb_enable_tmp_storage_on_oom`](/system-variables.md#tidb_enable_tmp_storage_on_oom) 为 `ON` 时，如果单条 SQL 语句的内存使用超出系统变量 [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query) 的限制，某些算子可以将执行时的中间结果作为临时文件落盘保存，直到查询执行完成之后将它们删除。 diff --git a/enable-tls-between-clients-and-servers.md b/enable-tls-between-clients-and-servers.md index dc11bbba0e96..a83628f7fcc7 100644 --- a/enable-tls-between-clients-and-servers.md +++ b/enable-tls-between-clients-and-servers.md @@ -3,7 +3,7 @@ title: 为 TiDB 客户端服务端间通信开启加密传输 summary: TiDB 服务端与客户端间默认采用非加密连接，容易造成信息泄露。建议使用加密连接确保安全性。要开启 TLS 加密传输，需要在服务端配置开启 TLS 支持，并在客户端应用程序中配置使用 TLS 加密连接。可以通过配置系统变量或在创建 / 修改用户时指定要求加密连接。可通过命令检查当前连接是否是加密连接。TLS 版本为 TLSv1.2 和 TLSv1.3，支持的加密算法包括 AES 和 CHACHA20_POLY1305。 --- -# 为测试数据库客户端服务端间通信开启加密传输 +# 为 TiDB 客户端服务端间通信开启加密传输 默认情况下，TiDB 允许服务端与客户端之间的不安全连接，因而具备监视信道流量能力的第三方可以知悉 TiDB 服务端与客户端之间发送和接受的数据，包括但不限于查询语句内容、查询结果等。若信道是不可信的，例如客户端是通过公网连接到 TiDB 服务端的，则不安全连接容易造成信息泄露，建议使用 TLS 连接确保安全性。 @@ -30,7 +30,7 @@ TiDB 服务端支持启用基于 TLS（传输层安全）协议的安全连接 > > 如果登录用户已配置使用 [TiDB 证书鉴权功能](/certificate-authentication.md#配置登录时需要校验的用户证书信息)校验用户证书，也会隐式要求对应用户必须使用加密连接连接 TiDB。 -## 配置测试数据库服务端启用安全连接 +## 配置 TiDB 服务端启用安全连接 要启用安全连接，请参考以下相关参数说明： diff --git a/enable-tls-between-components.md b/enable-tls-between-components.md index 4b6fc182b84e..eaff49b1b7b8 100644 --- a/enable-tls-between-components.md +++ b/enable-tls-between-components.md @@ -3,7 +3,7 @@ title: 为 TiDB 组件间通信开启加密传输 summary: 了解如何为 TiDB 集群内各组件间开启加密传输。 --- -# 为测试数据库组件间通信开启加密传输 +# 为 TiDB 组件间通信开启加密传输 本部分介绍如何为 TiDB 集群内各组件间开启加密传输。一旦开启，以下组件间均将使用加密传输： diff --git a/encryption-at-rest.md b/encryption-at-rest.md index e4c3ad12b94d..aae5bc01d442 100644 --- a/encryption-at-rest.md +++ b/encryption-at-rest.md @@ -11,7 +11,7 @@ summary: 了解如何启用静态加密功能保护敏感数据。 静态加密 (encryption at rest) 即在存储数据时进行数据加密。对于数据库，静态加密功能也叫透明数据加密 (TDE)，区别于传输数据加密 (TLS) 或使用数据加密（很少使用）。SSD 驱动器、文件系统、云供应商等都可进行静态加密。但区别于这些加密方式，若 TiKV 在存储数据前就进行数据加密，攻击者则必须通过数据库的身份验证才能访问数据。例如，即使攻击者获得物理机的访问权限时，也无法通过复制磁盘上的文件来访问数据。 -## 各测试数据库组件支持的加密方式 +## 各 TiDB 组件支持的加密方式 在一个 TiDB 集群中，不同的组件使用不同的加密方式。本节介绍 TiKV、 TiFlash、PD 和 Backup & Restore (BR) 等不同 TiDB 组件支持的加密方式。 diff --git a/error-codes.md b/error-codes.md index 87f15b9514a4..4b895f966ccd 100644 --- a/error-codes.md +++ b/error-codes.md @@ -133,7 +133,7 @@ TiDB 兼容 MySQL 的错误码，在大多数情况下，返回和 MySQL 一样 * Error Number: 8050 - 设置了不支持的权限类型，遇到该错误请参考 [测试数据库权限说明](/privilege-management.md#测试数据库各操作需要的权限)进行调整。 + 设置了不支持的权限类型，遇到该错误请参考 [TiDB 权限说明](/privilege-management.md#tidb-各操作需要的权限)进行调整。 * Error Number: 8051 diff --git a/explain-overview.md b/explain-overview.md index adef365160de..0c1c6d806027 100644 --- a/explain-overview.md +++ b/explain-overview.md @@ -3,7 +3,7 @@ title: TiDB 执行计划概览 summary: 了解 TiDB 中 EXPLAIN 语句返回的执行计划。 --- -# 测试数据库执行计划概览 +# TiDB 执行计划概览 > **注意：** > diff --git a/faq/backup-and-restore-faq.md b/faq/backup-and-restore-faq.md index a615798bf8b4..ff853ab2c954 100644 --- a/faq/backup-and-restore-faq.md +++ b/faq/backup-and-restore-faq.md @@ -296,7 +296,7 @@ br restore full -f 'mysql.usertable' -s $external_storage_url --with-sys-table 这个情况多数是因为备份时集群的数据压缩比率和恢复时的默认值不一致导致的，只要恢复的 checksum 阶段顺利通过，可以忽略这个问题，不影响正常使用。 -### 使用 BR 恢复数据后是否需要对表执行 `ANALYZE` 以更新测试数据库在表和索引上留下的统计信息？ +### 使用 BR 恢复数据后是否需要对表执行 `ANALYZE` 以更新 TiDB 在表和索引上留下的统计信息？ BR 不会备份统计信息（v4.0.9 除外）。所以在恢复存档后需要手动执行 `ANALYZE TABLE` 或等待 TiDB 自动进行 `ANALYZE`。 diff --git a/faq/deploy-and-maintain-faq.md b/faq/deploy-and-maintain-faq.md index f84252b6618a..12e8d36ae007 100644 --- a/faq/deploy-and-maintain-faq.md +++ b/faq/deploy-and-maintain-faq.md @@ -3,17 +3,17 @@ title: TiDB 安装部署常见问题 summary: 介绍 TiDB 集群安装部署的常见问题、原因及解决方法。 --- -# 测试数据库安装部署常见问题 +# TiDB 安装部署常见问题 本文介绍 TiDB 集群安装部署的常见问题、原因及解决方法。 ## 软硬件要求 FAQ -### 测试数据库支持哪些操作系统？ +### TiDB 支持哪些操作系统？ 关于 TiDB 支持的操作系统，参见[操作系统及平台要求](/hardware-and-software-requirements.md#操作系统及平台要求)。 -### 测试数据库对开发、测试、生产环境的服务器硬件配置有什么要求？ +### TiDB 对开发、测试、生产环境的服务器硬件配置有什么要求？ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台。对于开发、测试、生产环境的服务器硬件配置，参见[服务器配置要求](/hardware-and-software-requirements.md#服务器配置要求)。 @@ -25,7 +25,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 资源可接受的话，我们建议做 RAID 10，如果资源有限，也可以不做 RAID。 -### 测试数据库集群各个组件的配置推荐？ +### TiDB 集群各个组件的配置推荐？ - TiDB 需要 CPU 和内存比较好的机器，参考官网配置要求； - PD 里面存了集群元信息，会有频繁的读写请求，对磁盘 I/O 要求相对比较高，磁盘太差会影响整个集群性能，推荐 SSD 磁盘，空间不用太大。另外集群 Region 数量越多对 CPU、内存的要求越高； @@ -41,7 +41,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 这种情况一般是因为没有使用 `--config` 参数来指定配置文件（目前只会出现在 binary 部署的场景），TiKV/PD 会按默认值来设置。如果要使用配置文件，请设置 TiKV/PD 的 `--config` 参数。对于 TiKV 组件，修改配置后重启服务即可；对于 PD 组件，只会在第一次启动时读取配置文件，之后可以使用 pd-ctl 的方式来修改配置，详情可参考 [PD 配置参数](/command-line-flags-for-pd-configuration.md)。 -### 测试数据库监控框架 Prometheus + Grafana 监控机器建议单独还是多台部署？ +### TiDB 监控框架 Prometheus + Grafana 监控机器建议单独还是多台部署？ 监控机建议单独部署。建议 CPU 8 core，内存 16 GB 以上，硬盘 500 GB 以上。 @@ -73,7 +73,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 | enable_slow_query_log | TiDB 慢查询日志记录到单独文件({{ deploy_dir }}/log/tidb_slow_query.log)，默认为 False，记录到 tidb 日志 | | deploy_without_tidb | KV 模式，不部署 TiDB 服务，仅部署 PD、TiKV 及监控服务，请将 inventory.ini 文件中 tidb_servers 主机组 IP 设置为空。 | -### 如何单独记录测试数据库中的慢查询日志，如何定位慢查询 SQL？ +### 如何单独记录 TiDB 中的慢查询日志，如何定位慢查询 SQL？ 1. TiDB 中，对慢查询的定义在 TiDB 的配置文件中。`tidb_slow_log_threshold: 300`，这个参数是配置慢查询记录阈值的，单位是 ms。 @@ -81,7 +81,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 3. 除了日志，还可以通过 `ADMIN SHOW SLOW` 命令查看，详情可参考 [`ADMIN SHOW SLOW` 命令](/identify-slow-queries.md#admin-show-slow-命令)。 -### 首次部署测试数据库集群时，没有配置 tikv 的 Label 信息，在后续如何添加配置 Label？ +### 首次部署 TiDB 集群时，没有配置 tikv 的 Label 信息，在后续如何添加配置 Label？ TiDB 的 Label 设置是与集群的部署架构相关的，是集群部署中的重要内容，是 PD 进行全局管理和调度的依据。如果集群在初期部署过程中没有设置 Label，需要在后期对部署结构进行调整，就需要手动通过 PD 的管理工具 pd-ctl 来添加 location-labels 信息，例如：`config set location-labels "zone,rack,host"`（根据实际的 label 层级名字配置）。 @@ -109,7 +109,7 @@ Direct 模式就是把写入请求直接封装成 I/O 指令发到磁盘，这 ./fio -ioengine=psync -bs=32k -fdatasync=1 -thread -rw=randrw -percentage_random=100,0 -size=10G -filename=fio_randread_write_test.txt -name='fio mixed randread and sequential write test' -iodepth=4 -runtime=60 -numjobs=4 -group_reporting --output-format=json --output=fio_randread_write_test.json ``` -## 测试数据库支持在公有云上部署吗？ +## TiDB 支持在公有云上部署吗？ TiDB 支持在 [Google Cloud GKE](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-gcp-gke)、[AWS EKS](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-aws-eks) 和[阿里云 ACK](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-alibaba-cloud) 上部署使用。 diff --git a/faq/faq-overview.md b/faq/faq-overview.md index 1a6a56edfa13..eb4ab2f5cba6 100644 --- a/faq/faq-overview.md +++ b/faq/faq-overview.md @@ -3,7 +3,7 @@ title: TiDB 产品常见问题解答汇总 summary: 汇总 TiDB 产品的常见问题解答。 --- -# 测试数据库产品常见问题解答汇总 +# TiDB 产品常见问题解答汇总 本文整合汇总了 TiDB 使用过程中常见问题解答的 (FAQ) 文档。 diff --git a/faq/high-availability-faq.md b/faq/high-availability-faq.md index 1f09123f09c6..e636e9d03d5b 100644 --- a/faq/high-availability-faq.md +++ b/faq/high-availability-faq.md @@ -7,12 +7,12 @@ summary: 介绍高可用相关的常见问题。 本文档介绍高可用相关的常见问题。 -## 测试数据库数据是强一致的吗？ +## TiDB 数据是强一致的吗？ 通过使用 [Raft 一致性算法](https://raft.github.io/)，数据在各 TiKV 节点间复制为多副本，以确保某个节点宕机时数据的安全性。 在底层，TiKV 使用复制日志 + 状态机 (State Machine) 的模型来复制数据。对于写入请求，数据被写入 Raft Leader，然后 Leader 以日志的形式将命令复制到它的 Follower 中。当集群中的大多数节点收到此日志时，日志会被提交，状态机会相应作出变更，以此来实现强一致。 -## 测试数据库是否提供三中心跨机房多活部署的推荐方案？ +## TiDB 是否提供三中心跨机房多活部署的推荐方案？ 从架构来看，TiDB 支持真正意义上的跨中心异地多活。从实现层面看，多地部署方案依赖数据中心之间的网络延迟和稳定性，一般建议延迟在 5ms 以下。目前 TiDB 已经有相似的客户部署方案，参见[两地三中心部署方案](/three-data-centers-in-two-cities-deployment.md)。 diff --git a/faq/high-reliability-faq.md b/faq/high-reliability-faq.md index cdf30adb198a..f36d72f37ade 100644 --- a/faq/high-reliability-faq.md +++ b/faq/high-reliability-faq.md @@ -7,11 +7,11 @@ summary: 介绍高可靠相关的常见问题。 本文档介绍高可靠相关的常见问题。 -## 测试数据库是否支持数据加密？ +## TiDB 是否支持数据加密？ 支持。要加密传输中的数据，可以[在 TiDB 客户端和服务器之间启用 TLS](/enable-tls-between-clients-and-servers.md)。要加密存储引擎中的数据，可以启用[透明数据加密 (TDE)](/encryption-at-rest.md)。 -## 我们的安全漏洞扫描工具对 MySQL version 有要求，测试数据库是否支持修改 server 版本号呢？ +## 我们的安全漏洞扫描工具对 MySQL version 有要求，TiDB 是否支持修改 server 版本号呢？ TiDB 在 v3.0.8 后支持通过 TiDB 配置文件中的 [`server-version`](/tidb-configuration-file.md#server-version) 配置项来修改 server 版本号。 @@ -25,7 +25,7 @@ server_configs: 修改完成后，使用 `tiup cluster reload -R tidb` 命令使得以上修改生效，以避免出现安全漏洞扫描不通过的问题。 -## 测试数据库支持哪些认证协议？过程是怎样的？ +## TiDB 支持哪些认证协议？过程是怎样的？ TiDB 和 MySQL 一样，在用户登录认证时使用 SASL 认证协议对密码进行处理。 diff --git a/faq/manage-cluster-faq.md b/faq/manage-cluster-faq.md index f890cc004865..394de80f24ee 100644 --- a/faq/manage-cluster-faq.md +++ b/faq/manage-cluster-faq.md @@ -3,7 +3,7 @@ title: TiDB 集群管理常见问题 summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 --- -# 测试数据库集群管理常见问题 +# TiDB 集群管理常见问题 本文介绍管理 TiDB 集群时的常见问题、原因及解决方法。 @@ -11,7 +11,7 @@ summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 本小节介绍集群日程管理中的常见问题、原因及解决方法。 -### 测试数据库如何登录？ +### TiDB 如何登录？ 和 MySQL 登录方式一样，可以按照下面例子进行登录。 @@ -21,7 +21,7 @@ summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 mysql -h 127.0.0.1 -uroot -P4000 ``` -### 测试数据库如何修改数据库系统变量？ +### TiDB 如何修改数据库系统变量？ 和 MySQL 一样，TiDB 也分为静态参数和固态参数，静态参数可以直接通过 `SET GLOBAL xxx = n` 的方式进行修改，不过新参数值只限于该实例生命周期有效。 @@ -29,11 +29,11 @@ mysql -h 127.0.0.1 -uroot -P4000 默认在 [`--data-dir`](/command-line-flags-for-tikv-configuration.md#--data-dir) 目录下，其中包括 backup、db、raft、snap 四个目录，分别存储备份、数据、raft 数据及镜像数据。 -### 测试数据库有哪些系统表？ +### TiDB 有哪些系统表？ 和 MySQL 类似，TiDB 中也有系统表，用于存放数据库运行时所需信息，具体信息参考 [TiDB 系统表](/mysql-schema/mysql-schema-user.md)文档。 -### 测试数据库各节点服务器下是否有日志文件，如何管理？ +### TiDB 各节点服务器下是否有日志文件，如何管理？ 默认情况下各节点服务器会在日志中输出标准错误，如果启动的时候通过 `--log-file` 参数指定了日志文件，那么日志会输出到指定的文件中，并且按天做 rotation。 @@ -49,7 +49,7 @@ mysql -h 127.0.0.1 -uroot -P4000 - 若未使用 load balancer：执行 `SHUTDOWN` 语句，TiDB 组件会做 graceful shutdown。 -### 测试数据库里面可以执行 kill 命令吗？ +### TiDB 里面可以执行 kill 命令吗？ - Kill DML 语句： @@ -61,15 +61,15 @@ mysql -h 127.0.0.1 -uroot -P4000 - Kill DDL 语句：执行 `admin show ddl jobs`，查找需要 kill 的 DDL job ID，然后执行 `admin cancel ddl jobs 'job_id' [, 'job_id'] ...`。具体可以参考 [`ADMIN`](/sql-statements/sql-statement-admin.md)。 -### 测试数据库是否支持会话超时？ +### TiDB 是否支持会话超时？ TiDB 目前支持 [`wait_timeout`](/system-variables.md#wait_timeout)、[`interactive_timeout`](/system-variables.md#interactive_timeout) 和 [`tidb_idle_transaction_timeout`](/system-variables.md#tidb_idle_transaction_timeout-从-v760-版本开始引入) 三种超时。 -### 测试数据库的版本管理策略是怎么样的？ +### TiDB 的版本管理策略是怎么样的？ 关于 TiDB 版本的管理策略，可以参考 [TiDB 版本规则](/releases/versioning.md)。 -### 部署和维护测试数据库集群的运营成本如何？ +### 部署和维护 TiDB 集群的运营成本如何？ TiDB 提供了一些特性和[工具](/ecosystem-tool-user-guide.md)，可以帮助你以低成本管理集群： @@ -84,14 +84,14 @@ TiDB 目前社区非常活跃，同时，我们还在不断的优化和修改 BU - 通过 `select tidb_version()` 进行查看 - 通过执行 `tidb-server -V` 进行查看 -### 如何扩容测试数据库集群？ +### 如何扩容 TiDB 集群？ 可以在不影响线上服务的情况下，对 TiDB 集群进行扩容。 - 如果是使用 [TiUP](/production-deployment-using-tiup.md) 部署的集群，可以参考[使用 TiUP 扩容 TiDB 集群](/scale-tidb-using-tiup.md)。 - 如果是使用 [TiDB Operator](/tidb-operator-overview.md) 在 Kubernetes 上部署的集群，可以参考[在 Kubernetes 中手动扩容 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/scale-a-tidb-cluster)。 -### 测试数据库如何进行水平扩展？ +### TiDB 如何进行水平扩展？ 当您的业务不断增长时，数据库可能会面临三方面瓶颈，第一是存储空间，第二是计算资源，第三是读写容量，这时可以对 TiDB 集群做水平扩展。 @@ -103,7 +103,7 @@ TiDB 目前社区非常活跃，同时，我们还在不断的优化和修改 BU 详细可参考 [Percolator 和 TiDB 事务算法](https://pingcap.com/blog-cn/percolator-and-txn/)。 -### 测试数据库为什么选用 gRPC 而不选用 Thrift，是因为 Google 在用吗？ +### TiDB 为什么选用 gRPC 而不选用 Thrift，是因为 Google 在用吗？ 不只是因为 Google 在用，有一些比较好的特性我们需要，比如流控、加密还有 Streaming。 @@ -168,7 +168,7 @@ Client 连接只能通过 TiDB 访问集群，TiDB 负责连接 PD 与 TiKV，PD 本小节介绍 TiDB server 管理中的常见问题、原因及解决方法。 -### 测试数据库的 lease 参数应该如何设置？ +### TiDB 的 lease 参数应该如何设置？ 启动 TiDB Server 时，需要通过命令行参数设置 lease 参数 (`--lease=60`)，其值会影响 DDL 的速度（只会影响当前执行 DDL 的 session，其他的 session 不会受影响）。在测试阶段，lease 的值可以设为 1s，加快测试进度；在生产环境下，我们推荐这个值设为分钟级（一般可以设为 60），这样可以保证 DDL 操作的安全。 @@ -191,7 +191,7 @@ Client 连接只能通过 TiDB 访问集群，TiDB 负责连接 PD 与 TiKV，PD - 由于停 TiDB 时不能与 PD 正常通信（包括停电情况）或者用 `kill -9` 指令停 TiDB 导致 TiDB 没有及时从 PD 清理注册数据，那么会影响 TiDB 启动后 10min 内的 DDL 语句处理时间。这段时间内运行 DDL 语句时，每个 DDL 状态变化都需要等待 2 * lease（默认 lease = 45s）。 - 当集群中某个 TiDB 与 PD 之间发生通信问题，即 TiDB 不能从 PD 及时获取或更新版本信息，那么这时候 DDL 操作的每个状态处理需要等待 2 * lease。 -### 测试数据库可以使用 S3 作为后端存储吗？ +### TiDB 可以使用 S3 作为后端存储吗？ 不可以，目前 TiDB 只支持分布式存储引擎和 GolevelDB/RocksDB/BoltDB 引擎。 @@ -207,7 +207,7 @@ TiDB-server 与 TiKV-server 随时进行通信，在进行大量数据操作过 TiClient Region Error 该指标描述的是在 TiDB-server 作为客户端通过 KV 接口访问 TiKV-server 进行数据操作过程中，TiDB-server 操作 TiKV-server 中的 Region 数据出现的错误类型与 metric 指标，错误类型包括 not_leader、stale_epoch。出现这些错误的情况是当 TiDB-server 根据自己的缓存信息去操作 Region leader 数据的时候，Region leader 发生了迁移或者 TiKV 当前的 Region 信息与 TiDB 缓存的路由信息不一致而出现的错误提示。一般这种情况下，TiDB-server 都会自动重新从 PD 获取最新的路由数据，重做之前的操作。 -### 测试数据库同时支持的最大并发连接数？ +### TiDB 同时支持的最大并发连接数？ 默认情况下，每个 TiDB 服务器的最大连接数没有限制。如有需要，可以在 `config.toml` 文件中设置 `instance.max_connections`（或者系统变量 `max_connections`）来限制最大连接数。如果并发量过大导致响应时间增加，建议通过添加 TiDB 节点进行扩容。 @@ -215,11 +215,11 @@ TiClient Region Error 该指标描述的是在 TiDB-server 作为客户端通过 information_schema 库中的 tables 表里的 create_time 即为表的真实创建时间。 -### 测试数据库的日志中 EXPENSIVE_QUERY 是什么意思？ +### TiDB 的日志中 EXPENSIVE_QUERY 是什么意思？ TiDB 在执行 SQL 时，预估出来每个 operator 处理了超过 10000 条数据就认为这条 query 是 expensive query。可以通过修改 tidb-server 配置参数来对这个门限值进行调整，调整后需要重新启动 tidb-server。 -### 如何预估测试数据库中一张表的大小？ +### 如何预估 TiDB 中一张表的大小？ 要预估 TiDB 中一张表的大小，你可以参考使用以下查询语句： @@ -373,14 +373,14 @@ TiKV 支持单独进行接口调用，理论上也可以起个实例做为 Cache TiKV 的内存占用主要来自于 RocksDB 的 block-cache，默认为系统总内存的 40%。当 TiKV 容易出现 OOM 时，检查 `block-cache-size` 配置是否过高。还需要注意，当单机部署了多个 TiKV 实例时，需要显式地配置该参数，以防止多个实例占用过多系统内存导致 OOM。 -### 测试数据库数据和 RawKV 数据可存储于同一个 TiKV 集群里吗？ +### TiDB 数据和 RawKV 数据可存储于同一个 TiKV 集群里吗？ 这取决于你使用的 TiDB 版本以及是否启用了 TiKV API V2 （即 [`storage.api-version = 2`](/tikv-configuration-file.md#api-version-从-v610-版本开始引入)）。 - 如果你使用的是 v6.1.0 或之后版本的 TiDB，并且启用了 TiKV API V2，那么 TiDB 数据和 RawKV 数据可以共存于同一个 TiKV 集群。 - 否则，不可以将 TiDB 数据和 RawKV 数据存储于同一个 TiKV 集群中，因为 TiDB 数据（或使用事务 API 创建的数据）的 key 的格式与使用 RawKV API 创建的数据（或来自其他基于 RawKV 的服务生成的数据）不兼容。 -## 测试数据库测试 +## TiDB 测试 本小节介绍 TiDB 测试中的常见问题、原因及解决方法。 @@ -391,21 +391,21 @@ TiKV 的内存占用主要来自于 RocksDB 的 block-cache，默认为系统总 - 大家不要用过多精力纠结这类基准测试上，应该更多关注 TiDB 的场景上的区别。 - 大家可以直接参考 [TiDB Sysbench 性能测试报告](/benchmark/v3.0-performance-benchmarking-with-sysbench.md)。 -### 测试数据库集群容量 QPS 与节点数之间关系如何，和 MySQL 对比如何？ +### TiDB 集群容量 QPS 与节点数之间关系如何，和 MySQL 对比如何？ - 在 10 节点内，TiDB 写入能力 (Insert TPS) 和节点数量基本成 40% 线性递增，MySQL 由于是单节点写入，所以不具备写入扩展能力。 - MySQL 读扩容可以通过添加从库进行扩展，但写流量无法扩展，只能通过分库分表，而分库分表有很多问题，具体参考[方案虽好，成本先行：数据库 Sharding+Proxy 实践解析](http://dbaplus.cn/news-11-1854-1.html)。 - TiDB 不管是读流量、还是写流量都可以通过添加节点快速方便的进行扩展。 -### 我们的 DBA 测试过 MySQL 性能，单台测试数据库的性能没有 MySQL 性能那么好？ +### 我们的 DBA 测试过 MySQL 性能，单台 TiDB 的性能没有 MySQL 性能那么好？ TiDB 设计的目标就是针对 MySQL 单台容量限制而被迫做的分库分表的场景，或者需要强一致性和完整分布式事务的场景。它的优势是通过尽量下推到存储节点进行并行计算。对于小表（比如千万级以下），不适合 TiDB，因为数据量少，Region 有限，发挥不了并行的优势。其中最极端的例子就是计数器表，几行记录高频更新，这几行在 TiDB 里，会变成存储引擎上的几个 KV，然后只落在一个 Region 里，而这个 Region 只落在一个节点上。加上后台强一致性复制的开销，TiDB 引擎到 TiKV 引擎的开销，最后表现出来的就是没有单个 MySQL 好。 -## 测试数据库备份恢复 +## TiDB 备份恢复 本小节介绍 TiDB 备份恢复中的常见问题、原因及解决方法。 -### 测试数据库主要备份方式？ +### TiDB 主要备份方式？ 目前，数据量大时（大于 1 TB）推荐使用 [Backup & Restore (BR)](/br/backup-and-restore-overview.md) 进行备份。其他场景推荐使用 [Dumpling](/dumpling-overview.md) 进行备份。 diff --git a/faq/migration-tidb-faq.md b/faq/migration-tidb-faq.md index 855de89fca5f..7c025068a839 100644 --- a/faq/migration-tidb-faq.md +++ b/faq/migration-tidb-faq.md @@ -16,7 +16,7 @@ summary: 介绍 TiDB 迁移中的常见问题。 ## 全量数据导出导入 -### 如何将一个运行在 MySQL 上的应用迁移到测试数据库上？ +### 如何将一个运行在 MySQL 上的应用迁移到 TiDB 上？ TiDB 支持绝大多数 MySQL 语法，一般不需要修改代码。 @@ -69,11 +69,11 @@ iperf Done. 如果输出的各指标良好，请尝试更新各组件版本。如果更新后仍无法解决问题，请移步 [AskTUG 论坛](https://asktug.com/)寻求帮助。 -### 不小心把 MySQL 的 user 表导入到测试数据库了，或者忘记密码，无法登录，如何处理？ +### 不小心把 MySQL 的 user 表导入到 TiDB 了，或者忘记密码，无法登录，如何处理？ 重启 TiDB 服务，配置文件中增加 `-skip-grant-table=true` 参数，无密码登录集群后，可以根据情况重建用户，或者重建 mysql.user 表，具体表结构搜索官网。 -### 如何导出测试数据库数据？ +### 如何导出 TiDB 数据？ 你可以通过以下方式导出 TiDB 数据： @@ -91,7 +91,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 目前看来 OGG 最为合适。 -### 用 Sqoop 批量写入测试数据库数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ +### 用 Sqoop 批量写入 TiDB 数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ - 在 Sqoop 中，`--batch` 是指每个批次提交 100 条 statement，但是默认每个 statement 包含 100 条 SQL 语句，所以此时 100 * 100 = 10000 条 SQL 语句，超出了 TiDB 的事务限制 5000 条，可以增加选项 `-Dsqoop.export.records.per.statement=10` 来解决这个问题，完整的用法如下： @@ -119,7 +119,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 在上述情况下，Dumpling 划分导出子范围时，会划分出过大的子范围，从而向上游发送结果过大的查询。请联系 [AskTUG 社区专家](https://asktug.com/)获取实验版本的 Dumpling。 -### 测试数据库有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ +### TiDB 有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ 有，也支持 DDL。详细参考 [TiDB 历史数据回溯](/read-historical-data.md)。 @@ -135,7 +135,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 我们建议通过 [TiDB Data Migration](/dm/dm-overview.md) 进行 MySQL -> TiDB 的业务数据的迁移；业务读写可以按照需求分阶段通过修改网络配置进行流量迁移，建议 DB 上层部署一个稳定的网络 LB（HAproxy、LVS、F5、DNS 等），这样直接修改网络配置就能实现无缝流量迁移。 -### 测试数据库总读写流量有限制吗？ +### TiDB 总读写流量有限制吗？ TiDB 读流量可以通过增加 TiDB server 进行扩展，总读容量无限制，写流量可以通过增加 TiKV 节点进行扩容，基本上写容量也没有限制。 @@ -151,7 +151,7 @@ TiDB 限制了单条 KV entry 不超过 6MB，可以修改配置文件中的 [`t 导入数据的时候，可以分批插入，每批最好不要超过 1w 行。 -### 测试数据库中删除数据后会立即释放空间吗？ +### TiDB 中删除数据后会立即释放空间吗？ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DROP 操作，在达到 TiDB 的 GC (garbage collection) 时间后（默认 10 分钟），TiDB 的 GC 机制会删除数据并释放空间。对于 DELETE 操作 TiDB 的 GC 机制会删除数据，但不会释放空间，而是当后续数据写入 RocksDB 且进行 compact 时对空间重新利用。 @@ -159,7 +159,7 @@ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DRO 不可以，加载数据期间不能对目标表执行任何 DDL 操作，这会导致数据加载失败。 -### 测试数据库是否支持 replace into 语法？ +### TiDB 是否支持 replace into 语法？ 支持。 @@ -171,7 +171,7 @@ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DRO 在删除大量数据的时候，建议使用 `Delete from t where xx limit 5000`（xx 建议在满足业务过滤逻辑下，尽量加上强过滤索引列或者直接使用主键选定范围，如 `id >= 5000*n+m and id <= 5000*(n+1)+m` 这样的方案，通过循环来删除，用 `Affected Rows == 0` 作为循环结束条件，这样避免遇到事务大小的限制。如果一次删除的数据量非常大，这种循环的方式会越来越慢，因为每次删除都是从前向后遍历，前面的删除之后，短时间内会残留不少删除标记（后续会被 GC 掉），影响后面的 Delete 语句。如果有可能，建议把 Where 条件细化。可以参考官网[最佳实践](https://pingcap.com/blog-cn/tidb-best-practice/)。 -### 测试数据库如何提高数据加载速度？ +### TiDB 如何提高数据加载速度？ 主要有两个方面： diff --git a/faq/monitor-faq.md b/faq/monitor-faq.md index 1bd55e8c7a88..c947d972925a 100644 --- a/faq/monitor-faq.md +++ b/faq/monitor-faq.md @@ -3,7 +3,7 @@ title: TiDB 监控常见问题 summary: 介绍在监控 TiDB 集群时的常见问题、原因及解决方法。 --- -# 测试数据库监控常见问题 +# TiDB 监控常见问题 本文介绍在监控 TiDB 集群时的常见问题、原因及解决方法。 diff --git a/faq/sql-faq.md b/faq/sql-faq.md index ae20718dd97d..18a578cbb7a6 100644 --- a/faq/sql-faq.md +++ b/faq/sql-faq.md @@ -7,11 +7,11 @@ summary: 介绍 SQL 操作相关的常见问题。 本文档介绍 TiDB 中常见的 SQL 操作问题。 -## 测试数据库是否支持二级键？ +## TiDB 是否支持二级键？ 支持。你可以在具有唯一[二级索引](/develop/dev-guide-create-secondary-indexes.md)的非主键列上设置 [`NOT NULL` 约束](/constraints.md#非空约束)。在这种情况下，该列用作二级键。 -## 测试数据库在对大表执行 DDL 操作时，性能表现如何？ +## TiDB 在对大表执行 DDL 操作时，性能表现如何？ TiDB 在对大表执行 DDL 操作时，一般不会有什么问题。TiDB 支持在线 DDL 操作，且这些 DDL 操作不会阻塞 DML 操作。 @@ -56,11 +56,11 @@ DROP GLOBAL BINDING for SELECT * FROM t1, t2 WHERE t1.id = t2.id; ``` -## 测试数据库对哪些 MySQL variables 兼容？ +## TiDB 对哪些 MySQL variables 兼容？ 详细可参考[系统变量](/system-variables.md)。 -## 省略 `ORDER BY` 条件时测试数据库中返回结果的顺序与 MySQL 中的不一致 +## 省略 `ORDER BY` 条件时 TiDB 中返回结果的顺序与 MySQL 中的不一致 这不是 bug。返回结果的顺序视不同情况而定，不保证顺序统一。 @@ -124,7 +124,7 @@ MySQL 中，返回结果的顺序可能较为固定，因为查询是通过单 在 TiDB 中，你还可以使用系统变量 [`tidb_enable_ordered_result_mode`](/system-variables.md#tidb_enable_ordered_result_mode) 来指定是否对最终的输出结果进行自动排序。 -## 测试数据库是否支持 `SELECT FOR UPDATE`？ +## TiDB 是否支持 `SELECT FOR UPDATE`？ 支持。当 TiDB 使用悲观锁（自 TiDB v3.0.8 起默认使用）时，TiDB 中 `SELECT FOR UPDATE` 的行为与 MySQL 中的基本一致。 @@ -132,7 +132,7 @@ MySQL 中，返回结果的顺序可能较为固定，因为查询是通过单 详情参考 [SELECT 语句语法元素说明](/sql-statements/sql-statement-select.md#语法元素说明)。 -## 测试数据库的 codec 能保证 UTF8 的字符串是 memcomparable 的吗？我们的 key 需要支持 UTF8，有什么编码建议吗？ +## TiDB 的 codec 能保证 UTF8 的字符串是 memcomparable 的吗？我们的 key 需要支持 UTF8，有什么编码建议吗？ TiDB 的默认字符集是 `utf8mb4`，字符串是 memcomparable 格式。关于字符集的更多信息，参见[字符集和排序规则](/character-set-and-collation.md)。 @@ -142,18 +142,18 @@ TiDB 的默认字符集是 `utf8mb4`，字符串是 memcomparable 格式。关 在使用乐观事务并开启事务重试的情况下，默认限制 5000，可通过 [`stmt-count-limit`](/tidb-configuration-file.md#stmt-count-limit) 调整。 -## 测试数据库中，为什么出现后插入数据的自增 ID 反而小？ +## TiDB 中，为什么出现后插入数据的自增 ID 反而小？ TiDB 的自增 ID (`AUTO_INCREMENT`) 只保证自增且唯一，并不保证连续分配。TiDB 目前采用批量分配的方式，所以如果在多台 TiDB server 上同时插入数据，分配的自增 ID 会不连续。当多个线程并发往不同的 TiDB server 插入数据的时候，有可能会出现后插入的数据自增 ID 小的情况。此外，TiDB 允许给整型类型的字段指定 AUTO_INCREMENT，且一个表只允许一个属性为 `AUTO_INCREMENT` 的字段。详情可参考[自增 ID](/mysql-compatibility.md#自增-id)和 [AUTO_INCREMENT](/auto-increment.md)。 -## 如何在测试数据库中修改 `sql_mode`？ +## 如何在 TiDB 中修改 `sql_mode`？ TiDB 支持在会话或全局作用域上修改 [`sql_mode`](/system-variables.md#sql_mode) 系统变量。 - 对全局作用域变量的修改，设置后将作用于集群中的其它服务器，并且重启后更改依然有效。因此，你无需在每台 TiDB 服务器上都更改 `sql_mode` 的值。 - 对会话作用域变量的修改，设置后只影响当前会话，重启后更改消失。 -## 用 Sqoop 批量写入测试数据库数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ +## 用 Sqoop 批量写入 TiDB 数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ 问题原因：在 Sqoop 中，`--batch` 是指每个批次提交 100 条 statement，但是默认每个 statement 包含 100 条 SQL 语句，所以此时 100 * 100 = 10000 条 SQL 语句，超出了 TiDB 的事务限制 5000 条。 @@ -174,11 +174,11 @@ TiDB 支持在会话或全局作用域上修改 [`sql_mode`](/system-variables.m - 也可以选择增大 TiDB 的单个事物语句数量限制，不过此操作会导致内存增加。详情参见 [SQL 语句的限制](/tidb-limitations.md#sql-statements-的限制)。 -## 测试数据库有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ +## TiDB 有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ 有，也支持 DDL。详细参考[使用 AS OF TIMESTAMP 语法读取历史数据](/as-of-timestamp.md)。 -## 测试数据库中删除数据后会立即释放空间吗？ +## TiDB 中删除数据后会立即释放空间吗？ 在 TiDB 中使用 `DELETE`，`TRUNCATE` 和 `DROP` 语句删除数据都不会立即释放空间。对于 `TRUNCATE` 和 `DROP` 操作，在达到 TiDB 的 GC (garbage collection) 时间后（默认 10 分钟），TiDB 的 GC 机制会删除数据并释放空间。对于 DELETE 操作，TiDB 的 GC 机制会删除数据，但不会立即释放空间，而是等到后续进行 compaction 时释放空间。 @@ -198,7 +198,7 @@ TiDB 中的 `SHOW PROCESSLIST` 与 MySQL 中的 `SHOW PROCESSLIST` 显示内容 + 在查询执行期间，TiDB 中的 `State` 列不会持续更新。由于 TiDB 支持并行查询，每个语句可能同时处于多个状态，因此很难显示为某一种状态。 -## 在测试数据库中如何控制或改变 SQL 提交的执行优先级？ +## 在 TiDB 中如何控制或改变 SQL 提交的执行优先级？ TiDB 支持改变[全局](/system-variables.md#tidb_force_priority)或单个语句的优先级。优先级包括： @@ -224,7 +224,7 @@ TiDB 支持改变[全局](/system-variables.md#tidb_force_priority)或单个语 2. 全表扫会自动调整为低优先级，[`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 也是默认低优先级。 -## 在测试数据库中 `auto analyze` 的触发策略是怎样的？ +## 在 TiDB 中 `auto analyze` 的触发策略是怎样的？ 当一张表或分区表的单个分区达到 1000 条记录，且表或分区的（修改数/当前总行数）比例大于 [`tidb_auto_analyze_ratio`](/system-variables.md#tidb_auto_analyze_ratio) 的时候，会自动触发 [`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 语句。 @@ -326,7 +326,7 @@ TiDB 在执行 SQL 语句时，会根据隔离级别确定一个对象的 `schem ## SQL 优化 -### 测试数据库执行计划解读 +### TiDB 执行计划解读 详细解读[理解 TiDB 执行计划](/explain-overview.md)。 @@ -371,7 +371,7 @@ RUNNING_JOBS: ID:121, Type:add index, State:running, SchemaState:write reorganiz - `ADMIN SHOW DDL JOBS`：用于查看当前 DDL 作业队列中的所有结果（包括正在运行以及等待运行的任务）以及已执行完成的 DDL 作业队列中的最近十条结果。 - `ADMIN SHOW DDL JOBS QUERIES 'job_id' [, 'job_id'] ...`：用于显示 `job_id` 对应的 DDL 任务的原始 SQL 语句。此 `job_id` 只搜索正在执行中的任务以及 DDL 历史作业队列中的最近十条结果。 -### 测试数据库是否支持基于 COST 的优化 (CBO)？如果支持，实现到什么程度？ +### TiDB 是否支持基于 COST 的优化 (CBO)？如果支持，实现到什么程度？ 是的，TiDB 基于成本的优化器 (CBO) 对代价模型、统计信息进行持续优化。除此之外，TiDB 还支持 hash join、sort-merge join 等 join 算法。 @@ -383,7 +383,7 @@ RUNNING_JOBS: ID:121, Type:add index, State:running, SchemaState:write reorganiz ID 没什么规律，只要是唯一就行。不过在生成执行计划时，有一个计数器，生成一个计划 ID 后序号就加 1，执行的顺序和序号无关。整个执行计划是一颗树，执行时从根节点开始，不断地向上返回数据。要理解执行计划，请参考[理解 TiDB 执行计划](/explain-overview.md)。 -### 测试数据库执行计划中，task cop 在一个 root 下，这个是并行的吗？ +### TiDB 执行计划中，task cop 在一个 root 下，这个是并行的吗？ 目前 TiDB 的计算任务隶属于两种不同的 task：cop task 和 root task。cop task 是指被下推到 KV 端分布式执行的计算任务，root task 是指在 TiDB 端单点执行的计算任务。 @@ -393,11 +393,11 @@ ID 没什么规律，只要是唯一就行。不过在生成执行计划时， ## 数据库优化 -### 测试数据库参数及调整 +### TiDB 参数及调整 详情参考 [TiDB 配置参数](/command-line-flags-for-tidb-configuration.md)。 -### 如何避免热点问题并实现负载均衡？测试数据库中是否有热分区或热范围问题？ +### 如何避免热点问题并实现负载均衡？TiDB 中是否有热分区或热范围问题？ 要了解热点问题的场景，请参考[常见热点问题](/troubleshoot-hot-spot-issues.md#常见热点场景)。TiDB 的以下特性旨在帮助解决热点问题： diff --git a/faq/tidb-faq.md b/faq/tidb-faq.md index be7f0614113b..1e8dae0804ff 100644 --- a/faq/tidb-faq.md +++ b/faq/tidb-faq.md @@ -3,19 +3,19 @@ title: TiDB 产品常见问题 summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型数据库，支持在线事务处理与在线分析处理，具备水平扩容、高可用、实时 HTAP、云原生的特性。TiDB 不是基于 MySQL 开发的，而是由 PingCAP 团队完全自主开发的产品。TiDB 易用性很高，支持绝大部分 MySQL 8.0 的语法，但不支持触发器、存储过程、自定义函数等。TiDB 支持分布式事务，兼容 MySQL Client/Driver 的编程语言，支持其他存储引擎，如 TiKV、UniStore 和 MockTiKV。获取 TiDB 知识的途径包括官方文档、官方博客、AskTUG 社区论坛和 PingCAP Education。用户名长度限制为 32 个字符，最大列数为 1017，单行大小不超过 6MB。TiDB 不支持 XA，但支持对列存储引擎的高并发 INSERT 或 UPDATE 操作。 --- -# 测试数据库产品常见问题 +# TiDB 产品常见问题 -## 1.1 测试数据库介绍及整体架构 +## 1.1 TiDB 介绍及整体架构 -### 1.1.1 测试数据库是什么？ +### 1.1.1 TiDB 是什么？ [TiDB](https://github.com/pingcap/tidb) 是 [PingCAP](https://pingcap.com/about-cn/) 公司自主设计、研发的开源分布式关系型数据库，是一款同时支持在线事务处理与在线分析处理 (Hybrid Transactional and Analytical Processing, HTAP) 的融合型分布式数据库产品，具备水平扩容或者缩容、金融级高可用、实时 HTAP、云原生的分布式数据库、兼容 MySQL 协议和 MySQL 生态等重要特性。目标是为用户提供一站式 OLTP (Online Transactional Processing)、OLAP (Online Analytical Processing)、HTAP 解决方案。TiDB 适合高可用、强一致要求较高、数据规模较大等各种应用场景。更多详细信息，请参阅 [TiDB 简介](/overview.md)。 -### 1.1.2 测试数据库整体架构 +### 1.1.2 TiDB 整体架构 参见 [TiDB 整体架构](/tidb-architecture.md)，以及 TiDB 数据库的[存储](/tidb-storage.md)、[计算](/tidb-computing.md)与[调度](/tidb-scheduling.md)。 -### 1.1.3 测试数据库是基于 MySQL 开发的吗？ +### 1.1.3 TiDB 是基于 MySQL 开发的吗？ 不是。虽然 TiDB 支持 MySQL 语法和协议，但是 TiDB 是由 PingCAP 团队完全自主开发的产品。 @@ -25,25 +25,25 @@ summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型 - TiKV 是分布式 Key-Value 存储引擎，用来存储真正的数据，简而言之，TiKV 是 TiDB 的存储引擎。 - PD 是 TiDB 集群的管理组件，负责存储 TiKV 的元数据，同时也负责分配时间戳以及对 TiKV 做负载均衡调度。 -### 1.1.5 测试数据库易用性如何？ +### 1.1.5 TiDB 易用性如何？ TiDB 使用起来很简单，可以将 TiDB 集群当成 MySQL 来用。你可以将 TiDB 用在任何以 MySQL 作为后台存储服务的应用中，并且基本上不需要修改应用代码，同时你可以用大部分流行的 MySQL 管理工具来管理 TiDB。 -### 1.1.6 测试数据库和 MySQL 兼容性如何？ +### 1.1.6 TiDB 和 MySQL 兼容性如何？ TiDB 支持绝大部分 MySQL 8.0 的语法，但目前还不支持触发器、存储过程、自定义函数等。详情参见[与 MySQL 兼容性对比](/mysql-compatibility.md)。 -### 1.1.7 测试数据库支持分布式事务吗？ +### 1.1.7 TiDB 支持分布式事务吗？ 支持。无论是一个地方的几个节点，还是[跨多个数据中心的多个节点](/multi-data-centers-in-one-city-deployment.md)，TiDB 均支持 ACID 分布式事务。 TiDB 事务模型灵感源自 Google Percolator 模型，主体是一个两阶段提交协议，并进行了一些实用的优化。该模型依赖于一个时间戳分配器，为每个事务分配单调递增的时间戳，这样就检测到事务冲突。在 TiDB 集群中，[PD](/tidb-scheduling.md) 承担时间戳分配器的角色。 -### 1.1.8 测试数据库支持哪些编程语言？ +### 1.1.8 TiDB 支持哪些编程语言？ 只要支持 MySQL Client/Driver 的编程语言，都可以直接使用 TiDB。 -### 1.1.9 测试数据库是否支持其他存储引擎？ +### 1.1.9 TiDB 是否支持其他存储引擎？ 是的，除了 TiKV 之外，TiDB 还支持一些单机存储引擎，比如 UniStore 和 MockTiKV。注意，TiDB 后续版本可能不再支持 MockTiKV。 @@ -70,25 +70,25 @@ Usage of ./bin/tidb-server: ...... ``` -### 1.1.10 除了官方文档，有没有其他测试数据库知识获取途径？ +### 1.1.10 除了官方文档，有没有其他 TiDB 知识获取途径？ - [官方文档](https://docs.pingcap.com/zh/)：获取 TiDB 相关知识最主要、最及时的途径。 - [官方博客](https://cn.pingcap.com/blog/)：了解产品技术解读、观点洞察、案例实践。 - [AskTUG 社区论坛](https://asktug.com)：与社区用户、技术专家互动交流。 - [PingCAP Education](https://cn.pingcap.com/education/)：学习线上课程，获得数据库能力认证。 -### 1.1.11 测试数据库用户名长度限制？ +### 1.1.11 TiDB 用户名长度限制？ 在 TiDB 中，用户名最长为 32 个字符。 -### 1.1.12 测试数据库中列数和行大小的限制是多少？ +### 1.1.12 TiDB 中列数和行大小的限制是多少？ - TiDB 中默认的最大列数为 1017。你可以调整这个限制，最大可调整到 4096 列。 - TiDB 中默认单行大小不超过 6 MB。你可以调整这个限制，最大可调整到 120 MB。 更多信息，请参考 [TiDB 限制](/tidb-limitations.md)。 -### 1.1.13 测试数据库是否支持 XA？ +### 1.1.13 TiDB 是否支持 XA？ 虽然 TiDB 的 JDBC 驱动用的就是 MySQL Connector/J，但是当使用 Atomikos 的时候，数据源要配置成类似这样的配置：`type="com.mysql.jdbc.jdbc2.optional.MysqlXADataSource"`。MySQL JDBC XADataSource 连接 TiDB 的模式目前是不支持的。MySQL JDBC 中配置好的 XADataSource 模式，只对 MySQL 数据库起作用（DML 去修改 redo 等）。 @@ -96,7 +96,7 @@ Atomikos 配好两个数据源后，JDBC 驱动都要设置成 XA 模式，然 MySQL 是单机数据库，只能通过 XA 来满足跨数据库事务，而 TiDB 本身就通过 Google 的 Percolator 事务模型支持分布式事务，性能稳定性比 XA 要高出很多，所以不会也不需要支持 XA。 -### 1.1.14 测试数据库如何在不影响性能的情况下支持对列存储引擎 (TiFlash) 的高并发 `INSERT` 或 `UPDATE` 操作？ +### 1.1.14 TiDB 如何在不影响性能的情况下支持对列存储引擎 (TiFlash) 的高并发 `INSERT` 或 `UPDATE` 操作？ - [TiFlash](/tiflash/tiflash-overview.md) 引入了 DeltaTree 这种特殊结构来处理列存引擎的修改。 - TiFlash 作为 Raft Group 中的 Learner 角色，不参与 log commit 选举，也不会写入数据。这意味着 DML 操作不需要等待 TiFlash 的确认，所以 TiFlash 不会影响 OLTP 的性能。另外，TiFlash 和 TiKV 分开部署在不同的实例上，不会相互影响。 @@ -105,13 +105,13 @@ MySQL 是单机数据库，只能通过 XA 来满足跨数据库事务，而 TiD TiFlash 默认保持数据强一致性。Raft Learner 流程会更新数据。此外 TSO 检查可以确保查询中的数据与事务完全一致。更多信息，请参考[异步复制](/tiflash/tiflash-overview.md#异步复制)和[一致性](/tiflash/tiflash-overview.md#一致性)。 -## 1.2 测试数据库原理 +## 1.2 TiDB 原理 ### 1.2.1 存储 TiKV 详细解读 [三篇文章了解 TiDB 技术内幕 - 说存储](https://cn.pingcap.com/blog/tidb-internal-1) -### 1.2.2 计算测试数据库详细解读 +### 1.2.2 计算 TiDB 详细解读 [三篇文章了解 TiDB 技术内幕 - 说计算](https://cn.pingcap.com/blog/tidb-internal-2) diff --git a/filter-binlog-event.md b/filter-binlog-event.md index 6ded496d946a..1bf5908aba01 100644 --- a/filter-binlog-event.md +++ b/filter-binlog-event.md @@ -97,7 +97,7 @@ filters: action: Do ``` -### 过滤测试数据库不支持的 SQL 语句 +### 过滤 TiDB 不支持的 SQL 语句 ``` filters: diff --git a/foreign-key.md b/foreign-key.md index a370767d57c7..ad1b96089a2f 100644 --- a/foreign-key.md +++ b/foreign-key.md @@ -283,7 +283,7 @@ mysql> explain analyze delete from parent where id = 1; ## 兼容性 -### 测试数据库版本间兼容性 +### TiDB 版本间兼容性 TiDB 在 v6.6.0 之前已经支持创建外键的语法，但创建的外键并不生效。如果将之前创建的 TiDB 集群升级到 v6.6.0 及之后的版本，之前创建的外键依然是不生效的，可以先删除不生效的外键后再创建外键使外键约束生效。只有在 v6.6.0 及之后版本中新创建的外键才生效。你可以使用 `SHOW CREATE TABLE` 语句查看外键是否生效，不生效的外键会有一条 `/* FOREIGN KEY INVALID */` 注释。 @@ -299,14 +299,14 @@ Create Table | CREATE TABLE `child` ( ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin ``` -### 与测试数据库工具的兼容性 +### 与 TiDB 工具的兼容性 - [DM](/dm/dm-overview.md) 不兼容外键功能。DM 在同步数据到下游 TiDB 时，会显式关闭下游 TiDB 的 [`foreign_key_checks`](/system-variables.md#foreign_key_checks)，所以由外键产生的级联操作不会从上游同步到下游，这会导致上下游数据不一致。 - [TiCDC](/ticdc/ticdc-overview.md) v6.6.0 兼容外键功能。旧版本的 TiCDC 在同步带外键的表时，可能会报错，建议使用 v6.6.0 之前版本 TiCDC 时先关闭下游 TiDB 集群的 `foreign_key_checks`。 - [BR](/br/backup-and-restore-overview.md) v6.6.0 兼容外键功能。之前版本的 BR 在恢复带外键的表到 v6.6.0 及之后版本的集群时，可能会报错，建议先关闭下游 TiDB 集群的 `foreign_key_checks` 后再恢复集群。 - [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 导入数据到 TiDB 前，如果目标表使用了外键，建议先关闭 TiDB 集群的 `foreign_key_checks`。对于 v6.6.0 之前的版本，关闭该系统变量也不会生效，你需要为下游数据库用户添加 `REFERENCES` 权限，或者提前手动在下游数据库中创建好目标表，以确保顺利导入数据。 - [Dumpling](/dumpling-overview.md) 兼容外键功能。 -- [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) 在对比上下游数据时，如果上下游数据库的版本不一样，且下游 TiDB 中存在[不生效的外键](测试数据库版本间兼容性)，则 sync-diff-inspector 可能会报上下游表结构不一致的错误。因为 TiDB v6.6.0 会对表结构中不生效的外键添加一条 `/* FOREIGN KEY INVALID */` 注释。 +- [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) 在对比上下游数据时，如果上下游数据库的版本不一样，且下游 TiDB 中存在[不生效的外键](#tidb-版本间兼容性)，则 sync-diff-inspector 可能会报上下游表结构不一致的错误。因为 TiDB v6.6.0 会对表结构中不生效的外键添加一条 `/* FOREIGN KEY INVALID */` 注释。 ### 与 MySQL 的兼容性 diff --git a/functions-and-operators/aggregate-group-by-functions.md b/functions-and-operators/aggregate-group-by-functions.md index adb4dd8e1a36..b8424cf2c785 100644 --- a/functions-and-operators/aggregate-group-by-functions.md +++ b/functions-and-operators/aggregate-group-by-functions.md @@ -7,7 +7,7 @@ summary: TiDB支持的聚合函数包括 COUNT、COUNT(DISTINCT)、SUM、AVG、M 本文将详细介绍 TiDB 支持的聚合函数。 -## 测试数据库支持的聚合函数 +## TiDB 支持的聚合函数 TiDB 支持的 MySQL `GROUP BY` 聚合函数如下所示： diff --git a/functions-and-operators/information-functions.md b/functions-and-operators/information-functions.md index 23742f57c6d4..c3bd28fd388a 100644 --- a/functions-and-operators/information-functions.md +++ b/functions-and-operators/information-functions.md @@ -7,7 +7,7 @@ summary: TiDB 支持 MySQL 8.0 中提供的大部分信息函数。 TiDB 支持使用 MySQL 8.0 中提供的大部分[信息函数](https://dev.mysql.com/doc/refman/8.0/en/information-functions.html)。 -## 测试数据库支持的 MySQL 信息函数 +## TiDB 支持的 MySQL 信息函数 | 函数名 | 功能描述 | | ------ | ---------------------------------------- | @@ -279,7 +279,7 @@ Store: tikv 如需更改该函数返回的版本，可以修改 [`server-version`](/tidb-configuration-file.md#server-version) 配置项。 -## 测试数据库特有的信息函数 +## TiDB 特有的信息函数 下列函数为 TiDB 中特有的信息函数，MySQL 中无对应的函数。 @@ -287,7 +287,7 @@ Store: tikv | ------ | ---------------------------------------- | | [`CURRENT_RESOURCE_GROUP()`](/functions-and-operators/tidb-functions.md#current_resource_group) | 返回当前连接的资源组名 | -## 测试数据库不支持的信息函数 +## TiDB 不支持的信息函数 * `CHARSET()` * `COERCIBILITY()` diff --git a/functions-and-operators/tidb-functions.md b/functions-and-operators/tidb-functions.md index a17a4aa75663..8ff820badc69 100644 --- a/functions-and-operators/tidb-functions.md +++ b/functions-and-operators/tidb-functions.md @@ -3,7 +3,7 @@ title: TiDB 特有的函数 summary: 学习使用 TiDB 特有的函数。 --- -# 测试数据库特有的函数 +# TiDB 特有的函数 以下函数为 TiDB 中特有的函数，与 MySQL 不兼容： diff --git a/get-started-with-tidb-lightning.md b/get-started-with-tidb-lightning.md index 9f020bb7af8b..3f74b6ae26bd 100644 --- a/get-started-with-tidb-lightning.md +++ b/get-started-with-tidb-lightning.md @@ -42,7 +42,7 @@ summary: TiDB Lightning 可快速将 MySQL 数据导入到 TiDB 集群中。首 导出的全量备份数据将保存在 `/data/my_database` 目录中。 -## 第 2 步：部署测试数据库集群 +## 第 2 步：部署 TiDB 集群 在开始导入数据之前，你需要先部署一个要进行导入的 TiDB 集群。如果你已经有 TiDB 集群，可以跳过这一步。 diff --git a/glossary.md b/glossary.md index 8dbf9e818162..593fee6d2950 100644 --- a/glossary.md +++ b/glossary.md @@ -21,7 +21,7 @@ ACID 是指数据库管理系统在写入或更新资料的过程中，为保证 * 原子性 (atomicity) 指一个事务中的所有操作，或者全部完成，或者全部不完成，不会结束在中间某个环节。TiDB 通过 Primary Key 所在 [Region](#regionpeerraft-group) 的原子性来保证分布式事务的原子性。 * 一致性 (consistency) 指在事务开始之前和结束以后，数据库的完整性没有被破坏。TiDB 在写入数据之前，会校验数据的一致性，校验通过才会写入内存并返回成功。 -* 隔离性 (isolation) 指数据库允许多个并发事务同时对其数据进行读写和修改的能力。隔离性可以防止多个事务并发执行时由于交叉执行而导致数据的不一致，主要用于处理并发场景。关于 TiDB 支持的隔离级别，请参考 [测试数据库事务隔离级别](/transaction-isolation-levels.md#测试数据库事务隔离级别)。 +* 隔离性 (isolation) 指数据库允许多个并发事务同时对其数据进行读写和修改的能力。隔离性可以防止多个事务并发执行时由于交叉执行而导致数据的不一致，主要用于处理并发场景。关于 TiDB 支持的隔离级别，请参考 [TiDB 事务隔离级别](/transaction-isolation-levels.md#tidb-事务隔离级别)。 * 持久性 (durability) 指事务处理结束后，对数据的修改就是永久的，即便系统故障也不会丢失。在 TiDB 中，事务一旦提交成功，数据全部持久化存储到 TiKV，此时即使 TiDB 服务器宕机也不会出现数据丢失。 ## B diff --git a/grafana-tidb-dashboard.md b/grafana-tidb-dashboard.md index c6bed930ff52..c8bc4b57f9ae 100644 --- a/grafana-tidb-dashboard.md +++ b/grafana-tidb-dashboard.md @@ -3,7 +3,7 @@ title: TiDB 监控指标 summary: 了解 Grafana Dashboard 中展示的关键指标。 --- -# 测试数据库重要监控指标详解 +# TiDB 重要监控指标详解 使用 TiUP 部署 TiDB 集群时，你可以一键部署监控系统 (Prometheus & Grafana)，参考监控架构 [TiDB 监控框架概述](/tidb-monitoring-framework.md)。 diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index 73f748ad44f8..46bc3a1884b9 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -3,7 +3,7 @@ title: TiDB 软件和硬件环境需求 summary: TiDB 是一款开源的一站式实时 HTAP 数据库，支持部署在多种硬件环境和操作系统上。软件和硬件环境建议配置包括操作系统要求、编译和运行依赖库、Docker 镜像依赖、软件配置要求、服务器建议配置、网络要求、磁盘空间要求、客户端 Web 浏览器要求以及 TiFlash 存算分离架构的软硬件要求。 --- -# 测试数据库软件和硬件环境需求 +# TiDB 软件和硬件环境需求 -# 测试数据库配置文件描述 +# TiDB 配置文件描述 TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/config.toml.example](https://github.com/pingcap/tidb/blob/release-8.5/pkg/config/config.toml.example) 找到默认值的配置文件，重命名为 `config.toml` 即可。本文档只介绍未包含在[命令行参数](/command-line-flags-for-tidb-configuration.md)中的参数。 diff --git a/tidb-distributed-execution-framework.md b/tidb-distributed-execution-framework.md index c132d6efed39..5f09d8105d02 100644 --- a/tidb-distributed-execution-framework.md +++ b/tidb-distributed-execution-framework.md @@ -3,7 +3,7 @@ title: TiDB 分布式执行框架 summary: 了解 TiDB 分布式执行框架的使用场景、限制、使用方法和实现原理。 --- -# 测试数据库分布式执行框架 +# TiDB 分布式执行框架 TiDB 采用计算存储分离架构，具有出色的扩展性和弹性的扩缩容能力。从 v7.1.0 开始，TiDB 引入了一个分布式执行框架，以进一步发挥分布式架构的资源优势。该框架的目标是对基于该框架的任务进行统一调度与分布式执行，并提供整体和单个任务两个维度的资源管理能力，更好地满足用户对于资源使用的预期。 diff --git a/tidb-global-sort.md b/tidb-global-sort.md index 66d29d4aa1a4..750f767b6973 100644 --- a/tidb-global-sort.md +++ b/tidb-global-sort.md @@ -3,7 +3,7 @@ title: TiDB 全局排序 summary: 了解 TiDB 全局排序功能的使用场景、限制、使用方法和实现原理。 --- -# 测试数据库全局排序 +# TiDB 全局排序 > **注意：** > diff --git a/tidb-in-kubernetes.md b/tidb-in-kubernetes.md index 85277f93d1fc..4de95ac839b8 100644 --- a/tidb-in-kubernetes.md +++ b/tidb-in-kubernetes.md @@ -3,7 +3,7 @@ title: 在 Kubernetes 上部署 TiDB 集群 summary: 你可以使用 TiDB Operator 在 Kubernetes 上部署 TiDB。TiDB Operator 是 Kubernetes 上的 TiDB 集群自动运维系统，提供部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或自托管的 Kubernetes 集群上。TiDB Operator 的文档目前独立于 TiDB 文档。要查看如何在 Kubernetes 上部署 TiDB 的详细步骤，请参阅对应版本的 TiDB Operator 文档。 --- -# 在 Kubernetes 上部署测试数据库集群 +# 在 Kubernetes 上部署 TiDB 集群 你可以使用 [TiDB Operator](https://github.com/pingcap/tidb-operator) 在 Kubernetes 上部署 TiDB 集群。TiDB Operator 是 Kubernetes 上的 TiDB 集群自动运维系统，提供包括部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或自托管的 Kubernetes 集群上。 diff --git a/tidb-lightning/tidb-lightning-glossary.md b/tidb-lightning/tidb-lightning-glossary.md index 7206e5df7c2c..e71868e3ec7e 100644 --- a/tidb-lightning/tidb-lightning-glossary.md +++ b/tidb-lightning/tidb-lightning-glossary.md @@ -119,7 +119,7 @@ TiDB Lightning 通过引擎将数据传送到 TiKV Importer 中。TiDB Lightning 导入模式。指通过降低读取速度和减少空间使用，来优化 TiKV 写入的配置模式。 -导入过程中，TiDB Lightning 自动在导入模式和[普通模式](#normal-mode)中来回切换。如果 TiKV 卡在导入模式，你可以使用 `tidb-lightning-ctl` [强制切换回普通模式](/tidb-lightning/troubleshoot-tidb-lightning.md#使用-tidb-lightning-后测试数据库集群变慢cpu-占用高)。 +导入过程中，TiDB Lightning 自动在导入模式和[普通模式](#normal-mode)中来回切换。如果 TiKV 卡在导入模式，你可以使用 `tidb-lightning-ctl` [强制切换回普通模式](/tidb-lightning/troubleshoot-tidb-lightning.md#使用-tidb-lightning-后tidb-集群变慢cpu-占用高)。 ### Index engine diff --git a/tidb-lightning/troubleshoot-tidb-lightning.md b/tidb-lightning/troubleshoot-tidb-lightning.md index f4d2e8c11429..ee9565901d3f 100644 --- a/tidb-lightning/troubleshoot-tidb-lightning.md +++ b/tidb-lightning/troubleshoot-tidb-lightning.md @@ -50,7 +50,7 @@ strict-format = true 另外，如果从 TiDB Lightning 的 log 的最后一条日志显示遇到的错误是 "Context canceled"，需要在日志中搜索第一条 "ERROR" 级别的日志。在这条日志之前，通常也会紧跟有一条 "got signal to exit"，表示 Lightning 是收到中断信号然后退出的。 -## 使用 TiDB Lightning 后，测试数据库集群变慢，CPU 占用高 +## 使用 TiDB Lightning 后，TiDB 集群变慢，CPU 占用高 如果 `tidb-lightning` 异常退出，集群可能仍处于“导入模式” (import mode)，该模式不适用于生产环境。此时可执行以下命令查看当前使用的模式： diff --git a/tidb-monitoring-api.md b/tidb-monitoring-api.md index 7a1dbedba354..2d71118359e1 100644 --- a/tidb-monitoring-api.md +++ b/tidb-monitoring-api.md @@ -3,7 +3,7 @@ title: TiDB 集群监控 API summary: TiDB 提供状态接口和 Metrics 接口来监控集群状态。状态接口可获取 TiDB Server 的运行状态和存储信息，PD 的状态接口可查看整个 TiKV 集群的详细信息。Metrics 接口用于监控整个集群的状态和性能。部署 Prometheus 和 Grafana 后，配置 Grafana 即可使用 Metrics 接口。 --- -# 测试数据库集群监控 API +# TiDB 集群监控 API TiDB 提供了以下几种接口来监控集群状态： diff --git a/tidb-monitoring-framework.md b/tidb-monitoring-framework.md index 03e6349bb9e1..31c6bf7ef82d 100644 --- a/tidb-monitoring-framework.md +++ b/tidb-monitoring-framework.md @@ -3,11 +3,11 @@ title: TiDB 监控框架概述 summary: TiDB 使用 Prometheus 作为监控和性能指标存储，Grafana 用于可视化展示。Prometheus 提供多个组件，包括 Prometheus Server、Client 代码库和 Alertmanager。Grafana 展示 TiDB 集群各组件的相关监控，分组包括备份恢复、Binlog、网络探活、磁盘性能、Kafka、TiDB Lightning 等。每个分组包含多个监控项页签，以及详细的监控指标看板。观看培训视频可快速了解监控与报警系统的体系、数据流转方式、系统管理方法和常用监控指标。 --- -# 测试数据库监控框架概述 +# TiDB 监控框架概述 TiDB 使用开源时序数据库 [Prometheus](https://prometheus.io) 作为监控和性能指标信息存储方案，使用 [Grafana](https://grafana.com/grafana) 作为可视化组件进行展示。 -## Prometheus 在测试数据库中的应用 +## Prometheus 在 TiDB 中的应用 Prometheus 是一个拥有多维度数据模型的、灵活的查询语句的时序数据库。Prometheus 作为热门的开源项目，拥有活跃的社区及众多的成功案例。 @@ -21,7 +21,7 @@ Prometheus 提供了多个组件供用户使用。目前，TiDB 使用了以下 ![Prometheus in TiDB](/media/prometheus-in-tidb.png) -## Grafana 在测试数据库中的应用 +## Grafana 在 TiDB 中的应用 Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana 来展示 TiDB 集群各组件的相关监控，监控项分组如下图所示： @@ -51,6 +51,6 @@ Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana ![Grafana Overview](/media/grafana_monitor_overview.png) -要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#测试数据库报警规则)，请以文档内容为准。 +要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#tidb-报警规则)，请以文档内容为准。 diff --git a/tidb-scheduling.md b/tidb-scheduling.md index 24a4358b3b77..b88a408d3d8d 100644 --- a/tidb-scheduling.md +++ b/tidb-scheduling.md @@ -3,7 +3,7 @@ title: TiDB 数据库的调度 summary: TiDB 数据库的调度由 PD（Placement Driver）模块负责管理和实时调度集群数据。PD 需要收集节点和 Region 的状态信息，并根据调度策略制定调度计划，包括增加 / 删除副本、迁移 Leader 角色等基本操作。调度需满足副本数量、位置分布、负载均衡、存储空间利用等需求。PD 通过心跳包收集信息，并根据策略生成调度操作序列，但具体执行由 Region Leader 决定。 --- -# 测试数据库数据库的调度 +# TiDB 数据库的调度 [PD](https://github.com/tikv/pd) (Placement Driver) 是 TiDB 集群的管理模块，同时也负责集群数据的实时调度。本文档介绍一下 PD 的设计思想和关键概念。 diff --git a/tidb-storage.md b/tidb-storage.md index 6d5499666cc5..29a06f473cdf 100644 --- a/tidb-storage.md +++ b/tidb-storage.md @@ -3,7 +3,7 @@ title: TiDB 数据库的存储 summary: 了解 TiDB 数据库的存储层。 --- -# 测试数据库数据库的存储 +# TiDB 数据库的存储 本文主要介绍 [TiKV](https://github.com/tikv/tikv) 的一些设计思想和关键概念。 diff --git a/tidb-troubleshooting-map.md b/tidb-troubleshooting-map.md index a5314bb2a74a..36f11525971e 100644 --- a/tidb-troubleshooting-map.md +++ b/tidb-troubleshooting-map.md @@ -3,7 +3,7 @@ title: TiDB 集群问题导图 summary: 了解如何处理 TiDB 集群常见问题。 --- -# 测试数据库集群问题导图 +# TiDB 集群问题导图 本篇文档总结了使用 TiDB 及其组件时的常见错误。遇到相关错误时，可以通过本文档的问题导图来排查错误原因并进行处理。 @@ -50,7 +50,7 @@ summary: 了解如何处理 TiDB 集群常见问题。 - 2.2.5 其他原因，请参考[读写延迟增加](/troubleshoot-cpu-issues.md)。 -## 3. 测试数据库问题 +## 3. TiDB 问题 ### 3.1 DDL @@ -179,7 +179,7 @@ TiDB 作为分布式数据库，内建负载均衡机制，尽可能将业务负 TiDB 提供了完整的方案用于排查、解决或规避这类热点。通过均衡负载热点，可以提升整体性能，包括提高 QPS 和降低延迟等。详情参见 [TiDB 热点问题处理](/troubleshoot-hot-spot-issues.md)。 -### 3.7 测试数据库磁盘 I/O 过高 +### 3.7 TiDB 磁盘 I/O 过高 当出现系统响应变慢的时候，如果已经排查了 CPU 的瓶颈、数据事务冲突的瓶颈后，问题仍存在，就需要从 I/O 来入手来辅助判断目前的系统瓶颈点。参考 [TiDB 磁盘 I/O 过高的处理办法](/troubleshoot-high-disk-io.md)了解如何定位和处理 TiDB 存储 I/O 过高的问题。 diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index a54612209a2d..eee253950c5a 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -338,7 +338,7 @@ delta_index_cache_size = 0 TiFlash 支持单节点多盘部署。如果你的部署节点上有多块硬盘，可以通过以下的方式配置参数，提高节点的硬盘 I/O 利用率。TiUP 中参数配置格式参照[详细 TiFlash 配置模版](/tiflash-deployment-topology.md#拓扑模版)。 -#### 测试数据库集群版本低于 v4.0.9 +#### TiDB 集群版本低于 v4.0.9 TiDB v4.0.9 之前的版本中，TiFlash 只支持将存储引擎中的主要数据分布在多盘上。通过 `path`（TiUP 中为 `data_dir`）和 `path_realtime_mode` 这两个参数配置多盘部署。 @@ -348,9 +348,9 @@ TiDB v4.0.9 之前的版本中，TiFlash 只支持将存储引擎中的主要数 如果节点上有多块规格不一致的硬盘，推荐把 `path_relatime_mode` 参数设置为 `true`，并且把性能最好的硬盘目录放在 `path` 参数内的最前面。这表示第一个目录只会存放最新数据，较旧的数据会在其他目录之间进行均衡。注意此情况下，第一个目录规划的容量大小需要占总容量的约 10%。 -#### 测试数据库集群版本为 v4.0.9 及以上 +#### TiDB 集群版本为 v4.0.9 及以上 -TiDB v4.0.9 及之后的版本中，TiFlash 支持将存储引擎的主要数据和新数据都分布在多盘上。多盘部署时，推荐使用 `[storage]` 中的参数，以更好地利用节点的 I/O 性能。但 TiFlash 仍然支持 [测试数据库集群版本低于 v4.0.9](测试数据库集群版本低于-v409) 中的参数。 +TiDB v4.0.9 及之后的版本中，TiFlash 支持将存储引擎的主要数据和新数据都分布在多盘上。多盘部署时，推荐使用 `[storage]` 中的参数，以更好地利用节点的 I/O 性能。但 TiFlash 仍然支持 [TiDB 集群版本低于 v4.0.9](#tidb-集群版本低于-v409) 中的参数。 如果节点上有多块相同规格的硬盘，推荐把硬盘目录填到 `storage.main.dir` 列表中，`storage.latest.dir` 列表留空。TiFlash 会在所有存储目录之间分摊 I/O 压力以及进行数据均衡。 diff --git a/tiflash/tune-tiflash-performance.md b/tiflash/tune-tiflash-performance.md index 5bf6238a8761..f9f4433c62c5 100644 --- a/tiflash/tune-tiflash-performance.md +++ b/tiflash/tune-tiflash-performance.md @@ -11,7 +11,7 @@ summary: 介绍 TiFlash 性能调优的方法，包括机器资源规划和 TiDB 对于希望节省机器资源，并且完全没有隔离要求的场景，可以使用 TiKV 和 TiFlash 联合部署。建议为 TiKV 与 TiFlash 分别留够资源，同时避免共享磁盘。 -## 测试数据库相关参数调优 +## TiDB 相关参数调优 本部分介绍如何通过调整 TiDB 相关参数来提升 TiFlash 性能，具体包括如下几个方面： diff --git a/tiflash/use-tidb-to-read-tiflash.md b/tiflash/use-tidb-to-read-tiflash.md index 7f6f9f22e780..65ab251169a9 100644 --- a/tiflash/use-tidb-to-read-tiflash.md +++ b/tiflash/use-tidb-to-read-tiflash.md @@ -3,7 +3,7 @@ title: 使用 TiDB 读取 TiFlash summary: 了解如何使用 TiDB 读取 TiFlash 副本。 --- -# 使用测试数据库读取 TiFlash +# 使用 TiDB 读取 TiFlash 本文档介绍如何使用 TiDB 读取 TiFlash 副本。 diff --git a/time-to-live.md b/time-to-live.md index 5bed0035b6b9..7cb14c226c59 100644 --- a/time-to-live.md +++ b/time-to-live.md @@ -218,7 +218,7 @@ TiDB 会定时采集 TTL 的运行时信息，并在 Grafana 中提供了相关 其中列 `table_id` 为分区表 ID，而 `parent_table_id` 为表的 ID，与 `information_schema.tables` 表中的 ID 对应。`table_schema`、`table_name`、`partition_name` 分别对应表示数据库、表名、分区名。`create_time`、`finish_time`、`ttl_expire` 分别表示 TTL 任务的创建时间、结束时间和过期时间。`expired_rows` 与 `deleted_rows` 表示过期行数与成功删除的行数。 -## 测试数据库数据迁移工具兼容性 +## TiDB 数据迁移工具兼容性 TTL 功能能够与 TiDB 的迁移、备份、恢复工具一同使用。 @@ -228,7 +228,7 @@ TTL 功能能够与 TiDB 的迁移、备份、恢复工具一同使用。 | TiDB Lightning | v6.6.0 | 导入后如果表中有 TTL 属性，会自动将表的 `TTL_ENABLE` 属性设置为 `OFF`，关闭 TTL。这样可以防止 TiDB 在导入后立即删除过期的数据。此时你需要手动重新配置 `TTL_ENABLE` 属性来重新开启各个表的 TTL。 | | TiCDC | v7.0.0 | 上游的 TTL 删除将会同步至下游。因此，为了防止重复删除，下游表的 `TTL_ENABLE` 属性将被强制设置为 `OFF`。 | -## 与测试数据库其他特性的兼容性 +## 与 TiDB 其他特性的兼容性 | 特性名称 | 说明 | | :-- | :---- | diff --git a/tiproxy/tiproxy-load-balance.md b/tiproxy/tiproxy-load-balance.md index fbe50481fca0..37350cdb215f 100644 --- a/tiproxy/tiproxy-load-balance.md +++ b/tiproxy/tiproxy-load-balance.md @@ -129,7 +129,7 @@ TiProxy 根据自身与 TiDB server 的地理位置，将连接优先路由到 TiProxy 根据自身和 TiDB server 的 `zone` 标签确定各自的地理位置。你需要同时设置以下配置项： -- 在 TiDB server 的 [`labels`](/tidb-configuration-file.md#labels) 配置项中将 `zone` 设置为当前可用区。配置方式请参阅[设置测试数据库的 `labels`](/schedule-replicas-by-topology-labels.md#设置测试数据库的-labels可选)。 +- 在 TiDB server 的 [`labels`](/tidb-configuration-file.md#labels) 配置项中将 `zone` 设置为当前可用区。配置方式请参阅[设置 TiDB 的 `labels`](/schedule-replicas-by-topology-labels.md#设置-tidb-的-labels可选)。 - 在 TiProxy 的 [`labels`](/tiproxy/tiproxy-configuration.md#labels) 配置项中将 `zone` 设置为当前可用区。 如果是使用 TiDB Operator 部署的集群，请参考[数据的高可用](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/configure-a-tidb-cluster#数据的高可用)进行配置。 diff --git a/tiproxy/tiproxy-overview.md b/tiproxy/tiproxy-overview.md index 9a4e9e28c368..183b7989b720 100644 --- a/tiproxy/tiproxy-overview.md +++ b/tiproxy/tiproxy-overview.md @@ -140,7 +140,7 @@ TiProxy 不适用于以下场景： tiup cluster upgrade --tiproxy-version ``` -### 重启测试数据库集群 +### 重启 TiDB 集群 使用 [`tiup cluster restart`](/tiup/tiup-component-cluster-restart.md) 重启 TiDB 集群时，TiDB server 不是滚动重启，会导致连接断开，请尽量避免使用。 diff --git a/tiup/tiup-cluster-topology-reference.md b/tiup/tiup-cluster-topology-reference.md index 8ac4474283cc..37685e12f08f 100644 --- a/tiup/tiup-cluster-topology-reference.md +++ b/tiup/tiup-cluster-topology-reference.md @@ -3,7 +3,7 @@ title: 通过 TiUP 部署 TiDB 集群的拓扑文件配置 summary: 介绍通过 TiUP 部署或扩容 TiDB 集群时提供的拓扑文件配置和示例。 --- -# 通过 TiUP 部署测试数据库集群的拓扑文件配置 +# 通过 TiUP 部署 TiDB 集群的拓扑文件配置 通过 TiUP 部署或扩容 TiDB 集群时，需要提供一份拓扑文件（[示例](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)）来描述集群拓扑。 diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index 725b2f02af37..abd55090ce3a 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -3,7 +3,7 @@ title: 使用 TiUP 部署运维 TiDB 线上集群 summary: 使用 TiUP 的 cluster 组件可以快速部署生产集群，并提供强大的生产集群管理功能，包括升级、缩容、扩容、操作、审计等。部署集群的命令为 tiup cluster deploy，部署完成后可以通过 tiup cluster list 查看集群列表。启动集群的命令为 tiup cluster start，查看集群状态的命令为 tiup cluster display。可以使用 tiup cluster scale-in 进行集群缩容，tiup cluster scale-out 进行集群扩容。另外，还可以使用 tiup cluster upgrade 进行滚动升级，使用 tiup cluster edit-config 进行配置更新。最后，可以使用 tiup cluster exec 在集群节点机器上执行命令。 --- -# 使用 TiUP 部署运维测试数据库线上集群 +# 使用 TiUP 部署运维 TiDB 线上集群 本文重在介绍如何使用 TiUP 的 cluster 组件，如果需要线上部署的完整步骤，可参考[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。 diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 4de65a1d8798..3b3087babc7b 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -3,7 +3,7 @@ title: 本地快速部署 TiDB 集群 summary: TiDB 集群是分布式系统，由多个组件构成。想要快速体验 TiDB，可以使用 TiUP 中的 playground 组件快速搭建本地测试环境。通过命令行参数可以设置各组件的数量和配置，也可以启动多个组件实例。使用 `tiup client` 可以快速连接到本地启动的 TiDB 集群。还可以查看已启动集群的信息，扩容或缩容集群。 --- -# 本地快速部署测试数据库集群 +# 本地快速部署 TiDB 集群 TiDB 集群是由多个组件构成的分布式系统，一个典型的 TiDB 集群至少由 3 个 PD 节点、3 个 TiKV 节点和 2 个 TiDB 节点构成。对于想要快速体验 TiDB 的用户来说，手工部署这么多组件是非常耗时且麻烦的事情。本文介绍 TiUP 中的 playground 组件，以及如何通过 playground 组件快速搭建一套本地的 TiDB 测试环境。 @@ -31,7 +31,7 @@ tiup playground --help ## 使用示例 -### 查看可用的测试数据库版本 +### 查看可用的 TiDB 版本 {{< copyable "shell-regular" >}} @@ -39,7 +39,7 @@ tiup playground --help tiup list tidb ``` -### 启动一个指定版本的测试数据库集群 +### 启动一个指定版本的 TiDB 集群 {{< copyable "shell-regular" >}} @@ -49,7 +49,7 @@ tiup playground ${version} 将 `${version}` 替换为所需的版本号。 -### 启动一个每日构建版的测试数据库集群 +### 启动一个每日构建版的 TiDB 集群 {{< copyable "shell-regular" >}} @@ -99,7 +99,7 @@ tiup playground --tag ${tag_name} 以这种方式启动的集群，在集群关闭以后，数据文件会保留。下一次可以继续使用该 tag 启动集群，从而使用从上一次集群关闭时的数据。 -## 快速连接到由 playground 启动的测试数据库集群 +## 快速连接到由 playground 启动的 TiDB 集群 TiUP 提供了 `client` 组件，用于自动寻找并连接 playground 在本地启动的 TiDB 集群，使用方式为： diff --git a/transaction-isolation-levels.md b/transaction-isolation-levels.md index 0f26a8a11613..9de6d8209605 100644 --- a/transaction-isolation-levels.md +++ b/transaction-isolation-levels.md @@ -3,7 +3,7 @@ title: TiDB 事务隔离级别 summary: 了解 TiDB 事务的隔离级别。 --- -# 测试数据库事务隔离级别 +# TiDB 事务隔离级别 事务隔离级别是数据库事务处理的基础，[ACID](/glossary.md#acid) 中的 “I”，即 Isolation，指的就是事务的隔离性。 diff --git a/transaction-overview.md b/transaction-overview.md index 1887922312da..e83722f6548f 100644 --- a/transaction-overview.md +++ b/transaction-overview.md @@ -3,7 +3,7 @@ title: TiDB 事务概览 summary: 了解 TiDB 中的事务。 --- -# 测试数据库事务概览 +# TiDB 事务概览 TiDB 支持分布式事务，提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。TiDB 3.0.8 及以后版本，TiDB 默认采用悲观事务模式。 diff --git a/troubleshoot-cpu-issues.md b/troubleshoot-cpu-issues.md index 06ea1e39169d..78ef2460868e 100644 --- a/troubleshoot-cpu-issues.md +++ b/troubleshoot-cpu-issues.md @@ -9,7 +9,7 @@ summary: 介绍读写延时增加、抖动时的排查思路，可能的原因 ## 常见原因 -### 测试数据库执行计划不对导致延迟增高 +### TiDB 执行计划不对导致延迟增高 查询语句的执行计划不稳定，偶尔执行计划选择错误的索引，导致查询延迟增加。 diff --git a/troubleshoot-high-disk-io.md b/troubleshoot-high-disk-io.md index 899878db7cb7..2c60d916ca4d 100644 --- a/troubleshoot-high-disk-io.md +++ b/troubleshoot-high-disk-io.md @@ -3,7 +3,7 @@ title: TiDB 磁盘 I/O 过高的处理办法 summary: 了解如何定位和处理 TiDB 存储 I/O 过高的问题。 --- -# 测试数据库磁盘 I/O 过高的处理办法 +# TiDB 磁盘 I/O 过高的处理办法 本文主要介绍如何定位和处理 TiDB 存储 I/O 过高的问题。 diff --git a/troubleshoot-hot-spot-issues.md b/troubleshoot-hot-spot-issues.md index a6112d64b0a1..0ba60941ad97 100644 --- a/troubleshoot-hot-spot-issues.md +++ b/troubleshoot-hot-spot-issues.md @@ -3,7 +3,7 @@ title: TiDB 热点问题处理 summary: TiDB 热点问题处理：介绍定位和解决读写热点问题，包括常见热点场景、确定存在热点问题的方法、使用 TiDB Dashboard 定位热点表、使用 SHARD_ROW_ID_BITS 处理热点表、使用 AUTO_RANDOM 处理自增主键热点表、小表热点的优化、打散读热点。 --- -# 测试数据库热点问题处理 +# TiDB 热点问题处理 本文介绍如何定位和解决读写热点问题。 @@ -13,7 +13,7 @@ TiDB 提供了完整的方案用于排查、解决或规避这类热点。通过 ## 常见热点场景 -### 测试数据库编码规则回顾 +### TiDB 编码规则回顾 TiDB 对每个表分配一个 TableID，每一个索引都会分配一个 IndexID，每一行分配一个 RowID（默认情况下，如果表使用整数型的 Primary Key，那么会用 Primary Key 的值当做 RowID）。其中 TableID 在整个集群内唯一，IndexID/RowID 在表内唯一，这些 ID 都是 int64 类型。 diff --git a/troubleshoot-lock-conflicts.md b/troubleshoot-lock-conflicts.md index fe0989bf960b..a21f79f6fccd 100644 --- a/troubleshoot-lock-conflicts.md +++ b/troubleshoot-lock-conflicts.md @@ -3,7 +3,7 @@ title: TiDB 锁冲突问题处理 summary: 了解 TiDB 锁冲突问题以及处理方式。 --- -# 测试数据库锁冲突问题处理 +# TiDB 锁冲突问题处理 TiDB 支持完整的分布式事务，自 v3.0 版本起，提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。本文介绍如何使用 Lock View 排查锁相关的问题，以及如何处理使用乐观事务或者悲观事务的过程中常见的锁冲突问题。 diff --git a/troubleshoot-tidb-cluster.md b/troubleshoot-tidb-cluster.md index fe3b783ac751..af0b255677f3 100644 --- a/troubleshoot-tidb-cluster.md +++ b/troubleshoot-tidb-cluster.md @@ -3,7 +3,7 @@ title: TiDB 集群故障诊断 summary: TiDB 集群故障诊断包括收集出错信息、组件状态、日志信息、机器配置和 dmesg 中的问题。解决数据库连接问题需要确认服务是否启动，查看 tidb-server 日志并清空数据重新部署服务。解决 tidb-server 启动报错需检查参数、端口占用和 pd-server 连接。解决 tikv-server 启动报错需检查参数、端口占用和 pd-server 连接。解决 pd-server 启动报错需检查参数和端口占用。进程异常退出需检查是否在前台启动，使用 nohup+& 方式运行或写在脚本中。TiKV 进程异常重启需检查 OOM 信息和 panic log。连接被拒绝需确保网络参数正确。解决文件打开过多问题需确保 ulimit -n 足够大。数据库访问超时需检查拓扑结构、硬件配置、其他服务、操作、CPU 线程、网络 /IO 监控数据。 --- -# 测试数据库集群故障诊断 +# TiDB 集群故障诊断 当试用 TiDB 遇到问题时，请先参考本篇文档。如果问题未解决，请收集以下信息并通过 [TiDB 支持资源](/support.md)解决： diff --git a/tso.md b/tso.md index f942c15410fa..a36d0c77a673 100644 --- a/tso.md +++ b/tso.md @@ -3,7 +3,7 @@ title: TiDB 中的 TimeStamp Oracle (TSO) summary: 了解 TiDB 中的 TimeStamp Oracle (TSO)。 --- -# 测试数据库中的 TimeStamp Oracle (TSO) +# TiDB 中的 TimeStamp Oracle (TSO) 在 TiDB 中，Placement Driver (PD) 承担着 TSO 时间戳分配器的角色，负责为集群内各组件分配时间戳。这些时间戳用于为事务和数据分配时间标记。该分配机制对于在 TiDB 中启用 [Percolator](https://research.google.com/pubs/pub36726.html) 模型至关重要。Percolator 模型用于支持多版本并发控制（Multi-Version Concurrency Control, MVCC）和[事务管理](/transaction-overview.md)。 diff --git a/upgrade-monitoring-services.md b/upgrade-monitoring-services.md index 59b2a63c7133..63ee4a2e8203 100644 --- a/upgrade-monitoring-services.md +++ b/upgrade-monitoring-services.md @@ -3,7 +3,7 @@ title: 升级集群监控组件 summary: 介绍如何升级 TiDB 集群监控组件 Prometheus、Grafana 和 Alertmanager。 --- -# 升级测试数据库集群监控组件 +# 升级 TiDB 集群监控组件 使用 TiUP 部署 TiDB 集群时，TiUP 会同时自动部署 Prometheus、Grafana 和 Alertmanager 等监控组件，并且在集群扩容中自动为新增节点添加监控配置。通过 TiUP 自动部署的监控组件并不是这些三方组件的最新版本，如果你需要使用最新的三方组件，可以按照本文的方法升级所需的监控组件。 @@ -26,7 +26,7 @@ summary: 介绍如何升级 TiDB 集群监控组件 Prometheus、Grafana 和 Ale 从 [Prometheus 官网下载页面](https://prometheus.io/download/)下载组件安装包，并解压。 -### 第 2 步：下载测试数据库官方 Prometheus 安装包 +### 第 2 步：下载 TiDB 官方 Prometheus 安装包 1. 在 [TiDB 官网下载页面](https://cn.pingcap.com/product/#SelectProduct)下载 `TiDB-community-server` 软件包，并解压。 2. 在解压文件中，找到 `prometheus-v{version}-linux-amd64.tar.gz`，并解压。 @@ -66,7 +66,7 @@ tiup cluster patch prometheus-v{new-version}.tar.gz -R prometheus 1. 从 [Grafana 官网下载页面](https://grafana.com/grafana/download?pg=get&plcmt=selfmanaged-box1-cta1)下载组件安装包。你可以根据需要选择下载 `OSS` 版或 `Enterprise` 版。 2. 解压下载的软件包。 -### 第 2 步：下载测试数据库官方 Grafana 安装包 +### 第 2 步：下载 TiDB 官方 Grafana 安装包 1. 在 [TiDB 官网下载页面](https://cn.pingcap.com/product/#SelectProduct)下载 `TiDB-community-server` 软件包，并解压。 2. 在解压文件中，找到 `grafana-v{version}-linux-amd64.tar.gz`，并解压。 diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index 5165868d5cb1..65da650608f5 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -173,7 +173,7 @@ tiup cluster check --cluster 执行结束后，最后会输出 region status 检查结果。如果结果为 "All regions are healthy"，则说明当前集群中所有 region 均为健康状态，可以继续执行升级；如果结果为 "Regions are not fully healthy: m miss-peer, n pending-peer" 并提示 "Please fix unhealthy regions before other operations."，则说明当前集群中有 region 处在异常状态，应先排除相应异常状态，并再次检查结果为 "All regions are healthy" 后再继续升级。 -## 3. 升级测试数据库集群 +## 3. 升级 TiDB 集群 本部分介绍如何滚动升级 TiDB 集群以及如何进行升级后的验证。 @@ -297,7 +297,7 @@ Cluster version: v8.5.0 ### 4.2 升级到 v6.2.0 及以上版本时，如何解决升级卡住的问题 -从 v6.2.0 开始，TiDB 默认开启[并发 DDL 框架](/ddl-introduction.md#测试数据库在线-ddl-异步变更的原理)执行并发 DDL。该框架改变了 DDL 作业存储方式，由 KV 队列变为表队列。这一变化可能会导致部分升级场景卡住。下面是一些会触发该问题的场景及解决方案： +从 v6.2.0 开始，TiDB 默认开启[并发 DDL 框架](/ddl-introduction.md#tidb-在线-ddl-异步变更的原理)执行并发 DDL。该框架改变了 DDL 作业存储方式，由 KV 队列变为表队列。这一变化可能会导致部分升级场景卡住。下面是一些会触发该问题的场景及解决方案： - 加载插件导致的卡住 diff --git a/user-account-management.md b/user-account-management.md index 93f99123b57a..921e1ea978f7 100644 --- a/user-account-management.md +++ b/user-account-management.md @@ -3,7 +3,7 @@ title: TiDB 用户账户管理 summary: TiDB 用户账户管理主要包括用户名和密码设置、添加用户、删除用户、保留用户账户、设置资源限制、设置密码、忘记密码处理和刷新权限。用户可以通过 SQL 语句或图形化界面工具进行用户管理，同时可以使用 `FLUSH PRIVILEGES` 命令立即生效修改。 TiDB 在数据库初始化时会生成一个默认账户。 --- -# 测试数据库用户账户管理 +# TiDB 用户账户管理 本文档主要介绍如何管理 TiDB 用户账户。 diff --git a/vector-search-get-started-using-python.md b/vector-search-get-started-using-python.md index ffa79c854fc5..a29a0f2c8c02 100644 --- a/vector-search-get-started-using-python.md +++ b/vector-search-get-started-using-python.md @@ -51,7 +51,7 @@ pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv - `tidb-vector`：用于与 TiDB 向量搜索交互的 Python 客户端。 - [`sentence-transformers`](https://sbert.net)：提供预训练模型的 Python 库，用于从文本生成[向量嵌入](/vector-search-overview.md#向量嵌入)。 -### 第 3 步：配置测试数据库集群的连接字符串 +### 第 3 步：配置 TiDB 集群的连接字符串 根据不同的 TiDB 集群部署方式，配置集群的连接字符串。 @@ -134,7 +134,7 @@ def text_to_embedding(text): return embedding.tolist() ``` -### 第 5 步：连接到测试数据库集群 +### 第 5 步：连接到 TiDB 集群 使用 `TiDBVectorClient` 类连接到 TiDB 集群，并创建一个包含向量列的表 `embedded_documents`。 diff --git a/vector-search-get-started-using-sql.md b/vector-search-get-started-using-sql.md index 68355914ed47..d79a5d7e32ad 100644 --- a/vector-search-get-started-using-sql.md +++ b/vector-search-get-started-using-sql.md @@ -32,7 +32,7 @@ TiDB 扩展了 MySQL 语法以支持[向量搜索](/vector-search-overview.md) ## 快速开始 -### 第 1 步：连接到测试数据库集群 +### 第 1 步：连接到 TiDB 集群 根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB 集群。 diff --git a/vector-search-integrate-with-django-orm.md b/vector-search-integrate-with-django-orm.md index a36847aed01e..6f6d262a43f9 100644 --- a/vector-search-integrate-with-django-orm.md +++ b/vector-search-integrate-with-django-orm.md @@ -3,7 +3,7 @@ title: 在 Django ORM 中使用 TiDB 向量搜索 summary: 了解如何在 Django ORM 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 Django ORM 中使用测试数据库向量搜索 +# 在 Django ORM 中使用 TiDB 向量搜索 本文档将展示如何使用 [Django](https://www.djangoproject.com/) ORM 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -175,7 +175,7 @@ python manage.py runserver 你可以参考以下示例代码片段来完成自己的应用程序开发。 -### 连接到测试数据库集群 +### 连接到 TiDB 集群 打开 `sample_project/settings.py` 文件，添加以下配置： diff --git a/vector-search-integrate-with-jinaai-embedding.md b/vector-search-integrate-with-jinaai-embedding.md index 9c16103f0058..ddc26e79bcf7 100644 --- a/vector-search-integrate-with-jinaai-embedding.md +++ b/vector-search-integrate-with-jinaai-embedding.md @@ -3,7 +3,7 @@ title: 结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索 summary: 了解如何结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索，以存储向量嵌入信息并执行语义搜索。 --- -# 结合 Jina AI 嵌入模型 API 使用测试数据库向量搜索 +# 结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索 本文档将展示如何使用 [Jina AI](https://jina.ai/) 为文本数据生成向量嵌入，然后将向量嵌入存储在 TiDB 中，并根据向量嵌入搜索相似文本。 @@ -174,7 +174,7 @@ def generate_embeddings(text: str): return response.json()['data'][0]['embedding'] ``` -### 连接到测试数据库集群 +### 连接到 TiDB 集群 通过 SQLAlchemy 连接 TiDB 集群： @@ -249,7 +249,7 @@ with Session(engine) as session: session.commit() ``` -### 使用 Jina AI 生成的向量嵌入在测试数据库中执行语义搜索 +### 使用 Jina AI 生成的向量嵌入在 TiDB 中执行语义搜索 通过 Jina AI 的嵌入 API 生成查询文本的向量嵌入，然后根据**查询文本的向量嵌入**和**向量表中各个向量嵌入**之间的余弦距离搜索最相关的 `document`： diff --git a/vector-search-integrate-with-langchain.md b/vector-search-integrate-with-langchain.md index 18661dc07de6..b91a7591935d 100644 --- a/vector-search-integrate-with-langchain.md +++ b/vector-search-integrate-with-langchain.md @@ -3,7 +3,7 @@ title: 在 LangChain 中使用 TiDB 向量搜索 summary: 展示如何在 LangChain 中使用 TiDB 向量搜索 --- -# 在 LangChain 中使用测试数据库向量搜索 +# 在 LangChain 中使用 TiDB 向量搜索 本文档将展示如何在 [LangChain](https://python.langchain.com/) 中使用 [TiDB 向量搜索](/vector-search-overview.md)。 diff --git a/vector-search-integrate-with-llamaindex.md b/vector-search-integrate-with-llamaindex.md index 539ee9be87e5..d3408d396d4e 100644 --- a/vector-search-integrate-with-llamaindex.md +++ b/vector-search-integrate-with-llamaindex.md @@ -3,7 +3,7 @@ title: 在 LlamaIndex 中使用 TiDB 向量搜索 summary: 了解如何在 LlamaIndex 中使用 TiDB 向量搜索。 --- -# 在 LlamaIndex 中使用测试数据库向量搜索 +# 在 LlamaIndex 中使用 TiDB 向量搜索 本文档将展示如何在 [LlamaIndex](https://www.llamaindex.ai) 中使用 [TiDB 向量搜索](/vector-search-overview.md)。 @@ -168,7 +168,7 @@ for index, document in enumerate(documents): ### 第 5 步：生成并存储文档向量 -#### 5.1 初始化测试数据库向量存储 +#### 5.1 初始化 TiDB 向量存储 以下代码将在 TiDB 中创建一个 `paul_graham_test` 表，该表针对向量搜索进行了优化。 diff --git a/vector-search-integrate-with-peewee.md b/vector-search-integrate-with-peewee.md index 189f4849fdaa..064d951dd222 100644 --- a/vector-search-integrate-with-peewee.md +++ b/vector-search-integrate-with-peewee.md @@ -3,7 +3,7 @@ title: 在 peewee 中使用 TiDB 向量搜索 summary: 了解如何在 peewee 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 peewee 中使用测试数据库向量搜索 +# 在 peewee 中使用 TiDB 向量搜索 本文档将展示如何使用 [peewee](https://docs.peewee-orm.com/) 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -168,7 +168,7 @@ Get documents within a certain distance: ### 创建向量表 -#### 连接到测试数据库集群 +#### 连接到 TiDB 集群 ```python import os diff --git a/vector-search-integrate-with-sqlalchemy.md b/vector-search-integrate-with-sqlalchemy.md index 218c6ebf8e82..6f25678c9c98 100644 --- a/vector-search-integrate-with-sqlalchemy.md +++ b/vector-search-integrate-with-sqlalchemy.md @@ -3,7 +3,7 @@ title: 在 SQLAlchemy 中使用 TiDB 向量搜索 summary: 了解如何在 SQLAlchemy 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 SQLAlchemy 中使用测试数据库向量搜索 +# 在 SQLAlchemy 中使用 TiDB 向量搜索 本文档将展示如何使用 [SQLAlchemy](https://www.sqlalchemy.org/) 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -152,7 +152,7 @@ Get documents within a certain distance: ### 创建向量表 -#### 连接到测试数据库集群 +#### 连接到 TiDB 集群 ```python import os From f2c41c9a39466c1408a2e652f9af59e782ef69e5 Mon Sep 17 00:00:00 2001 From: qiancai Date: Wed, 25 Dec 2024 17:08:47 +0800 Subject: [PATCH 3/3] test --- .vaunt/add-tidb-docs-dash-badge.md | 2 +- CONTRIBUTING.md | 4 +- README.md | 4 +- accelerated-table-creation.md | 4 +- alert-rules.md | 4 +- analyze-slow-queries.md | 2 +- auto-increment.md | 2 +- auto-random.md | 2 +- basic-features.md | 2 +- benchmark/benchmark-sysbench-v2.md | 2 +- benchmark/benchmark-sysbench-v3.md | 4 +- .../benchmark-sysbench-v5.1.0-vs-v5.0.2.md | 4 +- .../benchmark-sysbench-v5.2.0-vs-v5.1.1.md | 4 +- .../benchmark-sysbench-v5.3.0-vs-v5.2.2.md | 4 +- .../benchmark-sysbench-v5.4.0-vs-v5.3.0.md | 4 +- .../benchmark-sysbench-v6.0.0-vs-v5.4.0.md | 4 +- .../benchmark-sysbench-v6.1.0-vs-v6.0.0.md | 4 +- .../benchmark-sysbench-v6.2.0-vs-v6.1.0.md | 4 +- benchmark/benchmark-tidb-using-ch.md | 2 +- benchmark/benchmark-tidb-using-sysbench.md | 4 +- benchmark/benchmark-tidb-using-tpcc.md | 2 +- benchmark/benchmark-tpch.md | 2 +- ...line-workloads-and-add-index-operations.md | 2 +- ...-performance-benchmarking-with-sysbench.md | 4 +- ...v3.0-performance-benchmarking-with-tpcc.md | 4 +- ...v5.1-performance-benchmarking-with-tpcc.md | 4 +- ...v5.2-performance-benchmarking-with-tpcc.md | 4 +- ...v5.3-performance-benchmarking-with-tpcc.md | 4 +- ...v5.4-performance-benchmarking-with-tpcc.md | 4 +- ...v6.0-performance-benchmarking-with-tpcc.md | 4 +- ...v6.1-performance-benchmarking-with-tpcc.md | 4 +- ...v6.2-performance-benchmarking-with-tpcc.md | 4 +- best-practices-for-security-configuration.md | 4 +- best-practices-on-public-cloud.md | 6 +-- .../grafana-monitor-best-practices.md | 2 +- best-practices/haproxy-best-practices.md | 2 +- .../high-concurrency-best-practices.md | 4 +- best-practices/java-app-best-practices.md | 2 +- best-practices/readonly-nodes.md | 2 +- best-practices/three-dc-local-read.md | 2 +- .../three-nodes-hybrid-deployment.md | 2 +- best-practices/tidb-best-practices.md | 4 +- binary-package.md | 2 +- br/backup-and-restore-design.md | 2 +- br/backup-and-restore-overview.md | 2 +- br/backup-and-restore-use-cases.md | 4 +- br/br-incremental-guide.md | 2 +- br/br-log-architecture.md | 2 +- br/br-pitr-guide.md | 2 +- br/br-pitr-manual.md | 2 +- br/br-snapshot-architecture.md | 2 +- br/br-snapshot-guide.md | 2 +- br/br-snapshot-manual.md | 6 +-- br/br-use-overview.md | 2 +- cached-tables.md | 4 +- certificate-authentication.md | 8 ++-- character-set-and-collation.md | 2 +- check-before-deployment.md | 2 +- clinic/clinic-collect-sql-query-plan.md | 2 +- clinic/clinic-data-instruction-for-tiup.md | 8 ++-- clinic/clinic-user-guide-for-tiup.md | 2 +- clinic/quick-start-with-clinic.md | 2 +- clustered-indexes.md | 4 +- command-line-flags-for-tidb-configuration.md | 2 +- comment-syntax.md | 2 +- configure-memory-usage.md | 2 +- credits.md | 6 +-- dashboard/dashboard-diagnostics-report.md | 2 +- dashboard/dashboard-ops-security.md | 2 +- ddl-introduction.md | 2 +- deploy-monitoring-services.md | 2 +- develop/dev-guide-build-cluster-in-cloud.md | 2 +- develop/dev-guide-overview.md | 8 ++-- develop/dev-guide-proxysql-integration.md | 8 ++-- develop/dev-guide-third-party-support.md | 2 +- ...v-guide-third-party-tools-compatibility.md | 8 ++-- develop/dev-guide-tidb-crud-sql.md | 2 +- develop/dev-guide-timeouts-in-tidb.md | 2 +- develop/dev-guide-use-temporary-tables.md | 2 +- dm/dm-binlog-event-filter.md | 2 +- dm/dm-enable-tls.md | 4 +- dm/dm-faq.md | 2 +- dm/dm-task-configuration-guide.md | 4 +- download-ecosystem-tools.md | 6 +-- dr-secondary-cluster.md | 4 +- dr-solution-introduction.md | 4 +- dumpling-overview.md | 4 +- dynamic-config.md | 2 +- ecosystem-tool-user-case.md | 6 +-- ecosystem-tool-user-guide.md | 4 +- enable-disk-spill-encrypt.md | 2 +- enable-tls-between-clients-and-servers.md | 4 +- enable-tls-between-components.md | 2 +- encryption-at-rest.md | 2 +- error-codes.md | 2 +- explain-overview.md | 2 +- faq/backup-and-restore-faq.md | 2 +- faq/deploy-and-maintain-faq.md | 16 +++---- faq/faq-overview.md | 2 +- faq/high-availability-faq.md | 4 +- faq/high-reliability-faq.md | 6 +-- faq/manage-cluster-faq.md | 46 +++++++++---------- faq/migration-tidb-faq.md | 18 ++++---- faq/monitor-faq.md | 2 +- faq/sql-faq.md | 36 +++++++-------- faq/tidb-faq.md | 34 +++++++------- filter-binlog-event.md | 2 +- foreign-key.md | 6 +-- .../aggregate-group-by-functions.md | 2 +- .../information-functions.md | 6 +-- functions-and-operators/tidb-functions.md | 2 +- get-started-with-tidb-lightning.md | 2 +- glossary.md | 2 +- grafana-tidb-dashboard.md | 2 +- hardware-and-software-requirements.md | 4 +- identify-slow-queries.md | 4 +- information-schema/information-schema.md | 2 +- log-redaction.md | 2 +- migrate-from-tidb-to-mysql.md | 2 +- migrate-from-tidb-to-tidb.md | 2 +- migration-overview.md | 2 +- mysql-compatibility.md | 2 +- mysql-schema/mysql-schema-user.md | 2 +- optimistic-transaction.md | 2 +- oracle-functions-to-tidb.md | 2 +- overview.md | 2 +- partitioned-table.md | 4 +- password-management.md | 4 +- pd-recover.md | 6 +-- performance-schema/performance-schema.md | 2 +- performance-tuning-methods.md | 10 ++-- performance-tuning-overview.md | 2 +- pessimistic-transaction.md | 2 +- post-installation-check.md | 4 +- privilege-management.md | 2 +- production-deployment-using-tiup.md | 4 +- quick-start-with-tidb.md | 2 +- read-historical-data.md | 2 +- releases/release-5.0.0.md | 4 +- releases/release-5.2.0.md | 2 +- releases/release-5.3.0.md | 4 +- releases/release-5.4.0.md | 2 +- releases/release-6.0.0-dmr.md | 2 +- releases/release-6.4.0.md | 4 +- releases/release-7.3.0.md | 2 +- releases/release-7.4.0.md | 2 +- releases/release-notes.md | 2 +- releases/release-timeline.md | 2 +- releases/versioning.md | 4 +- resources/tidb-pdf-generation-tutorial.md | 4 +- resources/tidb-terms.md | 2 +- scale-tidb-using-tiup.md | 2 +- schedule-replicas-by-topology-labels.md | 4 +- .../sql-statement-admin-show-ddl.md | 2 +- system-variables.md | 2 +- temporary-tables.md | 8 ++-- ticdc/deploy-ticdc.md | 6 +-- ticdc/integrate-confluent-using-ticdc.md | 2 +- ticdc/ticdc-avro-protocol.md | 6 +-- ticdc/ticdc-canal-json.md | 2 +- ticdc/ticdc-client-authentication.md | 2 +- ticdc/ticdc-faq.md | 4 +- ticdc/ticdc-manage-changefeed.md | 2 +- ticdc/ticdc-sink-to-cloud-storage.md | 2 +- ticdc/ticdc-sink-to-kafka.md | 2 +- ticdc/ticdc-upstream-downstream-check.md | 2 +- tidb-architecture.md | 2 +- tidb-computing.md | 2 +- tidb-configuration-file.md | 2 +- tidb-distributed-execution-framework.md | 2 +- tidb-global-sort.md | 2 +- tidb-in-kubernetes.md | 2 +- tidb-lightning/tidb-lightning-glossary.md | 2 +- tidb-lightning/troubleshoot-tidb-lightning.md | 2 +- tidb-monitoring-api.md | 2 +- tidb-monitoring-framework.md | 8 ++-- tidb-scheduling.md | 2 +- tidb-storage.md | 2 +- tidb-troubleshooting-map.md | 6 +-- tiflash/tiflash-configuration.md | 6 +-- tiflash/tune-tiflash-performance.md | 2 +- tiflash/use-tidb-to-read-tiflash.md | 2 +- time-to-live.md | 4 +- tiproxy/tiproxy-load-balance.md | 2 +- tiproxy/tiproxy-overview.md | 2 +- tiup/tiup-cluster-topology-reference.md | 2 +- tiup/tiup-cluster.md | 2 +- tiup/tiup-playground.md | 10 ++-- transaction-isolation-levels.md | 2 +- transaction-overview.md | 2 +- troubleshoot-cpu-issues.md | 2 +- troubleshoot-high-disk-io.md | 2 +- troubleshoot-hot-spot-issues.md | 4 +- troubleshoot-lock-conflicts.md | 2 +- troubleshoot-tidb-cluster.md | 2 +- tso.md | 2 +- upgrade-monitoring-services.md | 6 +-- upgrade-tidb-using-tiup.md | 4 +- user-account-management.md | 2 +- vector-search-get-started-using-python.md | 4 +- vector-search-get-started-using-sql.md | 2 +- vector-search-integrate-with-django-orm.md | 4 +- ...-search-integrate-with-jinaai-embedding.md | 6 +-- vector-search-integrate-with-langchain.md | 2 +- vector-search-integrate-with-llamaindex.md | 4 +- vector-search-integrate-with-peewee.md | 4 +- vector-search-integrate-with-sqlalchemy.md | 4 +- 207 files changed, 393 insertions(+), 393 deletions(-) diff --git a/.vaunt/add-tidb-docs-dash-badge.md b/.vaunt/add-tidb-docs-dash-badge.md index a58e6368d1ba..02487c898700 100644 --- a/.vaunt/add-tidb-docs-dash-badge.md +++ b/.vaunt/add-tidb-docs-dash-badge.md @@ -1,4 +1,4 @@ -# 如何在你的 GitHub 个人资料页上添加 TiDB 文档挑战赛徽章 +# 如何在你的 GitHub 个人资料页上添加测试数据库文档挑战赛徽章 [GitHub 个人资料页](https://docs.github.com/zh/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)不仅仅是你的 GitHub 仓库的集合，更是你在编程领域中的专业身份标志。 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6d6e70f9983..25675323b52c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# TiDB 中文文档贡献指南 +# 测试数据库中文文档贡献指南 无论你是热爱技术的程序员，还是擅长书面表达的语言爱好者，亦或是纯粹想帮 TiDB 改进文档的热心小伙伴，都欢迎来为 TiDB 文档做贡献，一起打造更加易用友好的 TiDB 文档！ -## 我能为 TiDB 文档做什么贡献？ +## 我能为测试数据库文档做什么贡献？ 你可以在提升 TiDB 文档质量、易用性、维护效率、翻译效率等方面做贡献，比如： diff --git a/README.md b/README.md index 859a99cc5792..29b0b76cea73 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# TiDB 文档 +# 测试数据库文档 欢迎来到 [TiDB](https://github.com/pingcap/tidb) 文档仓库！ @@ -8,7 +8,7 @@ 如果你想在本地定制输出符合特定场景需求的 PDF 格式的 TiDB 文档，例如对 TiDB 文档目录进行自由排序和删减，请参考[自助生成 TiDB 文档 PDF 教程](/resources/tidb-pdf-generation-tutorial.md)。 -## TiDB 文档维护方式及版本说明 +## 测试数据库文档维护方式及版本说明 目前，TiDB 的文档维护在以下 branch，对应着官网文档的不同版本： diff --git a/accelerated-table-creation.md b/accelerated-table-creation.md index 8dc306dcff4c..26322a1fefa4 100644 --- a/accelerated-table-creation.md +++ b/accelerated-table-creation.md @@ -3,7 +3,7 @@ title: 提升 TiDB 建表性能 summary: 介绍 TiDB 加速建表中的概念、原理、实现和影响。 --- -# 提升 TiDB 建表性能 +# 提升测试数据库建表性能 TiDB v7.6.0 引入了系统变量 [`tidb_ddl_version`](https://docs.pingcap.com/zh/tidb/v7.6/system-variables#tidb_ddl_version-从-v760-版本开始引入) 实现支持加速建表，可提升大批量建表的速度。从 v8.0.0 开始，该系统变量更名为 [`tidb_enable_fast_create_table`](/system-variables.md#tidb_enable_fast_create_table-从-v800-版本开始引入)。 @@ -11,7 +11,7 @@ TiDB v7.6.0 引入了系统变量 [`tidb_ddl_version`](https://docs.pingcap.com/ 合并后的批量建表语句在同一个事务内执行，如果其中一个语句失败，所有语句都会失败。 -## 与 TiDB 工具的兼容性 +## 与测试数据库工具的兼容性 - 在 TiDB v8.3.0 之前的版本中，[TiCDC](/ticdc/ticdc-overview.md) 不支持同步通过 TiDB 加速创建的表。从 v8.3.0 开始，TiCDC 可以正常同步这类表。 diff --git a/alert-rules.md b/alert-rules.md index 7dccc166eda6..950dd48295e9 100644 --- a/alert-rules.md +++ b/alert-rules.md @@ -3,7 +3,7 @@ title: TiDB 集群报警规则 summary: TiDB 集群中各组件的报警规则详解。 --- -# TiDB 集群报警规则 +# 测试数据库集群报警规则 本文介绍了 TiDB 集群中各组件的报警规则，包括 TiDB、TiKV、PD、TiFlash、TiCDC、Node_exporter 和 Blackbox_exporter 的各报警项的规则描述及处理方法。 @@ -15,7 +15,7 @@ summary: TiDB 集群中各组件的报警规则详解。 | 严重级别 | 服务可用性下降，需要用户密切关注异常指标 | | 警告级别 | 对某一问题或错误的提醒 | -## TiDB 报警规则 +## 测试数据库报警规则 本节介绍了 TiDB 组件的报警项。 diff --git a/analyze-slow-queries.md b/analyze-slow-queries.md index 8005c593560e..3028b51662c9 100644 --- a/analyze-slow-queries.md +++ b/analyze-slow-queries.md @@ -159,7 +159,7 @@ mysql> explain analyze select count(*) from t where a=(select max(t1.a) from t t 可以看到有 1 个子查询被提前执行，花费了 `7.76s`。 -### TiDB 执行慢 +### 测试数据库执行慢 这里我们假设 TiDB 的执行计划正确（不正确的情况在[分析优化器问题](#分析优化器问题)这一节中说明），但是执行上很慢； diff --git a/auto-increment.md b/auto-increment.md index 0894b3efac63..3c6ec80bbdb9 100644 --- a/auto-increment.md +++ b/auto-increment.md @@ -9,7 +9,7 @@ summary: 介绍 TiDB 的 `AUTO_INCREMENT` 列属性。 > **注意：** > -> 使用 `AUTO_INCREMENT` 可能会给生产环境带热点问题，因此推荐使用 [`AUTO_RANDOM`](/auto-random.md) 代替。详情请参考 [TiDB 热点问题处理](/troubleshoot-hot-spot-issues.md#tidb-热点问题处理)。 +> 使用 `AUTO_INCREMENT` 可能会给生产环境带热点问题，因此推荐使用 [`AUTO_RANDOM`](/auto-random.md) 代替。详情请参考 [测试数据库热点问题处理](/troubleshoot-hot-spot-issues.md#测试数据库热点问题处理)。 在 [`CREATE TABLE`](/sql-statements/sql-statement-create-table.md) 语句中也可以使用 `AUTO_INCREMENT` 参数来指定自增字段的初始值。 diff --git a/auto-random.md b/auto-random.md index 84bf027cce63..886980e31d1d 100644 --- a/auto-random.md +++ b/auto-random.md @@ -27,7 +27,7 @@ CREATE TABLE t (a BIGINT AUTO_RANDOM(5, 54), b VARCHAR(255), PRIMARY KEY (a)); CREATE TABLE t (a BIGINT AUTO_RANDOM(5, 54), b VARCHAR(255), PRIMARY KEY (a, b)); ``` -`AUTO_RANDOM` 关键字可以被包裹在 TiDB 可执行注释中，注释语法请参考 [TiDB 可执行注释](/comment-syntax.md#tidb-可执行的注释语法)。 +`AUTO_RANDOM` 关键字可以被包裹在 TiDB 可执行注释中，注释语法请参考 [测试数据库可执行注释](/comment-syntax.md#测试数据库可执行的注释语法)。 ```sql CREATE TABLE t (a bigint /*T![auto_rand] AUTO_RANDOM */, b VARCHAR(255), PRIMARY KEY (a)); diff --git a/basic-features.md b/basic-features.md index 8eb2b0eef0ae..8a5dec791e5b 100644 --- a/basic-features.md +++ b/basic-features.md @@ -3,7 +3,7 @@ title: TiDB 功能概览 summary: 了解 TiDB 的功能概览。 --- -# TiDB 功能概览 +# 测试数据库功能概览 本文列出了 TiDB 功能在不同版本中的支持变化情况，包括[长期支持版本 (LTS)](/releases/versioning.md#长期支持版本) 和最新的 LTS 版本之后的[开发里程碑版本 (DMR)](/releases/versioning.md#开发里程碑版本)。 diff --git a/benchmark/benchmark-sysbench-v2.md b/benchmark/benchmark-sysbench-v2.md index ef5ce303a384..7c9a47f8c9a4 100644 --- a/benchmark/benchmark-sysbench-v2.md +++ b/benchmark/benchmark-sysbench-v2.md @@ -30,7 +30,7 @@ IDC 机器 ## 测试方案 -### TiDB 版本信息 +### 测试数据库版本信息 ### v1.0.8 diff --git a/benchmark/benchmark-sysbench-v3.md b/benchmark/benchmark-sysbench-v3.md index 30c8f7050118..88985e56e283 100644 --- a/benchmark/benchmark-sysbench-v3.md +++ b/benchmark/benchmark-sysbench-v3.md @@ -34,7 +34,7 @@ Sysbench 版本：1.1.0 使用 Sysbench 向集群导入 **16 张表，每张数据 1000 万**。通过 HAProxy 代理，分别以递增并发数向集群发送请求，单次并发测试时间 5 分钟。 -### TiDB 版本信息 +### 测试数据库版本信息 ### v2.1.0-rc.2 @@ -52,7 +52,7 @@ Sysbench 版本：1.1.0 | TiKV | 57c83dc4ebc93d38d77dc8f7d66db224760766cc | | PD | b64716707b7279a4ae822be767085ff17b5f3fea | -### TiDB 参数配置 +### 测试数据库参数配置 两版本 TiDB 均使用**默认配置**。 diff --git a/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md b/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md index a45240256eb9..f1075f528f31 100644 --- a/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md +++ b/benchmark/benchmark-sysbench-v5.1.0-vs-v5.0.2.md @@ -33,7 +33,7 @@ summary: TiDB v5.1.0 在 OLTP 场景下的 Sysbench 性能表现对比 v5.0.2。 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -63,7 +63,7 @@ pessimistic-txn.pipelined: true server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md b/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md index e7c4769ac2fe..b39458914047 100644 --- a/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md +++ b/benchmark/benchmark-sysbench-v5.2.0-vs-v5.1.1.md @@ -33,7 +33,7 @@ summary: TiDB v5.2.0 在 OLTP 场景下的 Sysbench 性能对比测试显示，P 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -63,7 +63,7 @@ pessimistic-txn.pipelined: true server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md b/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md index 6ab0cb0d16d2..7deb7a9ed790 100644 --- a/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md +++ b/benchmark/benchmark-sysbench-v5.3.0-vs-v5.2.2.md @@ -33,7 +33,7 @@ summary: TiDB v5.3.0 和 v5.2.2 在 OLTP 场景下的 Sysbench 性能对比测 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -62,7 +62,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md b/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md index edf021fb5224..fd60ec76a3f1 100644 --- a/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md +++ b/benchmark/benchmark-sysbench-v5.4.0-vs-v5.3.0.md @@ -33,7 +33,7 @@ summary: TiDB v5.4.0 在 OLTP 场景下的 Sysbench 性能比 v5.3.0 有所提 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -62,7 +62,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md b/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md index 4a9ea0df0ebc..72105f82d251 100644 --- a/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md +++ b/benchmark/benchmark-sysbench-v6.0.0-vs-v5.4.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.0.0 在 OLTP 场景下的 Sysbench 性能表现对比 v5.4.0。 两个版本使用相同的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -59,7 +59,7 @@ readpool.storage.normal-concurrency: 10 pessimistic-txn.pipelined: true ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md b/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md index 3b8953af1e02..8bef1b58ad76 100644 --- a/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md +++ b/benchmark/benchmark-sysbench-v6.1.0-vs-v6.0.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.1.0 在 OLTP 场景下的 Sysbench 性能表现优于 v6.0.0。 两个版本使用相同的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -56,7 +56,7 @@ server.grpc-concurrency: 6 readpool.storage.normal-concurrency: 10 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md b/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md index 37c4b5ae941f..3346893862c0 100644 --- a/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md +++ b/benchmark/benchmark-sysbench-v6.2.0-vs-v6.1.0.md @@ -33,7 +33,7 @@ summary: TiDB v6.2.0 和 v6.1.0 在 OLTP 场景下的 Sysbench 性能对比测 两个版本使用相同的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -56,7 +56,7 @@ server.grpc-concurrency: 6 readpool.unified.max-thread-count: 10 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/benchmark-tidb-using-ch.md b/benchmark/benchmark-tidb-using-ch.md index d652ae304764..8ffbd7f995bf 100644 --- a/benchmark/benchmark-tidb-using-ch.md +++ b/benchmark/benchmark-tidb-using-ch.md @@ -3,7 +3,7 @@ title: 如何对 TiDB 进行 CH-benCHmark 测试 summary: 本文介绍如何对 TiDB 进行 CH-benCHmark 测试。 --- -# 如何对 TiDB 进行 CH-benCHmark 测试 +# 如何对测试数据库进行 CH-benCHmark 测试 本文介绍如何对 TiDB 进行 CH-benCHmark 测试。 diff --git a/benchmark/benchmark-tidb-using-sysbench.md b/benchmark/benchmark-tidb-using-sysbench.md index a12be2bcf992..b9218c0e0ea8 100644 --- a/benchmark/benchmark-tidb-using-sysbench.md +++ b/benchmark/benchmark-tidb-using-sysbench.md @@ -9,7 +9,7 @@ summary: 使用 Sysbench 1.0 或更新版本测试 TiDB 性能。调整 TiDB 和 ## 测试方案 -### TiDB 配置 +### 测试数据库配置 升高日志级别，可以减少打印日志数量，对 TiDB 的性能有积极影响。具体在 TiUP 配置文件中加入： @@ -182,7 +182,7 @@ TiKV 的其他模块，如 storage readpool、coprocessor 和 gRPC 的最大并 通过 Grafana 的 TiKV Thread CPU 监控面板可以观察到其实际使用率。如出现多线程模块瓶颈，可以通过增加该模块并发度进行调整。 -### 在高并发压力下，TiKV 也未达到 CPU 使用瓶颈，为什么 TiDB 的 CPU 利用率依然很低？ +### 在高并发压力下，TiKV 也未达到 CPU 使用瓶颈，为什么测试数据库的 CPU 利用率依然很低？ 在某些高端设备上，使用的是 NUMA 架构的 CPU，跨 CPU 访问远端内存将极大降低性能。TiDB 默认将使用服务器所有 CPU，goroutine 的调度不可避免地会出现跨 CPU 内存访问。 diff --git a/benchmark/benchmark-tidb-using-tpcc.md b/benchmark/benchmark-tidb-using-tpcc.md index b53217be3696..cf0020fa37d7 100644 --- a/benchmark/benchmark-tidb-using-tpcc.md +++ b/benchmark/benchmark-tidb-using-tpcc.md @@ -3,7 +3,7 @@ title: 如何对 TiDB 进行 TPC-C 测试 summary: 本文介绍了如何对 TiDB 进行 TPC-C 测试。TPC-C 是一个对 OLTP 系统进行测试的规范，使用商品销售模型对系统进行测试，包含五类事务：NewOrder、Payment、OrderStatus、Delivery、StockLevel。测试使用 tpmC 值衡量系统最大有效吞吐量，以 NewOrder Transaction 为准。使用 go-tpc 进行测试实现，通过 TiUP 命令下载测试程序。测试包括数据导入、运行测试和清理测试数据。 --- -# 如何对 TiDB 进行 TPC-C 测试 +# 如何对测试数据库进行 TPC-C 测试 本文介绍如何对 TiDB 进行 [TPC-C](http://www.tpc.org/tpcc/) 测试。 diff --git a/benchmark/benchmark-tpch.md b/benchmark/benchmark-tpch.md index d9bd01120f39..996edd48cdfa 100644 --- a/benchmark/benchmark-tpch.md +++ b/benchmark/benchmark-tpch.md @@ -53,7 +53,7 @@ summary: TiDB TPC-H 50G 性能测试报告显示，TiDB 2.0 在大部分查询 | 172.16.31.10 | PD \* 1 | | 172.16.31.4 | TiDB \* 1 | -### TiDB 版本信息 +### 测试数据库版本信息 TiDB 1.0: diff --git a/benchmark/online-workloads-and-add-index-operations.md b/benchmark/online-workloads-and-add-index-operations.md index 1a894ee40b48..c547d8fdca47 100644 --- a/benchmark/online-workloads-and-add-index-operations.md +++ b/benchmark/online-workloads-and-add-index-operations.md @@ -31,7 +31,7 @@ TiDB 版本：v3.0.1 Sysbench 版本：1.0.17 -### TiDB 参数配置 +### 测试数据库参数配置 TiDB、TiKV 和 PD 均使用 [TiDB Operator](https://github.com/pingcap/tidb-operator) 默认配置。 diff --git a/benchmark/v3.0-performance-benchmarking-with-sysbench.md b/benchmark/v3.0-performance-benchmarking-with-sysbench.md index de7ed220039f..b0cb3504c8d8 100644 --- a/benchmark/v3.0-performance-benchmarking-with-sysbench.md +++ b/benchmark/v3.0-performance-benchmarking-with-sysbench.md @@ -70,7 +70,7 @@ sysbench $testname \ run --tables=16 --table-size=10000000 ``` -### TiDB 版本信息 +### 测试数据库版本信息 ### v3.0.0 @@ -88,7 +88,7 @@ sysbench $testname \ | TiKV | `b3cf3c8d642534ea6fa93d475a46da285cc6acbf` | | PD | `886362ebfb26ef0834935afc57bcee8a39c88e54` | -### TiDB 参数配置 +### 测试数据库参数配置 2.1 和 3.0 中开启 prepared plan cache（出于优化考虑，2.1 的 point select 与 read write 并未开启）： diff --git a/benchmark/v3.0-performance-benchmarking-with-tpcc.md b/benchmark/v3.0-performance-benchmarking-with-tpcc.md index b01fa9692b8a..8c6d6673c797 100644 --- a/benchmark/v3.0-performance-benchmarking-with-tpcc.md +++ b/benchmark/v3.0-performance-benchmarking-with-tpcc.md @@ -40,7 +40,7 @@ git clone -b 5.0-mysql-support-opt https://github.com/pingcap/benchmarksql.git 使用 BenchmarkSQL 向集群导入 **1000 warehouse** 的数据。通过 HAProxy 代理，分别以递增并发数向集群发送请求，单次并发测试时间 10 分钟。 -### TiDB 版本信息 +### 测试数据库版本信息 ### v3.0.0 @@ -58,7 +58,7 @@ git clone -b 5.0-mysql-support-opt https://github.com/pingcap/benchmarksql.git | TiKV | b3cf3c8d642534ea6fa93d475a46da285cc6acbf | | PD | 886362ebfb26ef0834935afc57bcee8a39c88e54 | -### TiDB 参数配置 +### 测试数据库参数配置 ```toml [log] diff --git a/benchmark/v5.1-performance-benchmarking-with-tpcc.md b/benchmark/v5.1-performance-benchmarking-with-tpcc.md index 8a523f3cf0a3..48f3ec9bdaca 100644 --- a/benchmark/v5.1-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.1-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.1.0 在 TPC-C 性能上提升了 2.8%，测试环境为 AWS EC2 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -65,7 +65,7 @@ storage.scheduler-worker-pool-size: 20 server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.2-performance-benchmarking-with-tpcc.md b/benchmark/v5.2-performance-benchmarking-with-tpcc.md index f82f66b87c69..75b3017a2b02 100644 --- a/benchmark/v5.2-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.2-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.2.0 在 TPC-C 性能上下降了 4.22%，测试环境为 AWS EC 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -65,7 +65,7 @@ storage.scheduler-worker-pool-size: 20 server.enable-request-batch: false ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.3-performance-benchmarking-with-tpcc.md b/benchmark/v5.3-performance-benchmarking-with-tpcc.md index 2130833a9c44..de98a300e2e2 100644 --- a/benchmark/v5.3-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.3-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.3.0 在 TPC-C 性能上略下降了 2.99%，与 v5.2.2 相比 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -64,7 +64,7 @@ server.grpc-concurrency: 6 storage.scheduler-worker-pool-size: 20 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v5.4-performance-benchmarking-with-tpcc.md b/benchmark/v5.4-performance-benchmarking-with-tpcc.md index 3831300d64f6..c5166fbaf765 100644 --- a/benchmark/v5.4-performance-benchmarking-with-tpcc.md +++ b/benchmark/v5.4-performance-benchmarking-with-tpcc.md @@ -33,7 +33,7 @@ summary: TiDB v5.4.0 在 TPC-C 性能上提升了 3.16%，测试结果显示不 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -64,7 +64,7 @@ server.grpc-concurrency: 6 storage.scheduler-worker-pool-size: 20 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.0-performance-benchmarking-with-tpcc.md b/benchmark/v6.0-performance-benchmarking-with-tpcc.md index 033c382ddc37..0d5207654bd3 100644 --- a/benchmark/v6.0-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.0-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.0.0 在 TPC-C 性能上比 v5.4.0 提升了 24.20%，表现更 两个版本使用同样的配置 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -61,7 +61,7 @@ rocksdb.max-background-jobs: 8 server.grpc-concurrency: 6 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.1-performance-benchmarking-with-tpcc.md b/benchmark/v6.1-performance-benchmarking-with-tpcc.md index 045caf09cc99..93c316367adf 100644 --- a/benchmark/v6.1-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.1-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.1.0 在 TPC-C 性能上平均提升了 2.85%，分别为：50 两个版本使用同样的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -57,7 +57,7 @@ readpool.storage.normal-concurrency: 10 server.grpc-concurrency: 6 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/benchmark/v6.2-performance-benchmarking-with-tpcc.md b/benchmark/v6.2-performance-benchmarking-with-tpcc.md index 0b83fbe7e552..9f85e2c0418d 100644 --- a/benchmark/v6.2-performance-benchmarking-with-tpcc.md +++ b/benchmark/v6.2-performance-benchmarking-with-tpcc.md @@ -34,7 +34,7 @@ summary: TiDB v6.2.0 在 TPC-C 性能测试中相比 v6.1.0 下降了 2.00%， 两个版本使用同样的配置。 -#### TiDB 参数配置 +#### 测试数据库参数配置 {{< copyable "" >}} @@ -57,7 +57,7 @@ readpool.storage.normal-concurrency: 10 server.grpc-concurrency: 6 ``` -#### TiDB 全局变量配置 +#### 测试数据库全局变量配置 {{< copyable "sql" >}} diff --git a/best-practices-for-security-configuration.md b/best-practices-for-security-configuration.md index daca3966fd3e..a8ce9940848c 100644 --- a/best-practices-for-security-configuration.md +++ b/best-practices-for-security-configuration.md @@ -3,7 +3,7 @@ title: TiDB 安全配置最佳实践 summary: 介绍 TiDB 安全配置的最佳实践，帮助你降低潜在的安全风险。 --- -# TiDB 安全配置最佳实践 +# 测试数据库安全配置最佳实践 TiDB 的安全性对于保护数据完整性和机密性至关重要。本文提供了 TiDB 集群部署时的安全配置指南。遵循这些最佳实践可以有效降低潜在安全风险、防范数据泄露，并确保 TiDB 数据库系统能够持续稳定、可靠地运行。 @@ -118,6 +118,6 @@ sudo iptables -P INPUT DROP ## 解决第三方扫描器 MySQL 漏洞误报 -大多数漏洞扫描器在检测 MySQL 漏洞时，会根据版本信息来匹配 CVE 漏洞。由于 TiDB 仅兼容 MySQL 协议而非 MySQL 本身，基于版本信息的漏洞扫描可能导致误报。建议漏洞扫描应以原理扫描为主。当合规漏洞扫描工具要求 MySQL 版本时，你可以[修改服务器版本号](/faq/high-reliability-faq.md#我们的安全漏洞扫描工具对-mysql-version-有要求tidb-是否支持修改-server-版本号呢)，以满足其要求。 +大多数漏洞扫描器在检测 MySQL 漏洞时，会根据版本信息来匹配 CVE 漏洞。由于 TiDB 仅兼容 MySQL 协议而非 MySQL 本身，基于版本信息的漏洞扫描可能导致误报。建议漏洞扫描应以原理扫描为主。当合规漏洞扫描工具要求 MySQL 版本时，你可以[修改服务器版本号](/faq/high-reliability-faq.md#我们的安全漏洞扫描工具对-mysql-version-有要求测试数据库是否支持修改-server-版本号呢)，以满足其要求。 通过修改服务器版本号，可避免漏洞扫描器产生误报。[`server-version`](/tidb-configuration-file.md#server-version) 的值会被 TiDB 节点用于验证当前 TiDB 的版本。在进行 TiDB 集群升级前，请将 `server-version` 的值设置为空或者当前 TiDB 真实的版本值，避免出现非预期行为。 diff --git a/best-practices-on-public-cloud.md b/best-practices-on-public-cloud.md index 619ffc0e0e7f..36f5f02a9bf1 100644 --- a/best-practices-on-public-cloud.md +++ b/best-practices-on-public-cloud.md @@ -3,7 +3,7 @@ title: 在公有云上部署 TiDB 的最佳实践 summary: 了解在公有云上部署 TiDB 的最佳实践。 --- -# 在公有云上部署 TiDB 的最佳实践 +# 在公有云上部署测试数据库的最佳实践 随着公有云基础设施的普及，越来越多的用户选择在公有云上部署和管理 TiDB。然而，要想在公有云上充分发挥 TiDB 的性能，需要关注多个方面，包括性能优化、成本控制、系统可靠性和可扩展性。 @@ -160,7 +160,7 @@ Google Cloud 的[实时迁移功能](https://cloud.google.com/compute/docs/insta 通过使用该监控脚本，并在维护事件期间采取必要的措施，TiDB 集群可以更好地应对 Google Cloud 上的实时迁移事件，确保对查询处理和响应时间的影响最小以及系统的平稳运行。 -## 为具有高 QPS 的大规模 TiDB 集群优化 PD 性能 +## 为具有高 QPS 的大规模测试数据库集群优化 PD 性能 在 TiDB 集群中，一个活跃的 Placement Driver (PD) Server 承担着许多关键任务，例如处理提供 TSO (Timestamp Oracle) 和处理请求。然而，依赖单个活跃 PD Server 可能会限制 TiDB 集群的扩展性。 @@ -183,7 +183,7 @@ Google Cloud 的[实时迁移功能](https://cloud.google.com/compute/docs/insta tso-update-physical-interval = "10ms" # 默认值为 50ms ``` -#### 调整 TiDB 全局变量 +#### 调整测试数据库全局变量 除了 PD 配置外，启用 TSO 客户端攒批操作的等待功能可以进一步优化 TSO 客户端的行为。要启用此功能，可以将全局变量 [`tidb_tso_client_batch_max_wait_time`](/system-variables.md#tidb_tso_client_batch_max_wait_time-从-v530-版本开始引入) 设置为非零值： diff --git a/best-practices/grafana-monitor-best-practices.md b/best-practices/grafana-monitor-best-practices.md index 6fda9d06ece0..64afd2ffb41b 100644 --- a/best-practices/grafana-monitor-best-practices.md +++ b/best-practices/grafana-monitor-best-practices.md @@ -3,7 +3,7 @@ title: 使用 Grafana 监控 TiDB 的最佳实践 summary: 了解高效利用 Grafana 监控 TiDB 的七个技巧。 --- -# 使用 Grafana 监控 TiDB 的最佳实践 +# 使用 Grafana 监控测试数据库的最佳实践 [使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)时，如果在拓扑配置中添加了 Grafana 和 Prometheus，会部署一套 [Grafana + Prometheus 的监控平台](/tidb-monitoring-framework.md)，用于收集和展示 TiDB 集群各个组件和机器的 metric 信息。本文主要介绍使用 TiDB 监控的最佳实践，旨在帮助 TiDB 用户高效利用丰富的 metric 信息来分析 TiDB 的集群状态或进行故障诊断。 diff --git a/best-practices/haproxy-best-practices.md b/best-practices/haproxy-best-practices.md index 85879e9a9741..26eb037f6179 100644 --- a/best-practices/haproxy-best-practices.md +++ b/best-practices/haproxy-best-practices.md @@ -3,7 +3,7 @@ title: HAProxy 在 TiDB 中的最佳实践 summary: HAProxy 是 TiDB 中实现负载均衡的最佳实践。它提供 TCP 协议下的负载均衡能力，通过连接 HAProxy 提供的浮动 IP 对数据进行操作，实现 TiDB Server 层的负载均衡。HAProxy 提供高可用性、负载均衡、健康检查、会话保持、SSL 支持和监控统计等核心功能。部署 HAProxy 需要满足一定的硬件和软件要求，配置和启动 HAProxy 后即可实现数据库负载均衡。 --- -# HAProxy 在 TiDB 中的最佳实践 +# HAProxy 在测试数据库中的最佳实践 本文介绍 [HAProxy](https://github.com/haproxy/haproxy) 在 TiDB 中的最佳配置和使用方法。HAProxy 提供 TCP 协议下的负载均衡能力，TiDB 客户端通过连接 HAProxy 提供的浮动 IP 即可对数据进行操作，实现 TiDB Server 层的负载均衡。 diff --git a/best-practices/high-concurrency-best-practices.md b/best-practices/high-concurrency-best-practices.md index e738aac014a4..9738cfac9dc2 100644 --- a/best-practices/high-concurrency-best-practices.md +++ b/best-practices/high-concurrency-best-practices.md @@ -3,7 +3,7 @@ title: TiDB 高并发写入场景最佳实践 summary: 了解 TiDB 在高并发写入场景下的最佳实践。 --- -# TiDB 高并发写入场景最佳实践 +# 测试数据库高并发写入场景最佳实践 在 TiDB 的使用过程中，一个典型场景是高并发批量写入数据到 TiDB。本文阐述了该场景中的常见问题，旨在给出一个业务的最佳实践，帮助读者避免因使用 TiDB 不当而影响业务开发。 @@ -26,7 +26,7 @@ summary: 了解 TiDB 在高并发写入场景下的最佳实践。 对于分布式数据库来说，除了本身的基础性能外，最重要的就是充分利用所有节点能力，避免让单个节点成为瓶颈。 -## TiDB 数据分布原理 +## 测试数据库数据分布原理 如果要解决以上挑战，需要从 TiDB 数据切分以及调度的原理开始讲起。这里只作简单说明，详情可参阅[谈调度](https://pingcap.com/blog-cn/tidb-internal-3/)。 diff --git a/best-practices/java-app-best-practices.md b/best-practices/java-app-best-practices.md index eb44c002eb9b..f657f1e78371 100644 --- a/best-practices/java-app-best-practices.md +++ b/best-practices/java-app-best-practices.md @@ -3,7 +3,7 @@ title: 开发 Java 应用使用 TiDB 的最佳实践 summary: 本文介绍了开发 Java 应用程序使用 TiDB 的常见问题与解决办法。TiDB 是高度兼容 MySQL 协议的数据库，基于 MySQL 开发的 Java 应用的最佳实践也多适用于 TiDB。 --- -# 开发 Java 应用使用 TiDB 的最佳实践 +# 开发 Java 应用使用测试数据库的最佳实践 本文主要介绍如何开发 Java 应用程序以更好地使用 TiDB，包括开发中的常见问题与最佳实践。 diff --git a/best-practices/readonly-nodes.md b/best-practices/readonly-nodes.md index c43f1fbb3093..10af0000abba 100644 --- a/best-practices/readonly-nodes.md +++ b/best-practices/readonly-nodes.md @@ -107,7 +107,7 @@ tikv_servers: ### 3. 使用 Follower Read 功能读取只读节点 -#### 3.1 在 TiDB 中使用 Follower Read +#### 3.1 在测试数据库中使用 Follower Read 你可以将系统变量 [`tidb_replica_read`](/system-variables.md#tidb_replica_read-从-v40-版本开始引入) 设置为 `learner` 来读取只读节点上的数据： diff --git a/best-practices/three-dc-local-read.md b/best-practices/three-dc-local-read.md index 00209d00e2d6..3788543a36f1 100644 --- a/best-practices/three-dc-local-read.md +++ b/best-practices/three-dc-local-read.md @@ -7,7 +7,7 @@ summary: 了解通过 Stale Read 功能在三数据中心下就近读取数据 在三数据中心模式下，Region 的三个副本都会隔离在各个数据中心里。然而在强一致读的要求下，TiDB 的每一个查询都需要访问对应数据的 Leader 副本，而查询的来源可能和 Leader 所在的数据中心不一致，这就会引起跨数据中心的数据访问，从而造成访问的延迟上升。本文主要介绍使用 [Stale Read](/stale-read.md) 功能，以牺牲数据实时性的方式，避免跨数据中心的访问，从而降低访问的延迟。 -## 部署三数据中心的 TiDB 集群 +## 部署三数据中心的测试数据库集群 部署三数据中心的方法，参考[同城多数据中心部署 TiDB](/multi-data-centers-in-one-city-deployment.md)。 diff --git a/best-practices/three-nodes-hybrid-deployment.md b/best-practices/three-nodes-hybrid-deployment.md index 4b07847ff3df..44f9cf2c419b 100644 --- a/best-practices/three-nodes-hybrid-deployment.md +++ b/best-practices/three-nodes-hybrid-deployment.md @@ -114,7 +114,7 @@ tiup ctl:v tikv --host=${ip:port} modify-tikv-config -n gc.max_ > > 对于更新频繁的业务场景，限制 GC 流量可能会导致 MVCC 版本堆积，进而影响读取性能。所以这个参数的取值需要进行多次尝试，在性能抖动和性能衰退之间找一个比较平衡的取值。 -### TiDB 参数调整 +### 测试数据库参数调整 一般通过系统变量调整 TiDB 执行算子的优化参数，例如 `tidb_hash_join_concurrency`、`tidb_index_lookup_join_concurrency` 等。 diff --git a/best-practices/tidb-best-practices.md b/best-practices/tidb-best-practices.md index d917546b41ad..60155f27541c 100644 --- a/best-practices/tidb-best-practices.md +++ b/best-practices/tidb-best-practices.md @@ -3,7 +3,7 @@ title: TiDB 最佳实践 summary: TiDB 最佳实践总结了使用 TiDB 的一些优化技巧，包括 Raft 一致性协议、分布式事务、数据分片、负载均衡、SQL 到 KV 的映射方案、二级索引的实现方法等。建议阅读官方文档和知乎专栏了解更多细节。部署时推荐使用 TiUP，导入数据时可对 TiKV 参数进行调优。在写入和查询时需注意事务大小限制和并发度设置。监控系统和日志查看也是了解系统状态的重要方法。适用场景包括数据量大、不希望做 Sharding、需要事务和强一致性等。 --- -# TiDB 最佳实践 +# 测试数据库最佳实践 本文档总结使用 TiDB 时的一些最佳实践，主要涉及 SQL 使用和 OLAP/OLTP 优化技巧，特别是一些 TiDB 专有的优化开关。 @@ -187,7 +187,7 @@ TiDB [使用 Grafana + Prometheus 监控系统状态](/tidb-monitoring-framework + 知乎专栏：[TiDB 的后花园](https://zhuanlan.zhihu.com/newsql) + [官方博客](https://pingcap.com/blog-cn/) -## TiDB 的最佳适用场景 +## 测试数据库的最佳适用场景 简单来说，TiDB 适合具备下面这些特点的场景： diff --git a/binary-package.md b/binary-package.md index bbc355251a4a..4298d7a95c65 100644 --- a/binary-package.md +++ b/binary-package.md @@ -3,7 +3,7 @@ title: TiDB 离线包 summary: 了解 TiDB 离线包及其包含的内容。 --- -# TiDB 离线包 +# 测试数据库离线包 在[使用 TiUP 离线部署 TiDB](/production-deployment-using-tiup.md#离线部署) 前，你需要在[官方下载页面](https://cn.pingcap.com/product-community/)选择对应版本的 TiDB server 离线镜像包（包含 TiUP 离线组件包）。 diff --git a/br/backup-and-restore-design.md b/br/backup-and-restore-design.md index 2bf7d685d97b..7e07409e3f6c 100644 --- a/br/backup-and-restore-design.md +++ b/br/backup-and-restore-design.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复功能架构概述 summary: 了解 TiDB 的备份与恢复功能的架构设计。 --- -# TiDB 备份与恢复功能架构概述 +# 测试数据库备份与恢复功能架构概述 正如 [TiDB 备份与恢复概述](/br/backup-and-restore-overview.md)所介绍，TiDB 备份恢复功能包含了多种不同类型的集群数据对象的备份与恢复实现。这些功能都以 Backup & Restore (BR) 和 TiDB Operator 为使用入口，创建相应的任务从 TiKV 节点上备份数据，或者恢复数据到 TiKV 节点。 diff --git a/br/backup-and-restore-overview.md b/br/backup-and-restore-overview.md index 4d58e2cfec8e..b735a9463457 100644 --- a/br/backup-and-restore-overview.md +++ b/br/backup-and-restore-overview.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复概述 summary: 了解不同场景下如何使用 TiDB 的备份与恢复功能，以及不同功能、版本间的兼容性。 --- -# TiDB 备份与恢复概述 +# 测试数据库备份与恢复概述 基于 Raft 协议和合理的部署拓扑规划，TiDB 实现了集群的高可用，当集群中少数节点挂掉时，集群依然能对外提供服务。在此基础上，为了更进一步保证用户数据的安全，TiDB 还提供了集群的备份与恢复 (Backup & Restore, BR) 功能，作为数据安全的最后一道防线，使得集群能够免于严重的自然灾害，提供业务误操作“复原”的能力。 diff --git a/br/backup-and-restore-use-cases.md b/br/backup-and-restore-use-cases.md index 11d9894cb370..a71db907a203 100644 --- a/br/backup-and-restore-use-cases.md +++ b/br/backup-and-restore-use-cases.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复实践示例 summary: 介绍 TiDB 备份与恢复的具体使用示例，包括推荐环境配置、存储配置、备份策略及如何进行备份与恢复。 --- -# TiDB 备份与恢复实践示例 +# 测试数据库备份与恢复实践示例 [TiDB 快照备份与恢复使用指南](/br/br-snapshot-guide.md)及 [TiDB 日志备份与 PITR 使用指南](/br/br-pitr-guide.md)系统介绍了 TiDB 提供的备份与恢复方案，即快照（全量）备份与恢复、日志备份和恢复到指定时间点 (Point-in-time recovery, PITR)。本文档将基于具体的使用场景，介绍如何快速上手使用 TiDB 的备份与恢复方案。 @@ -14,7 +14,7 @@ summary: 介绍 TiDB 备份与恢复的具体使用示例，包括推荐环境 通过 TiDB 提供的 PITR 功能，你可以满足业务团队的需求。 -## 部署 TiDB 集群和 br 命令行工具 +## 部署测试数据库集群和 br 命令行工具 使用 PITR 功能，需要部署 v6.2.0 或以上版本的 TiDB 集群，并且更新 br 命令行工具到与 TiDB 集群相同的版本，本文假设使用的是 v8.5.0 版本。 diff --git a/br/br-incremental-guide.md b/br/br-incremental-guide.md index 57644c845957..183b61a40797 100644 --- a/br/br-incremental-guide.md +++ b/br/br-incremental-guide.md @@ -3,7 +3,7 @@ title: TiDB 增量备份与恢复使用指南 summary: 了解 TiDB 的增量备份与恢复功能使用。 --- -# TiDB 增量备份与恢复使用指南 +# 测试数据库增量备份与恢复使用指南 TiDB 集群增量数据包含在某个时间段的起始和结束两个快照的变化差异的数据，以及之间的 DDL。增量备份的数据相对比全量备份数据而言数据量更小，适合配合快照备份一起使用，减少备份的数据量。进行增量备份的时候，需要保证备份时间范围内的多版本数据没有被 [TiDB GC 机制](/garbage-collection-overview.md)回收。例如，每个小时进行一次增量备份，则需要[调整 TiDB 集群的 GC Lifetime 设置](/system-variables.md#tidb_gc_life_time-从-v50-版本开始引入)至少大于 1 小时。 diff --git a/br/br-log-architecture.md b/br/br-log-architecture.md index 9e3eed959724..82f071b574a7 100644 --- a/br/br-log-architecture.md +++ b/br/br-log-architecture.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 功能架构 summary: 了解 TiDB 的日志备份与 PITR 的架构设计。 --- -# TiDB 日志备份与 PITR 功能架构 +# 测试数据库日志备份与 PITR 功能架构 本文以使用 BR 工具进行备份与恢复为例，介绍 TiDB 集群日志备份与 Point-in-time recovery (PITR) 的架构设计与流程。 diff --git a/br/br-pitr-guide.md b/br/br-pitr-guide.md index e4eb1e10d8f0..7e07299f4397 100644 --- a/br/br-pitr-guide.md +++ b/br/br-pitr-guide.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 使用指南 summary: 了解 TiDB 的日志备份与 PITR 功能使用。 --- -# TiDB 日志备份与 PITR 使用指南 +# 测试数据库日志备份与 PITR 使用指南 全量备份包含集群某个时间点的全量数据，但是不包含其他时间点的更新数据，而 TiDB 日志备份能够将业务写入 TiDB 的数据记录及时备份到指定存储中。如果你需要灵活的选择恢复的时间点，即实现 Point-in-time recovery (PITR)，可以开启[日志备份](#开启日志备份)，并[定期执行快照（全量）备份](#定期执行全量备份)。 diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index df3bb468b7d4..2b916f0f6656 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -3,7 +3,7 @@ title: TiDB 日志备份与 PITR 命令行手册 summary: 介绍 TiDB 日志备份与 PITR 的命令行。 --- -# TiDB 日志备份与 PITR 命令行手册 +# 测试数据库日志备份与 PITR 命令行手册 本文介绍 TiDB 日志备份和 PITR (Point-in-time recovery) 命令行。 diff --git a/br/br-snapshot-architecture.md b/br/br-snapshot-architecture.md index 800a8e34ab1e..b65b1b86dae2 100644 --- a/br/br-snapshot-architecture.md +++ b/br/br-snapshot-architecture.md @@ -3,7 +3,7 @@ title: TiDB 快照备份与恢复功能架构 summary: 了解 TiDB 快照备份与恢复功能的架构设计。 --- -# TiDB 快照备份与恢复功能架构 +# 测试数据库快照备份与恢复功能架构 本文以使用 BR 工具进行备份与恢复为例，介绍 TiDB 集群快照数据备份和恢复的架构设计与流程。 diff --git a/br/br-snapshot-guide.md b/br/br-snapshot-guide.md index 09f700cefd94..392036d53284 100644 --- a/br/br-snapshot-guide.md +++ b/br/br-snapshot-guide.md @@ -3,7 +3,7 @@ title: TiDB 快照备份与恢复使用指南 summary: 了解如何使用 br 命令行工具进行 TiDB 快照备份与恢复。 --- -# TiDB 快照备份与恢复使用指南 +# 测试数据库快照备份与恢复使用指南 本文介绍如何使用 br 命令行工具进行 TiDB 快照备份和恢复。使用前，请先[安装 br 命令行工具](/br/br-use-overview.md#部署和使用-br)。 diff --git a/br/br-snapshot-manual.md b/br/br-snapshot-manual.md index 73da418d22e7..d9e58629e409 100644 --- a/br/br-snapshot-manual.md +++ b/br/br-snapshot-manual.md @@ -3,12 +3,12 @@ title: TiDB 快照备份与恢复命令行手册 summary: 介绍备份与恢复 TiDB 集群快照的命令行。 --- -# TiDB 快照备份与恢复命令行手册 +# 测试数据库快照备份与恢复命令行手册 本文按备份恢复的场景介绍快照备份和恢复的命令行，包括： - [备份集群快照](#备份集群快照) -- [备份 TiDB 集群指定库表的数据](#备份-tidb-集群指定库表的数据) +- [备份测试数据库集群指定库表的数据](#备份测试数据库集群指定库表的数据) - [备份单个数据库的数据](#备份单个数据库的数据) - [备份单张表的数据](#备份单张表的数据) - [使用表库过滤功能备份多张表的数据](#使用表库过滤功能备份多张表的数据) @@ -57,7 +57,7 @@ tiup br backup full \ Full Backup <---------/................................................> 17.12%. ``` -## 备份 TiDB 集群指定库表的数据 +## 备份测试数据库集群指定库表的数据 br 工具支持只备份集群快照和增量数据中指定库或表的局部数据。在快照备份和增量数据备份的基础上，该功能可过滤掉不需要的数据，只备份关键业务的数据。 diff --git a/br/br-use-overview.md b/br/br-use-overview.md index aa260efd00cd..767f9c46ce4d 100644 --- a/br/br-use-overview.md +++ b/br/br-use-overview.md @@ -3,7 +3,7 @@ title: TiDB 备份与恢复功能使用概述 summary: 了解如何部署和使用 TiDB 集群的备份与恢复。 --- -# TiDB 备份与恢复功能使用概述 +# 测试数据库备份与恢复功能使用概述 本文介绍使用 TiDB 备份与恢复功能的最佳实践，包括如何选择备份方案、如何管理备份数据，以及如何安装和部署备份恢复工具。 diff --git a/cached-tables.md b/cached-tables.md index 5d9d88abbdf9..33d840d241c3 100644 --- a/cached-tables.md +++ b/cached-tables.md @@ -217,7 +217,7 @@ Query OK, 0 rows affected (0.00 sec) 目前 TiDB 对于每张缓存表的大小限制为 64 MB。如果表的数据超过了 64 MB，执行 `ALTER TABLE t CACHE` 会失败。 -## 与其他 TiDB 功能的兼容性限制 +## 与其他测试数据库功能的兼容性限制 以下是缓存表不支持的功能： @@ -232,7 +232,7 @@ Query OK, 0 rows affected (0.00 sec) - 设置系统变量 `tidb_snapshot` 读取历史数据 - 执行修改操作期间，已有缓存会失效，直到数据被再次加载 -## TiDB 数据迁移工具兼容性 +## 测试数据库数据迁移工具兼容性 缓存表并不是标准的 MySQL 功能，而是 TiDB 扩展。只有 TiDB 能识别 `ALTER TABLE ... CACHE` 语句。所有的 TiDB 数据迁移工具均不支持缓存表功能，包括 Backup & Restore (BR)、TiCDC、Dumpling 等组件，它们会将缓存表当作普通表处理。 diff --git a/certificate-authentication.md b/certificate-authentication.md index ecac63f38f61..e46ad7ac70d4 100644 --- a/certificate-authentication.md +++ b/certificate-authentication.md @@ -3,7 +3,7 @@ title: TiDB 证书鉴权使用指南 summary: 了解使用 TiDB 的证书鉴权功能。 --- -# TiDB 证书鉴权使用指南 +# 测试数据库证书鉴权使用指南 TiDB 支持基于证书鉴权的登录方式。采用这种方式，TiDB 对不同用户签发证书，使用加密连接来传输数据，并在用户登录时验证证书。相比 MySQL 用户常用的用户名密码验证方式，与 MySQL 相兼容的证书鉴权方式更安全，因此越来越多的用户使用证书鉴权来代替用户名密码验证。 @@ -212,11 +212,11 @@ server-cert.pem: OK client-cert.pem: OK ``` -## 配置 TiDB 和客户端使用证书 +## 配置测试数据库和客户端使用证书 在生成证书后，需要在 TiDB 中配置服务端所使用的证书，同时让客户端程序使用客户端证书。 -### 配置 TiDB 服务端 +### 配置测试数据库服务端 修改 TiDB 配置文件中的 `[security]` 段。这一步指定 CA 证书、服务端密钥和服务端证书存放的路径。可将 `path/to/server-cert.pem`、`path/to/server-key.pem` 和 `path/to/ca-cert.pem` 替换成实际的路径。 @@ -487,7 +487,7 @@ CA 证书是客户端和服务端相互校验的依据，所以如果需要替 sudo openssl x509 -req -in server-req.new.pem -days 365000 -CA ca-cert.pem -CAkey ca-key.pem -set_serial 01 -out server-cert.new.pem ``` -3. 配置 TiDB 使用上面新生成的服务端密钥和证书并重启。参见[配置 TiDB 服务端](#配置-tidb-服务端)。 +3. 配置 TiDB 使用上面新生成的服务端密钥和证书并重启。参见[配置测试数据库服务端](#配置测试数据库服务端)。 ## 基于策略的证书访问控制 diff --git a/character-set-and-collation.md b/character-set-and-collation.md index eda681ab7b80..4b4a2cfb4471 100644 --- a/character-set-and-collation.md +++ b/character-set-and-collation.md @@ -142,7 +142,7 @@ SHOW COLLATION WHERE Charset = 'utf8mb4'; TiDB 对 GBK 字符集的支持详情见 [GBK](/character-set-gbk.md)。 -## TiDB 中的 `utf8` 和 `utf8mb4` +## 测试数据库中的 `utf8` 和 `utf8mb4` MySQL 限制字符集 `utf8` 为最多 3 个字节。这足以存储在基本多语言平面 (BMP) 中的字符，但不足以存储表情符号 (emoji) 等字符。因此，建议改用字符集`utf8mb4`。 diff --git a/check-before-deployment.md b/check-before-deployment.md index cb4348d8f5b9..8a2b930290d6 100644 --- a/check-before-deployment.md +++ b/check-before-deployment.md @@ -3,7 +3,7 @@ title: TiDB 环境与系统配置检查 summary: 了解部署 TiDB 前的环境检查操作。 --- -# TiDB 环境与系统配置检查 +# 测试数据库环境与系统配置检查 本文介绍部署 TiDB 前的环境检查操作，以下各项操作按优先级排序。 diff --git a/clinic/clinic-collect-sql-query-plan.md b/clinic/clinic-collect-sql-query-plan.md index cc095633c149..8ed34b6a82b9 100644 --- a/clinic/clinic-collect-sql-query-plan.md +++ b/clinic/clinic-collect-sql-query-plan.md @@ -117,6 +117,6 @@ roles = [ diag collect --profile= --explain-sql= ``` -### 将结果导入到 TiDB 集群 +### 将结果导入到测试数据库集群 采集结果中的 `plan_replayer.zip` 可以通过 `PLAN REPLAYER LOAD` 语句直接导入到 TiDB 集群中进行信息查看，具体方法可参考[使用 `PLAN REPLAYER` 导入集群信息](/sql-plan-replayer.md#使用-plan-replayer-导入集群信息) diff --git a/clinic/clinic-data-instruction-for-tiup.md b/clinic/clinic-data-instruction-for-tiup.md index f06d1a5bd525..1d82f4a4b57c 100644 --- a/clinic/clinic-data-instruction-for-tiup.md +++ b/clinic/clinic-data-instruction-for-tiup.md @@ -14,18 +14,18 @@ Clinic Server 是部署在云端的云服务，根据数据存储的位置不同 - [Clinic Server 中国区](https://clinic.pingcap.com.cn)：如果你把采集的数据上传到了 Clinic Server 中国区，这些数据将存储于 PingCAP 设立在 AWS 中国区（北京）的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。 - [Clinic Server 美国区](https://clinic.pingcap.com)：如果你把采集的数据上传到了 Clinic Server 美国区，这些数据将存储于 PingCAP 设立在 AWS 美国区的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。 -## TiDB 集群 +## 测试数据库集群 本节列出了 [Diag](https://github.com/pingcap/diag) 在使用 TiUP 部署的 TiDB 集群中能够采集的诊断数据类型。 -### TiDB 集群信息 +### 测试数据库集群信息 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | | 集群基础信息，包括集群 ID | `cluster.json` | 每次收集默认采集 | | 集群详细信息 | `meta.yaml` | 每次收集默认采集 | -### TiDB 诊断数据 +### 测试数据库诊断数据 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | @@ -80,7 +80,7 @@ Clinic Server 是部署在云端的云服务，根据数据存储的位置不同 | 所有的 Metrics 数据 | `{metric_name}.json` | `--include=monitor` | | Alert 列表 | `alerts.json` | `--include=monitor` | -### TiDB 系统变量 +### 测试数据库系统变量 | 诊断数据类型 | 输出文件 | PingCAP Clinic 采集参数 | | :------ | :------ |:-------- | diff --git a/clinic/clinic-user-guide-for-tiup.md b/clinic/clinic-user-guide-for-tiup.md index 916cd028ec9a..c4d947df0a1a 100644 --- a/clinic/clinic-user-guide-for-tiup.md +++ b/clinic/clinic-user-guide-for-tiup.md @@ -119,7 +119,7 @@ summary: 详细介绍在使用 TiUP 部署的 TiDB 集群或 DM 集群上如何 4. 开启日志脱敏配置（可选步骤）。 - TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#tidb-组件日志脱敏)。 + TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#测试数据库组件日志脱敏)。 ## 远程定位集群问题 diff --git a/clinic/quick-start-with-clinic.md b/clinic/quick-start-with-clinic.md index f746e87ab9d4..0fac2dead1e1 100644 --- a/clinic/quick-start-with-clinic.md +++ b/clinic/quick-start-with-clinic.md @@ -104,7 +104,7 @@ PingCAP Clinic 由 [Diag 诊断客户端](https://github.com/pingcap/diag)（以 6. 开启日志脱敏配置（可选步骤）。 - TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#tidb-组件日志脱敏)。 + TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#测试数据库组件日志脱敏)。 ## 体验步骤 diff --git a/clustered-indexes.md b/clustered-indexes.md index a48325ae9fb9..2b0c2f8221e5 100644 --- a/clustered-indexes.md +++ b/clustered-indexes.md @@ -171,7 +171,7 @@ TiDB v5.0 完成了所有类型主键的支持，但默认行为与 TiDB v3.0 TiDB 支持使用可执行注释的语法来包裹 `CLUSTERED` 或 `NONCLUSTERED` 关键字，且 `SHOW CREATE TABLE` 的结果均包含 TiDB 特有的可执行注释，这些注释在 MySQL 或低版本的 TiDB 中会被忽略。 -### TiDB 数据迁移工具兼容性 +### 测试数据库数据迁移工具兼容性 聚簇索引仅与 v5.0 及以后版本的以下数据迁移工具兼容： @@ -180,7 +180,7 @@ TiDB 支持使用可执行注释的语法来包裹 `CLUSTERED` 或 `NONCLUSTERED v5.0 的 BR 不能通过备份恢复将非聚簇索引表转换成聚簇索引表，反之亦然。 -### 与 TiDB 其他特性的兼容性 +### 与测试数据库其他特性的兼容性 在非单整数列作为主键的表中，从非聚簇索引变为聚簇索引之后，在 v5.0 之前版本的 TiDB 能够执行的 `SPLIT TABLE BY/BETWEEN` 语句在 v5.0 及以后版本的 TiDB 上不再可用，原因是行数据键的构成发生了变化。在聚簇索引表上执行 `SPLIT TABLE BY/BETWEEN` 时需要依据主键列指定值，而不是指定一个整数值。例如： diff --git a/command-line-flags-for-tidb-configuration.md b/command-line-flags-for-tidb-configuration.md index c57f49cf029b..1377327d266a 100644 --- a/command-line-flags-for-tidb-configuration.md +++ b/command-line-flags-for-tidb-configuration.md @@ -3,7 +3,7 @@ title: TiDB 配置参数 summary: TiDB 配置参数包括启动参数和环境变量。启动参数包括 advertise-address、config、config-check、config-strict、cors 等。其中默认端口为 4000 和 10080。其他参数包括 log-file、metrics-addr、metrics-interval 等。注意配置文件的有效性和安全模式下的启动。 --- -# TiDB 配置参数 +# 测试数据库配置参数 在启动 TiDB 时，你可以使用命令行参数或环境变量来配置 TiDB。 diff --git a/comment-syntax.md b/comment-syntax.md index 4130d2564883..cf909107a205 100644 --- a/comment-syntax.md +++ b/comment-syntax.md @@ -121,7 +121,7 @@ TiDB 也跟 MySQL 保持一致，支持一种 C 风格注释的变体： 如果注释中指定了 Server 版本号，例如 `/*!50110 KEY_BLOCK_SIZE=1024 */`，在 MySQL 中表示只有 MySQL 的版本大于等于 5.1.10 才会处理这个 comment 中的内容。但是在 TiDB 中，这个 MySQL 版本号不会起作用，所有的 comment 都被会处理。 -## TiDB 可执行的注释语法 +## 测试数据库可执行的注释语法 TiDB 也有独立的注释语法，称为 TiDB 可执行注释语法。主要分为两种： diff --git a/configure-memory-usage.md b/configure-memory-usage.md index 14dda46a8405..51d81a1b439a 100644 --- a/configure-memory-usage.md +++ b/configure-memory-usage.md @@ -3,7 +3,7 @@ title: TiDB 内存控制文档 summary: TiDB 内存控制文档介绍了如何追踪和控制 SQL 查询过程中的内存使用情况，以及配置内存使用阈值和 tidb-server 实例的内存使用阈值。还介绍了使用 INFORMATION_SCHEMA 系统表查看内存使用情况，以及降低写入事务内存使用的方法。另外还介绍了流量控制和数据落盘的内存控制策略，以及通过设置环境变量 GOMEMLIMIT 缓解 OOM 问题。 --- -# TiDB 内存控制文档 +# 测试数据库内存控制文档 目前 TiDB 已经能够做到追踪单条 SQL 查询过程中的内存使用情况，当内存使用超过一定阈值后也能采取一些操作来预防 OOM 或者排查 OOM 原因。你可以使用系统变量 [`tidb_mem_oom_action`](/system-variables.md#tidb_mem_oom_action-从-v610-版本开始引入) 来控制查询超过内存限制后所采取的操作： diff --git a/credits.md b/credits.md index 906d0eae7277..8537d356b243 100644 --- a/credits.md +++ b/credits.md @@ -3,11 +3,11 @@ title: TiDB 社区荣誉列表 summary: 了解 TiDB 社区贡献者列表及角色。 --- -# TiDB 社区荣誉列表 +# 测试数据库社区荣誉列表 每一位贡献者都是推动 TiDB 健壮发展的重要成员，我们感谢所有为 TiDB 提交代码、撰写或翻译文档的贡献者。 -## TiDB 开发者 +## 测试数据库开发者 TiDB 开发者为 TiDB 的新功能开发、性能优化、稳定性保障做出了贡献。以下链接包含了 TiDB 相关 repo 的贡献者名单： @@ -25,7 +25,7 @@ TiDB 开发者为 TiDB 的新功能开发、性能优化、稳定性保障做出 - [tidb-incubator/TiBigData](https://github.com/tidb-incubator/TiBigData/graphs/contributors) - [ti-community-infra](https://github.com/orgs/ti-community-infra/people) -## TiDB 文档写作者和译员 +## 测试数据库文档写作者和译员 TiDB 文档写作者和译员为 TiDB 及相关项目撰写文档、提供翻译。以下链接包含了 TiDB 文档相关 repo 的贡献者名单： diff --git a/dashboard/dashboard-diagnostics-report.md b/dashboard/dashboard-diagnostics-report.md index 8f31ed10328e..73e42da66150 100644 --- a/dashboard/dashboard-diagnostics-report.md +++ b/dashboard/dashboard-diagnostics-report.md @@ -216,7 +216,7 @@ TiDB 内置自动诊断的结果，具体各字段含义以及介绍可以参考 这部分包括了 TiDB/PD/TiKV 更多的具体的监控信息。 -#### TiDB 相关监控信息 +#### 测试数据库相关监控信息 ##### Time Consumed by TiDB Component diff --git a/dashboard/dashboard-ops-security.md b/dashboard/dashboard-ops-security.md index 4c921d52d7b9..6ce2a988ec9f 100644 --- a/dashboard/dashboard-ops-security.md +++ b/dashboard/dashboard-ops-security.md @@ -7,7 +7,7 @@ summary: TiDB Dashboard 需要提高安全性。建议为 `root` 用户设置强 尽管访问 TiDB Dashboard 需要登录，但它被设计为默认供可信的用户实体访问。当你希望将 TiDB Dashboard 提供给外部网络用户或不可信用户访问时，需要注意采取以下措施以避免安全漏洞。 -## 提高 TiDB 用户安全性 +## 提高测试数据库用户安全性 ### 为 `root` 用户设置强密码 diff --git a/ddl-introduction.md b/ddl-introduction.md index 32d810258406..bca75f3dfc51 100644 --- a/ddl-introduction.md +++ b/ddl-introduction.md @@ -60,7 +60,7 @@ ADMIN SHOW DDL; 1 row in set (0.00 sec) ``` -### TiDB 在线 DDL 异步变更的原理 +### 测试数据库在线 DDL 异步变更的原理 TiDB DDL 模块从设计之初就选择了在线异步变更的模式，为 TiDB 的用户提供了不停机变更业务的服务能力。 diff --git a/deploy-monitoring-services.md b/deploy-monitoring-services.md index 4e5724b53e95..ead88d8795ec 100644 --- a/deploy-monitoring-services.md +++ b/deploy-monitoring-services.md @@ -3,7 +3,7 @@ title: 集群监控部署 summary: 本文适用于手动部署 TiDB 监控报警系统的用户。假设 TiDB 的拓扑结构如下：Node1 主机 IP 为 192.168.199.113，服务包括 PD1、TiDB、node_export、Prometheus、Grafana；Node2 主机 IP 为 192.168.199.114，服务包括 PD2、node_export；Node3 主机 IP 为 192.168.199.115，服务包括 PD3、node_export；Node4 主机 IP 为 192.168.199.116，服务包括 TiKV1、node_export；Node5 主机 IP 为 192.168.199.117，服务包括 TiKV2、node_export；Node6 主机 IP 为 192.168.199.118，服务包括 TiKV3、node_export。具体部署步骤包括下载二进制包、启动 node_exporter 服务、启动 Prometheus 服务、启动 Grafana 服务、配置 Grafana 数据源和导入 Grafana 面板。可查看 TiDB Server、PD Server 和 TiKV Server 的监控信息。 --- -# TiDB 集群监控部署 +# 测试数据库集群监控部署 本文档适用于希望手动部署 TiDB 监控报警系统的用户。TiUP 部署方式，会同时自动部署监控报警系统，无需手动部署。 diff --git a/develop/dev-guide-build-cluster-in-cloud.md b/develop/dev-guide-build-cluster-in-cloud.md index 5caf762868f6..2ecd778962af 100644 --- a/develop/dev-guide-build-cluster-in-cloud.md +++ b/develop/dev-guide-build-cluster-in-cloud.md @@ -5,7 +5,7 @@ summary: 使用 TiDB Cloud Serverless 构建 TiDB 集群，并连接 TiDB Cloud -# 使用 TiDB Cloud Serverless 构建 TiDB 集群 +# 使用 TiDB Cloud Serverless 构建测试数据库集群 本文将介绍如何以最快的方式开始使用 TiDB。你将创建并启动一个 [TiDB Cloud Serverless](https://www.pingcap.com/tidb-serverless/) 集群，使用 TiDB SQL 客户端，插入数据。随后将从示例程序读取出数据。 diff --git a/develop/dev-guide-overview.md b/develop/dev-guide-overview.md index 0cc72ac21562..e846a412257d 100644 --- a/develop/dev-guide-overview.md +++ b/develop/dev-guide-overview.md @@ -11,15 +11,15 @@ summary: 整体叙述了开发者手册，罗列了开发者手册的大致脉 此外，你还可以通过视频的形式学习免费的 [TiDB SQL 开发在线课程](https://cn.pingcap.com/courses-catalog/category/back-end-developer/?utm_source=docs-cn-dev-guide)。 -## TiDB 基础 +## 测试数据库基础 在你开始使用 TiDB 之前，你需要了解一些关于 TiDB 数据库的一些重要工作机制： - 阅读 [TiDB 事务概览](/transaction-overview.md)来了解 TiDB 的事务运作方式或查看[为应用开发程序员准备的事务说明](/develop/dev-guide-transaction-overview.md)查看应用开发程序员需要了解的事务部分。 - 学习免费在线课程 [TiDB 架构与特点](https://learn.pingcap.com/learner/course/600003/?utm_source=docs-cn-dev-guide)，了解构建 TiDB 分布式数据库集群的核心组件及其概念。 -- 了解[应用程序与 TiDB 交互的方式](#应用程序与-tidb-交互的方式)。 +- 了解[应用程序与测试数据库交互的方式](#应用程序与测试数据库交互的方式)。 -## TiDB 事务机制 +## 测试数据库事务机制 TiDB 支持分布式事务，而且提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。TiDB 当前版本中默认采用 **悲观事务** 模式，这让你在 TiDB 事务时可以像使用传统的单体数据库 (如: MySQL) 事务一样。 @@ -29,7 +29,7 @@ TiDB 会为你保证 `BEGIN` 开始到 `COMMIT` 或 `ROLLBACK` 结束间的所 若你不清楚**乐观事务**是什么，请暂时不要使用它。因为使用**乐观事务**的前提是需要应用程序可以正确的处理 `COMMIT` 语句所返回的[所有错误](/error-codes.md)。如果不确定应用程序如何处理，请直接使用**悲观事务**。 -## 应用程序与 TiDB 交互的方式 +## 应用程序与测试数据库交互的方式 TiDB 高度兼容 MySQL 协议，TiDB 支持[大多数 MySQL 的语法及特性](/mysql-compatibility.md)，因此大部分的 MySQL 的连接库都与 TiDB 兼容。如果你的应用程序框架或语言无 PingCAP 的官方适配，那么建议你使用 MySQL 的客户端库。同时，也有越来越多的三方数据库主动支持 TiDB 的差异特性。 diff --git a/develop/dev-guide-proxysql-integration.md b/develop/dev-guide-proxysql-integration.md index 93f1b9d63cbe..afa74c0d1376 100644 --- a/develop/dev-guide-proxysql-integration.md +++ b/develop/dev-guide-proxysql-integration.md @@ -40,7 +40,7 @@ ProxySQL 的设计目标是快速、高效且易于使用。它完全兼容 MySQ 本节介绍如何在开发环境中将 TiDB 与 ProxySQL 集成。在满足[前提条件](#前提条件)的情况下，你可以根据 TiDB 集群类型选择以下选项之一开始集成 ProxySQL： - 选项 1：[集成 TiDB Cloud 与 ProxySQL](#选项-1-集成-tidb-cloud-与-proxysql) -- 选项 2：[集成本地部署的 TiDB 与 ProxySQL](#选项-2-集成本地部署的-tidb-与-proxysql) +- 选项 2：[集成本地部署的测试数据库与 ProxySQL](#选项-2-集成本地部署的测试数据库与-proxysql) ### 前提条件 @@ -350,7 +350,7 @@ systemctl start docker comment: ``` -#### 步骤 4. 通过 ProxySQL 连接到 TiDB 集群 +#### 步骤 4. 通过 ProxySQL 连接到测试数据库集群 1. 运行 `proxysql-connect.py` 连接到你的 TiDB 集群。该脚本将自动启动 MySQL 客户端并使用你在[步骤 2](#步骤-2-生成-proxysql-配置文件) 中指定的用户名和密码进行连接。 @@ -427,7 +427,7 @@ systemctl start docker -### 选项 2: 集成本地部署的 TiDB 与 ProxySQL +### 选项 2: 集成本地部署的测试数据库与 ProxySQL 在这个集成中，你将使用 [TiDB](https://hub.docker.com/r/pingcap/tidb) 和 [ProxySQL](https://hub.docker.com/r/proxysql/proxysql) 的 Docker 镜像设置环境。你也可以尝试[其他方式安装 TiDB](/quick-start-with-tidb.md)。 @@ -803,7 +803,7 @@ systemctl start docker > **注意：** > -> 以下步骤使用 TiDB 和 ProxySQL 的容器镜像配置查询规则。如果你还没有拉取这些镜像，请参考[集成本地部署的 TiDB 与 ProxySQL](#选项-2-集成本地部署的-tidb-与-proxysql) 部分的详细步骤。 +> 以下步骤使用 TiDB 和 ProxySQL 的容器镜像配置查询规则。如果你还没有拉取这些镜像，请参考[集成本地部署的测试数据库与 ProxySQL](#选项-2-集成本地部署的测试数据库与-proxysql) 部分的详细步骤。 1. 克隆 TiDB 和 ProxySQL 的集成示例代码仓库 [`pingcap-inc/tidb-proxysql-integration`](https://github.com/pingcap-inc/tidb-proxysql-integration)。如果你已经在前面的步骤中克隆了它，请跳过这一步。 diff --git a/develop/dev-guide-third-party-support.md b/develop/dev-guide-third-party-support.md index bd5386062a53..37eaca4328c4 100644 --- a/develop/dev-guide-third-party-support.md +++ b/develop/dev-guide-third-party-support.md @@ -3,7 +3,7 @@ title: TiDB 支持的第三方工具 summary: TiDB 支持的第三方工具主要包括驱动、ORM 框架和 GUI。支持等级分为 Full 和 Compatible，其中 Full 表示绝大多数功能兼容性已得到支持，Compatible 表示大部分功能可使用但未经完整验证。对于支持的 Driver 或 ORM 框架并不包括应用端事务重试和错误处理。如果在使用工具连接 TiDB 时出现问题，可在 GitHub 上提交包含详细信息的 issue 以获得进展。 --- -# TiDB 支持的第三方工具 +# 测试数据库支持的第三方工具 > **注意：** > diff --git a/develop/dev-guide-third-party-tools-compatibility.md b/develop/dev-guide-third-party-tools-compatibility.md index fa9713bcd716..7a60ea887da4 100644 --- a/develop/dev-guide-third-party-tools-compatibility.md +++ b/develop/dev-guide-third-party-tools-compatibility.md @@ -22,7 +22,7 @@ summary: 介绍在测试中发现的 TiDB 与第三方工具的兼容性问题 ## 通用 -### TiDB 中 `SELECT CONNECTION_ID()` 返回结果类型为 64 位整型 +### 测试数据库中 `SELECT CONNECTION_ID()` 返回结果类型为 64 位整型 **描述** @@ -32,7 +32,7 @@ TiDB 中 `SELECT CONNECTION_ID()` 的返回值为 64 位，如 `2199023260887` 在 TiDB 应用程序中，请注意使用各语言的 64 位整型类型（或字符串类型）存储 `SELECT CONNECTION_ID()` 的结果，防止溢出。如 Java 应使用 `Long` 或 `String` 进行接收，JavaScript/TypeScript 应使用 `string` 类型进行接收。 -### TiDB 未设置 `Com_*` 计数器 +### 测试数据库未设置 `Com_*` 计数器 **描述** @@ -42,7 +42,7 @@ MySQL 维护了一系列 [`Com_` 开头的服务端变量](https://dev.mysql.com 请勿使用这样的变量。在 MySQL 中 `Com_*` 常见的使用场景之一是监控。TiDB 的可观测性较为完善，无需从服务端变量进行查询。如需定制监控工具，可阅读 [TiDB 监控框架概述](/tidb-monitoring-framework.md)来获得更多信息。 -### TiDB 错误日志区分 `TIMESTAMP` 与 `DATETIME` 类型 +### 测试数据库错误日志区分 `TIMESTAMP` 与 `DATETIME` 类型 **描述** @@ -52,7 +52,7 @@ TiDB 错误日志区分 `TIMESTAMP` 与 `DATETIME`，而 MySQL 不区分，全 请勿使用错误日志进行字符串匹配，要使用[错误码](/error-codes.md)进行故障诊断。 -### TiDB 不支持 `CHECK TABLE` 语句 +### 测试数据库不支持 `CHECK TABLE` 语句 **描述** diff --git a/develop/dev-guide-tidb-crud-sql.md b/develop/dev-guide-tidb-crud-sql.md index 2108dd10e104..d17aeae84abd 100644 --- a/develop/dev-guide-tidb-crud-sql.md +++ b/develop/dev-guide-tidb-crud-sql.md @@ -3,7 +3,7 @@ title: 使用 TiDB 的增删改查 SQL summary: 简单介绍 TiDB 的增删改查 SQL。 --- -# 使用 TiDB 的增删改查 SQL +# 使用测试数据库的增删改查 SQL 本章将简单介绍 TiDB 的增删改查 SQL 的使用方法。 diff --git a/develop/dev-guide-timeouts-in-tidb.md b/develop/dev-guide-timeouts-in-tidb.md index daaac2d24d6f..87e06325ba91 100644 --- a/develop/dev-guide-timeouts-in-tidb.md +++ b/develop/dev-guide-timeouts-in-tidb.md @@ -3,7 +3,7 @@ title: TiDB 中的各种超时 summary: 简单介绍 TiDB 中的各种超时，为排查错误提供依据。 --- -# TiDB 中的各种超时 +# 测试数据库中的各种超时 本章将介绍 TiDB 中的各种超时，为排查错误提供依据。 diff --git a/develop/dev-guide-use-temporary-tables.md b/develop/dev-guide-use-temporary-tables.md index 4d449aa53a38..95f5d790e9cb 100644 --- a/develop/dev-guide-use-temporary-tables.md +++ b/develop/dev-guide-use-temporary-tables.md @@ -252,7 +252,7 @@ DROP GLOBAL TEMPORARY TABLE top_50_eldest_authors_global; ## 限制 -关于 TiDB 在临时表功能上的一些限制，你可以通过阅读参考文档中的[临时表与其他 TiDB 功能的兼容性限制](/temporary-tables.md#与其他-tidb-功能的兼容性限制)小节进行了解。 +关于 TiDB 在临时表功能上的一些限制，你可以通过阅读参考文档中的[临时表与其他测试数据库功能的兼容性限制](/temporary-tables.md#与其他测试数据库功能的兼容性限制)小节进行了解。 ## 扩展阅读 diff --git a/dm/dm-binlog-event-filter.md b/dm/dm-binlog-event-filter.md index 978a8058b58e..f64e116a4131 100644 --- a/dm/dm-binlog-event-filter.md +++ b/dm/dm-binlog-event-filter.md @@ -138,7 +138,7 @@ filters: action: Do ``` -### 过滤 TiDB 不支持的 SQL 语句 +### 过滤测试数据库不支持的 SQL 语句 可设置如下规则过滤 TiDB 不支持的 `PROCEDURE` 语句： diff --git a/dm/dm-enable-tls.md b/dm/dm-enable-tls.md index c3eb77aca5a5..06e1ea29d93e 100644 --- a/dm/dm-enable-tls.md +++ b/dm/dm-enable-tls.md @@ -107,9 +107,9 @@ DM-master、DM-worker 和 dmctl 都会在每次新建相互通讯的连接时重 ssl-key: "/path/to/mysql-client-key.pem" ``` -### 为下游 TiDB 连接开启加密传输 +### 为下游测试数据库连接开启加密传输 -1. 配置下游 TiDB 启用加密连接支持，具体可参考[配置 TiDB 启用加密连接支持](/enable-tls-between-clients-and-servers.md#配置-tidb-服务端启用安全连接) +1. 配置下游 TiDB 启用加密连接支持，具体可参考[配置测试数据库启用加密连接支持](/enable-tls-between-clients-and-servers.md#配置测试数据库服务端启用安全连接) 2. 在 task 配置文件中设置 TiDB Client 证书： diff --git a/dm/dm-faq.md b/dm/dm-faq.md index 2ef1af2067ba..ac91aa83b859 100644 --- a/dm/dm-faq.md +++ b/dm/dm-faq.md @@ -32,7 +32,7 @@ DM 会尝试将包含多个 DDL 变更操作的单条语句拆分成只包含一 > > TiDB 目前并不兼容 MySQL 支持的所有 DDL 语句。 -## DM 是否会将视图的 DDL 语句和对视图的 DML 语句同步到下游的 TiDB 中？ +## DM 是否会将视图的 DDL 语句和对视图的 DML 语句同步到下游的测试数据库中？ 目前 DM 不会将视图的 DDL 语句同步到下游的 TiDB 集群，也不会将针对视图的 DML 语句同步到下游。 diff --git a/dm/dm-task-configuration-guide.md b/dm/dm-task-configuration-guide.md index f66f3d83a5ab..43e30416d944 100644 --- a/dm/dm-task-configuration-guide.md +++ b/dm/dm-task-configuration-guide.md @@ -29,7 +29,7 @@ mysql-instances: - source-id: "mysql-replica-02" # 从 source-id = mysql-replica-02 的数据源迁移数据 ``` -## 配置迁移的目标 TiDB 集群 +## 配置迁移的目标测试数据库集群 仿照下面的 `target-database:` 示例定义迁移的目标 TiDB 集群。 @@ -119,7 +119,7 @@ target-database: # 目标 TiDB 配置 filter-rules: ["filter-rule-2"] # 过滤数据源特定操作的规则，可以配置多个过滤规则 ``` -## 配置需要数据源表到目标 TiDB 表的映射 +## 配置需要数据源表到目标测试数据库表的映射 如果不需要将数据源表路由到不同名的目标 TiDB 表，可以跳过该项配置。分库分表合并迁移的场景必须配置该规则。 diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index 446492b4782a..44166b3074f4 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -3,11 +3,11 @@ title: TiDB 工具下载 summary: 本文介绍如何下载 TiDB 工具包。TiDB 工具包包含常用工具如 Dumpling、TiDB Lightning、BR 等。如果部署环境能访问互联网，可直接通过 TiUP 命令一键部署所需的 TiDB 工具。操作系统需为 Linux，架构为 amd64 或 arm64。下载步骤包括访问 TiDB 社区版页面，找到 TiDB-community-toolkit 软件包并点击立即下载。注意，点击立即下载后默认下载当前 TiDB 的最新发布版本。根据要使用的工具选择安装对应的离线包。 --- -# TiDB 工具下载 +# 测试数据库工具下载 本文介绍如何下载 TiDB 工具包。关于 TiDB 工具包的内容，请查看 [TiDB 离线包](/binary-package.md)。 -## TiDB 工具包下载 +## 测试数据库工具包下载 TiDB 工具包中包含了一些常用的 TiDB 工具，例如数据导出工具 Dumpling、数据导入工具 TiDB Lightning、备份恢复工具 BR。 @@ -31,7 +31,7 @@ TiDB 工具包中包含了一些常用的 TiDB 工具，例如数据导出工具 > - 如需在 Kubernetes 上部署运维 TiDB，无需下载 TiDB-community-toolkit 软件包，请参考[离线安装 TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tidb-operator#离线安装-tidb-operator)。 > - 如需使用 [PD Control](/pd-control.md) 工具 `pd-ctl`，请下载 **TiDB-community-server 软件包**。 -### TiDB 工具包说明 +### 测试数据库工具包说明 在 TiDB 工具包中，你可以依据要使用的工具，选择安装对应的离线包。 diff --git a/dr-secondary-cluster.md b/dr-secondary-cluster.md index d25c6aefabb5..cdffb96c54df 100644 --- a/dr-secondary-cluster.md +++ b/dr-secondary-cluster.md @@ -22,7 +22,7 @@ summary: 了解如何使用 TiCDC 构建主备集群进行容灾。 同时，本文还介绍了如何在备用集群上进行业务查询，以及如何在主备集群间进行双向同步。 -## 基于 TiCDC 构建 TiDB 主备集群 +## 基于 TiCDC 构建测试数据库主备集群 ### 架构概览 @@ -64,7 +64,7 @@ summary: 了解如何使用 TiCDC 构建主备集群进行容灾。 部署 TiCDC 组件需要注意的是，Secondary Cluster 和 TiCDC 需要在一起部署和管理，并且它们之间的网络需要能够连通。 -- 如果需要在已有的 Primary Cluster 上部署 TiCDC，请参考[部署 TiCDC 组件](/ticdc/deploy-ticdc.md#使用-tiup-在原有-tidb-集群上新增或扩容-ticdc-组件)。 +- 如果需要在已有的 Primary Cluster 上部署 TiCDC，请参考[部署 TiCDC 组件](/ticdc/deploy-ticdc.md#使用-tiup-在原有测试数据库集群上新增或扩容-ticdc-组件)。 - 如果部署全新的 Primary Cluster 和 TiCDC 组件，则可以使用以下 TiUP 部署模版，并按照需要修改配置参数： ```yaml diff --git a/dr-solution-introduction.md b/dr-solution-introduction.md index ecdc783489d4..2c99cb8e3c75 100644 --- a/dr-solution-introduction.md +++ b/dr-solution-introduction.md @@ -3,7 +3,7 @@ title: TiDB 容灾方案概述 summary: 了解 TiDB 提供的几种容灾方案，包括基于主备集群的容灾、基于多副本的单集群容灾和基于备份与恢复的容灾。 --- -# TiDB 容灾方案概述 +# 测试数据库容灾方案概述 本文将以如下结构系统介绍 TiDB 容灾解决方案： @@ -28,7 +28,7 @@ summary: 了解 TiDB 提供的几种容灾方案，包括基于主备集群的 在介绍具体的容灾方案之前，本部分将从容灾角度介绍容灾系统中的组件架构，包括 TiDB、TiCDC 和 BR。 -### TiDB 架构 +### 测试数据库架构 ![TiDB architecture](/media/dr/tidb-architecture.png) diff --git a/dumpling-overview.md b/dumpling-overview.md index 8a8986bde7c4..2e3e4f5786cd 100644 --- a/dumpling-overview.md +++ b/dumpling-overview.md @@ -291,7 +291,7 @@ $ ls -lh /tmp/test | awk '{print $5 "\t" $9}' 190K test.sbtest3.0.sql ``` -### 导出 TiDB 的历史数据快照 +### 导出测试数据库的历史数据快照 Dumpling 可以通过 `--snapshot` 指定导出某个 [tidb_snapshot](/read-historical-data.md#操作流程) 的数据。 @@ -306,7 +306,7 @@ tiup dumpling --snapshot "2020-07-02 17:12:45" 即可导出 TSO 为 `417773951312461825` 或 `2020-07-02 17:12:45` 时的 TiDB 历史数据快照。 -### 控制导出 TiDB 大表（超过 1 TB）时的内存使用 +### 控制导出测试数据库大表（超过 1 TB）时的内存使用 Dumpling 导出 TiDB 较大单表（超过 1 TB）时，可能会因为导出数据过大导致 TiDB 内存溢出 (OOM)，从而使连接中断导出失败。可以通过以下参数减少 TiDB 的内存使用。 diff --git a/dynamic-config.md b/dynamic-config.md index 52cc175a566b..d54a2bc838fd 100644 --- a/dynamic-config.md +++ b/dynamic-config.md @@ -306,7 +306,7 @@ Query OK, 0 rows affected (0.01 sec) 具体配置项意义可参考 [PD 配置文件描述](/pd-configuration-file.md)。 -### 在线修改 TiDB 配置 +### 在线修改测试数据库配置 在线修改 TiDB 配置的方式和 TiKV/PD 有所不同，你可以通过修改[系统变量](/system-variables.md)来实现。 diff --git a/ecosystem-tool-user-case.md b/ecosystem-tool-user-case.md index be7939a4dcfb..5012a3fd1ed2 100644 --- a/ecosystem-tool-user-case.md +++ b/ecosystem-tool-user-case.md @@ -3,7 +3,7 @@ title: TiDB 工具的使用场景 summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 --- -# TiDB 工具的使用场景 +# 测试数据库工具的使用场景 本文档从数据迁移工具的使用场景出发，介绍部分常见场景下的迁移工具的选择。 @@ -29,7 +29,7 @@ summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 如果全量数据量较大（TB 级别），则可先使用 [Dumpling](/dumpling-overview.md) 与 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 完成全量数据的迁移，再使用 DM 完成增量数据的迁移。 -## TiDB 集群备份与恢复 +## 测试数据库集群备份与恢复 当需要对 TiDB 集群进行备份或在之后对 TiDB 集群进行恢复时，可使用 [BR](/br/backup-and-restore-overview.md)。 @@ -39,6 +39,6 @@ summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。 如果还需要执行增量数据的迁移，则可使用 [TiCDC](/ticdc/ticdc-overview.md)。 -## TiDB 增量数据订阅 +## 测试数据库增量数据订阅 当需要订阅 TiDB 增量数据的变更时，可使用 [TiCDC](/ticdc/ticdc-overview.md)。 diff --git a/ecosystem-tool-user-guide.md b/ecosystem-tool-user-guide.md index 3f593f406cfb..5d4831a53071 100644 --- a/ecosystem-tool-user-guide.md +++ b/ecosystem-tool-user-guide.md @@ -3,7 +3,7 @@ title: TiDB 工具功能概览 summary: TiDB 提供了丰富的工具，包括部署运维工具 TiUP 和 TiDB Operator，数据管理工具如 TiDB Data Migration（DM）、Dumpling、TiDB Lightning、Backup & Restore（BR）、TiCDC、sync-diff-inspector，以及 OLAP 分析工具 TiSpark。这些工具可用于部署、数据迁移、备份恢复、数据校验等多种操作，满足不同需求。 --- -# TiDB 工具功能概览 +# 测试数据库工具功能概览 TiDB 提供了丰富的工具，可以帮助你进行部署运维、数据管理（例如，数据迁移、备份恢复、数据校验）、在 TiKV 上运行 Spark SQL。请根据需要选择适用的工具。 @@ -110,7 +110,7 @@ TiDB 提供了 TiUP 和 TiDB Operator 部署运维工具，满足你在不同系 - 适用 TiDB 版本：v4.0 及以上 - Kubernetes 支持：[使用 BR 工具备份 TiDB 集群数据到兼容 S3 的存储](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/backup-to-aws-s3-using-br)，[使用 BR 工具恢复 S3 兼容存储上的备份数据](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/restore-from-aws-s3-using-br) -### TiDB 增量数据同步 - TiCDC +### 测试数据库增量数据同步 - TiCDC [TiCDC](/ticdc/ticdc-overview.md) 是一款通过拉取 TiKV 变更日志实现的 TiDB 增量数据同步工具，具有将数据还原到与上游任意 TSO 一致状态的能力，同时提供开放数据协议 (TiCDC Open Protocol)，支持其他系统订阅数据变更。 diff --git a/enable-disk-spill-encrypt.md b/enable-disk-spill-encrypt.md index 62c8b227830a..09e02a86bad8 100644 --- a/enable-disk-spill-encrypt.md +++ b/enable-disk-spill-encrypt.md @@ -3,7 +3,7 @@ title: 为 TiDB 落盘文件开启加密 summary: 了解如何为 TiDB 落盘文件开启加密。 --- -# 为 TiDB 落盘文件开启加密 +# 为测试数据库落盘文件开启加密 当系统变量 [`tidb_enable_tmp_storage_on_oom`](/system-variables.md#tidb_enable_tmp_storage_on_oom) 为 `ON` 时，如果单条 SQL 语句的内存使用超出系统变量 [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query) 的限制，某些算子可以将执行时的中间结果作为临时文件落盘保存，直到查询执行完成之后将它们删除。 diff --git a/enable-tls-between-clients-and-servers.md b/enable-tls-between-clients-and-servers.md index a83628f7fcc7..dc11bbba0e96 100644 --- a/enable-tls-between-clients-and-servers.md +++ b/enable-tls-between-clients-and-servers.md @@ -3,7 +3,7 @@ title: 为 TiDB 客户端服务端间通信开启加密传输 summary: TiDB 服务端与客户端间默认采用非加密连接，容易造成信息泄露。建议使用加密连接确保安全性。要开启 TLS 加密传输，需要在服务端配置开启 TLS 支持，并在客户端应用程序中配置使用 TLS 加密连接。可以通过配置系统变量或在创建 / 修改用户时指定要求加密连接。可通过命令检查当前连接是否是加密连接。TLS 版本为 TLSv1.2 和 TLSv1.3，支持的加密算法包括 AES 和 CHACHA20_POLY1305。 --- -# 为 TiDB 客户端服务端间通信开启加密传输 +# 为测试数据库客户端服务端间通信开启加密传输 默认情况下，TiDB 允许服务端与客户端之间的不安全连接，因而具备监视信道流量能力的第三方可以知悉 TiDB 服务端与客户端之间发送和接受的数据，包括但不限于查询语句内容、查询结果等。若信道是不可信的，例如客户端是通过公网连接到 TiDB 服务端的，则不安全连接容易造成信息泄露，建议使用 TLS 连接确保安全性。 @@ -30,7 +30,7 @@ TiDB 服务端支持启用基于 TLS（传输层安全）协议的安全连接 > > 如果登录用户已配置使用 [TiDB 证书鉴权功能](/certificate-authentication.md#配置登录时需要校验的用户证书信息)校验用户证书，也会隐式要求对应用户必须使用加密连接连接 TiDB。 -## 配置 TiDB 服务端启用安全连接 +## 配置测试数据库服务端启用安全连接 要启用安全连接，请参考以下相关参数说明： diff --git a/enable-tls-between-components.md b/enable-tls-between-components.md index eaff49b1b7b8..4b6fc182b84e 100644 --- a/enable-tls-between-components.md +++ b/enable-tls-between-components.md @@ -3,7 +3,7 @@ title: 为 TiDB 组件间通信开启加密传输 summary: 了解如何为 TiDB 集群内各组件间开启加密传输。 --- -# 为 TiDB 组件间通信开启加密传输 +# 为测试数据库组件间通信开启加密传输 本部分介绍如何为 TiDB 集群内各组件间开启加密传输。一旦开启，以下组件间均将使用加密传输： diff --git a/encryption-at-rest.md b/encryption-at-rest.md index aae5bc01d442..e4c3ad12b94d 100644 --- a/encryption-at-rest.md +++ b/encryption-at-rest.md @@ -11,7 +11,7 @@ summary: 了解如何启用静态加密功能保护敏感数据。 静态加密 (encryption at rest) 即在存储数据时进行数据加密。对于数据库，静态加密功能也叫透明数据加密 (TDE)，区别于传输数据加密 (TLS) 或使用数据加密（很少使用）。SSD 驱动器、文件系统、云供应商等都可进行静态加密。但区别于这些加密方式，若 TiKV 在存储数据前就进行数据加密，攻击者则必须通过数据库的身份验证才能访问数据。例如，即使攻击者获得物理机的访问权限时，也无法通过复制磁盘上的文件来访问数据。 -## 各 TiDB 组件支持的加密方式 +## 各测试数据库组件支持的加密方式 在一个 TiDB 集群中，不同的组件使用不同的加密方式。本节介绍 TiKV、 TiFlash、PD 和 Backup & Restore (BR) 等不同 TiDB 组件支持的加密方式。 diff --git a/error-codes.md b/error-codes.md index 4b895f966ccd..87f15b9514a4 100644 --- a/error-codes.md +++ b/error-codes.md @@ -133,7 +133,7 @@ TiDB 兼容 MySQL 的错误码，在大多数情况下，返回和 MySQL 一样 * Error Number: 8050 - 设置了不支持的权限类型，遇到该错误请参考 [TiDB 权限说明](/privilege-management.md#tidb-各操作需要的权限)进行调整。 + 设置了不支持的权限类型，遇到该错误请参考 [测试数据库权限说明](/privilege-management.md#测试数据库各操作需要的权限)进行调整。 * Error Number: 8051 diff --git a/explain-overview.md b/explain-overview.md index 0c1c6d806027..adef365160de 100644 --- a/explain-overview.md +++ b/explain-overview.md @@ -3,7 +3,7 @@ title: TiDB 执行计划概览 summary: 了解 TiDB 中 EXPLAIN 语句返回的执行计划。 --- -# TiDB 执行计划概览 +# 测试数据库执行计划概览 > **注意：** > diff --git a/faq/backup-and-restore-faq.md b/faq/backup-and-restore-faq.md index ff853ab2c954..a615798bf8b4 100644 --- a/faq/backup-and-restore-faq.md +++ b/faq/backup-and-restore-faq.md @@ -296,7 +296,7 @@ br restore full -f 'mysql.usertable' -s $external_storage_url --with-sys-table 这个情况多数是因为备份时集群的数据压缩比率和恢复时的默认值不一致导致的，只要恢复的 checksum 阶段顺利通过，可以忽略这个问题，不影响正常使用。 -### 使用 BR 恢复数据后是否需要对表执行 `ANALYZE` 以更新 TiDB 在表和索引上留下的统计信息？ +### 使用 BR 恢复数据后是否需要对表执行 `ANALYZE` 以更新测试数据库在表和索引上留下的统计信息？ BR 不会备份统计信息（v4.0.9 除外）。所以在恢复存档后需要手动执行 `ANALYZE TABLE` 或等待 TiDB 自动进行 `ANALYZE`。 diff --git a/faq/deploy-and-maintain-faq.md b/faq/deploy-and-maintain-faq.md index 12e8d36ae007..f84252b6618a 100644 --- a/faq/deploy-and-maintain-faq.md +++ b/faq/deploy-and-maintain-faq.md @@ -3,17 +3,17 @@ title: TiDB 安装部署常见问题 summary: 介绍 TiDB 集群安装部署的常见问题、原因及解决方法。 --- -# TiDB 安装部署常见问题 +# 测试数据库安装部署常见问题 本文介绍 TiDB 集群安装部署的常见问题、原因及解决方法。 ## 软硬件要求 FAQ -### TiDB 支持哪些操作系统？ +### 测试数据库支持哪些操作系统？ 关于 TiDB 支持的操作系统，参见[操作系统及平台要求](/hardware-and-software-requirements.md#操作系统及平台要求)。 -### TiDB 对开发、测试、生产环境的服务器硬件配置有什么要求？ +### 测试数据库对开发、测试、生产环境的服务器硬件配置有什么要求？ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器平台。对于开发、测试、生产环境的服务器硬件配置，参见[服务器配置要求](/hardware-and-software-requirements.md#服务器配置要求)。 @@ -25,7 +25,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 资源可接受的话，我们建议做 RAID 10，如果资源有限，也可以不做 RAID。 -### TiDB 集群各个组件的配置推荐？ +### 测试数据库集群各个组件的配置推荐？ - TiDB 需要 CPU 和内存比较好的机器，参考官网配置要求； - PD 里面存了集群元信息，会有频繁的读写请求，对磁盘 I/O 要求相对比较高，磁盘太差会影响整个集群性能，推荐 SSD 磁盘，空间不用太大。另外集群 Region 数量越多对 CPU、内存的要求越高； @@ -41,7 +41,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 这种情况一般是因为没有使用 `--config` 参数来指定配置文件（目前只会出现在 binary 部署的场景），TiKV/PD 会按默认值来设置。如果要使用配置文件，请设置 TiKV/PD 的 `--config` 参数。对于 TiKV 组件，修改配置后重启服务即可；对于 PD 组件，只会在第一次启动时读取配置文件，之后可以使用 pd-ctl 的方式来修改配置，详情可参考 [PD 配置参数](/command-line-flags-for-pd-configuration.md)。 -### TiDB 监控框架 Prometheus + Grafana 监控机器建议单独还是多台部署？ +### 测试数据库监控框架 Prometheus + Grafana 监控机器建议单独还是多台部署？ 监控机建议单独部署。建议 CPU 8 core，内存 16 GB 以上，硬盘 500 GB 以上。 @@ -73,7 +73,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 | enable_slow_query_log | TiDB 慢查询日志记录到单独文件({{ deploy_dir }}/log/tidb_slow_query.log)，默认为 False，记录到 tidb 日志 | | deploy_without_tidb | KV 模式，不部署 TiDB 服务，仅部署 PD、TiKV 及监控服务，请将 inventory.ini 文件中 tidb_servers 主机组 IP 设置为空。 | -### 如何单独记录 TiDB 中的慢查询日志，如何定位慢查询 SQL？ +### 如何单独记录测试数据库中的慢查询日志，如何定位慢查询 SQL？ 1. TiDB 中，对慢查询的定义在 TiDB 的配置文件中。`tidb_slow_log_threshold: 300`，这个参数是配置慢查询记录阈值的，单位是 ms。 @@ -81,7 +81,7 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器 3. 除了日志，还可以通过 `ADMIN SHOW SLOW` 命令查看，详情可参考 [`ADMIN SHOW SLOW` 命令](/identify-slow-queries.md#admin-show-slow-命令)。 -### 首次部署 TiDB 集群时，没有配置 tikv 的 Label 信息，在后续如何添加配置 Label？ +### 首次部署测试数据库集群时，没有配置 tikv 的 Label 信息，在后续如何添加配置 Label？ TiDB 的 Label 设置是与集群的部署架构相关的，是集群部署中的重要内容，是 PD 进行全局管理和调度的依据。如果集群在初期部署过程中没有设置 Label，需要在后期对部署结构进行调整，就需要手动通过 PD 的管理工具 pd-ctl 来添加 location-labels 信息，例如：`config set location-labels "zone,rack,host"`（根据实际的 label 层级名字配置）。 @@ -109,7 +109,7 @@ Direct 模式就是把写入请求直接封装成 I/O 指令发到磁盘，这 ./fio -ioengine=psync -bs=32k -fdatasync=1 -thread -rw=randrw -percentage_random=100,0 -size=10G -filename=fio_randread_write_test.txt -name='fio mixed randread and sequential write test' -iodepth=4 -runtime=60 -numjobs=4 -group_reporting --output-format=json --output=fio_randread_write_test.json ``` -## TiDB 支持在公有云上部署吗？ +## 测试数据库支持在公有云上部署吗？ TiDB 支持在 [Google Cloud GKE](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-gcp-gke)、[AWS EKS](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-aws-eks) 和[阿里云 ACK](https://docs.pingcap.com/zh/tidb-in-kubernetes/v1.1/deploy-on-alibaba-cloud) 上部署使用。 diff --git a/faq/faq-overview.md b/faq/faq-overview.md index eb4ab2f5cba6..1a6a56edfa13 100644 --- a/faq/faq-overview.md +++ b/faq/faq-overview.md @@ -3,7 +3,7 @@ title: TiDB 产品常见问题解答汇总 summary: 汇总 TiDB 产品的常见问题解答。 --- -# TiDB 产品常见问题解答汇总 +# 测试数据库产品常见问题解答汇总 本文整合汇总了 TiDB 使用过程中常见问题解答的 (FAQ) 文档。 diff --git a/faq/high-availability-faq.md b/faq/high-availability-faq.md index e636e9d03d5b..1f09123f09c6 100644 --- a/faq/high-availability-faq.md +++ b/faq/high-availability-faq.md @@ -7,12 +7,12 @@ summary: 介绍高可用相关的常见问题。 本文档介绍高可用相关的常见问题。 -## TiDB 数据是强一致的吗？ +## 测试数据库数据是强一致的吗？ 通过使用 [Raft 一致性算法](https://raft.github.io/)，数据在各 TiKV 节点间复制为多副本，以确保某个节点宕机时数据的安全性。 在底层，TiKV 使用复制日志 + 状态机 (State Machine) 的模型来复制数据。对于写入请求，数据被写入 Raft Leader，然后 Leader 以日志的形式将命令复制到它的 Follower 中。当集群中的大多数节点收到此日志时，日志会被提交，状态机会相应作出变更，以此来实现强一致。 -## TiDB 是否提供三中心跨机房多活部署的推荐方案？ +## 测试数据库是否提供三中心跨机房多活部署的推荐方案？ 从架构来看，TiDB 支持真正意义上的跨中心异地多活。从实现层面看，多地部署方案依赖数据中心之间的网络延迟和稳定性，一般建议延迟在 5ms 以下。目前 TiDB 已经有相似的客户部署方案，参见[两地三中心部署方案](/three-data-centers-in-two-cities-deployment.md)。 diff --git a/faq/high-reliability-faq.md b/faq/high-reliability-faq.md index f36d72f37ade..cdf30adb198a 100644 --- a/faq/high-reliability-faq.md +++ b/faq/high-reliability-faq.md @@ -7,11 +7,11 @@ summary: 介绍高可靠相关的常见问题。 本文档介绍高可靠相关的常见问题。 -## TiDB 是否支持数据加密？ +## 测试数据库是否支持数据加密？ 支持。要加密传输中的数据，可以[在 TiDB 客户端和服务器之间启用 TLS](/enable-tls-between-clients-and-servers.md)。要加密存储引擎中的数据，可以启用[透明数据加密 (TDE)](/encryption-at-rest.md)。 -## 我们的安全漏洞扫描工具对 MySQL version 有要求，TiDB 是否支持修改 server 版本号呢？ +## 我们的安全漏洞扫描工具对 MySQL version 有要求，测试数据库是否支持修改 server 版本号呢？ TiDB 在 v3.0.8 后支持通过 TiDB 配置文件中的 [`server-version`](/tidb-configuration-file.md#server-version) 配置项来修改 server 版本号。 @@ -25,7 +25,7 @@ server_configs: 修改完成后，使用 `tiup cluster reload -R tidb` 命令使得以上修改生效，以避免出现安全漏洞扫描不通过的问题。 -## TiDB 支持哪些认证协议？过程是怎样的？ +## 测试数据库支持哪些认证协议？过程是怎样的？ TiDB 和 MySQL 一样，在用户登录认证时使用 SASL 认证协议对密码进行处理。 diff --git a/faq/manage-cluster-faq.md b/faq/manage-cluster-faq.md index 394de80f24ee..f890cc004865 100644 --- a/faq/manage-cluster-faq.md +++ b/faq/manage-cluster-faq.md @@ -3,7 +3,7 @@ title: TiDB 集群管理常见问题 summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 --- -# TiDB 集群管理常见问题 +# 测试数据库集群管理常见问题 本文介绍管理 TiDB 集群时的常见问题、原因及解决方法。 @@ -11,7 +11,7 @@ summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 本小节介绍集群日程管理中的常见问题、原因及解决方法。 -### TiDB 如何登录？ +### 测试数据库如何登录？ 和 MySQL 登录方式一样，可以按照下面例子进行登录。 @@ -21,7 +21,7 @@ summary: 介绍 TiDB 集群管理的常见问题、原因及解决方法。 mysql -h 127.0.0.1 -uroot -P4000 ``` -### TiDB 如何修改数据库系统变量？ +### 测试数据库如何修改数据库系统变量？ 和 MySQL 一样，TiDB 也分为静态参数和固态参数，静态参数可以直接通过 `SET GLOBAL xxx = n` 的方式进行修改，不过新参数值只限于该实例生命周期有效。 @@ -29,11 +29,11 @@ mysql -h 127.0.0.1 -uroot -P4000 默认在 [`--data-dir`](/command-line-flags-for-tikv-configuration.md#--data-dir) 目录下，其中包括 backup、db、raft、snap 四个目录，分别存储备份、数据、raft 数据及镜像数据。 -### TiDB 有哪些系统表？ +### 测试数据库有哪些系统表？ 和 MySQL 类似，TiDB 中也有系统表，用于存放数据库运行时所需信息，具体信息参考 [TiDB 系统表](/mysql-schema/mysql-schema-user.md)文档。 -### TiDB 各节点服务器下是否有日志文件，如何管理？ +### 测试数据库各节点服务器下是否有日志文件，如何管理？ 默认情况下各节点服务器会在日志中输出标准错误，如果启动的时候通过 `--log-file` 参数指定了日志文件，那么日志会输出到指定的文件中，并且按天做 rotation。 @@ -49,7 +49,7 @@ mysql -h 127.0.0.1 -uroot -P4000 - 若未使用 load balancer：执行 `SHUTDOWN` 语句，TiDB 组件会做 graceful shutdown。 -### TiDB 里面可以执行 kill 命令吗？ +### 测试数据库里面可以执行 kill 命令吗？ - Kill DML 语句： @@ -61,15 +61,15 @@ mysql -h 127.0.0.1 -uroot -P4000 - Kill DDL 语句：执行 `admin show ddl jobs`，查找需要 kill 的 DDL job ID，然后执行 `admin cancel ddl jobs 'job_id' [, 'job_id'] ...`。具体可以参考 [`ADMIN`](/sql-statements/sql-statement-admin.md)。 -### TiDB 是否支持会话超时？ +### 测试数据库是否支持会话超时？ TiDB 目前支持 [`wait_timeout`](/system-variables.md#wait_timeout)、[`interactive_timeout`](/system-variables.md#interactive_timeout) 和 [`tidb_idle_transaction_timeout`](/system-variables.md#tidb_idle_transaction_timeout-从-v760-版本开始引入) 三种超时。 -### TiDB 的版本管理策略是怎么样的？ +### 测试数据库的版本管理策略是怎么样的？ 关于 TiDB 版本的管理策略，可以参考 [TiDB 版本规则](/releases/versioning.md)。 -### 部署和维护 TiDB 集群的运营成本如何？ +### 部署和维护测试数据库集群的运营成本如何？ TiDB 提供了一些特性和[工具](/ecosystem-tool-user-guide.md)，可以帮助你以低成本管理集群： @@ -84,14 +84,14 @@ TiDB 目前社区非常活跃，同时，我们还在不断的优化和修改 BU - 通过 `select tidb_version()` 进行查看 - 通过执行 `tidb-server -V` 进行查看 -### 如何扩容 TiDB 集群？ +### 如何扩容测试数据库集群？ 可以在不影响线上服务的情况下，对 TiDB 集群进行扩容。 - 如果是使用 [TiUP](/production-deployment-using-tiup.md) 部署的集群，可以参考[使用 TiUP 扩容 TiDB 集群](/scale-tidb-using-tiup.md)。 - 如果是使用 [TiDB Operator](/tidb-operator-overview.md) 在 Kubernetes 上部署的集群，可以参考[在 Kubernetes 中手动扩容 TiDB 集群](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/scale-a-tidb-cluster)。 -### TiDB 如何进行水平扩展？ +### 测试数据库如何进行水平扩展？ 当您的业务不断增长时，数据库可能会面临三方面瓶颈，第一是存储空间，第二是计算资源，第三是读写容量，这时可以对 TiDB 集群做水平扩展。 @@ -103,7 +103,7 @@ TiDB 目前社区非常活跃，同时，我们还在不断的优化和修改 BU 详细可参考 [Percolator 和 TiDB 事务算法](https://pingcap.com/blog-cn/percolator-and-txn/)。 -### TiDB 为什么选用 gRPC 而不选用 Thrift，是因为 Google 在用吗？ +### 测试数据库为什么选用 gRPC 而不选用 Thrift，是因为 Google 在用吗？ 不只是因为 Google 在用，有一些比较好的特性我们需要，比如流控、加密还有 Streaming。 @@ -168,7 +168,7 @@ Client 连接只能通过 TiDB 访问集群，TiDB 负责连接 PD 与 TiKV，PD 本小节介绍 TiDB server 管理中的常见问题、原因及解决方法。 -### TiDB 的 lease 参数应该如何设置？ +### 测试数据库的 lease 参数应该如何设置？ 启动 TiDB Server 时，需要通过命令行参数设置 lease 参数 (`--lease=60`)，其值会影响 DDL 的速度（只会影响当前执行 DDL 的 session，其他的 session 不会受影响）。在测试阶段，lease 的值可以设为 1s，加快测试进度；在生产环境下，我们推荐这个值设为分钟级（一般可以设为 60），这样可以保证 DDL 操作的安全。 @@ -191,7 +191,7 @@ Client 连接只能通过 TiDB 访问集群，TiDB 负责连接 PD 与 TiKV，PD - 由于停 TiDB 时不能与 PD 正常通信（包括停电情况）或者用 `kill -9` 指令停 TiDB 导致 TiDB 没有及时从 PD 清理注册数据，那么会影响 TiDB 启动后 10min 内的 DDL 语句处理时间。这段时间内运行 DDL 语句时，每个 DDL 状态变化都需要等待 2 * lease（默认 lease = 45s）。 - 当集群中某个 TiDB 与 PD 之间发生通信问题，即 TiDB 不能从 PD 及时获取或更新版本信息，那么这时候 DDL 操作的每个状态处理需要等待 2 * lease。 -### TiDB 可以使用 S3 作为后端存储吗？ +### 测试数据库可以使用 S3 作为后端存储吗？ 不可以，目前 TiDB 只支持分布式存储引擎和 GolevelDB/RocksDB/BoltDB 引擎。 @@ -207,7 +207,7 @@ TiDB-server 与 TiKV-server 随时进行通信，在进行大量数据操作过 TiClient Region Error 该指标描述的是在 TiDB-server 作为客户端通过 KV 接口访问 TiKV-server 进行数据操作过程中，TiDB-server 操作 TiKV-server 中的 Region 数据出现的错误类型与 metric 指标，错误类型包括 not_leader、stale_epoch。出现这些错误的情况是当 TiDB-server 根据自己的缓存信息去操作 Region leader 数据的时候，Region leader 发生了迁移或者 TiKV 当前的 Region 信息与 TiDB 缓存的路由信息不一致而出现的错误提示。一般这种情况下，TiDB-server 都会自动重新从 PD 获取最新的路由数据，重做之前的操作。 -### TiDB 同时支持的最大并发连接数？ +### 测试数据库同时支持的最大并发连接数？ 默认情况下，每个 TiDB 服务器的最大连接数没有限制。如有需要，可以在 `config.toml` 文件中设置 `instance.max_connections`（或者系统变量 `max_connections`）来限制最大连接数。如果并发量过大导致响应时间增加，建议通过添加 TiDB 节点进行扩容。 @@ -215,11 +215,11 @@ TiClient Region Error 该指标描述的是在 TiDB-server 作为客户端通过 information_schema 库中的 tables 表里的 create_time 即为表的真实创建时间。 -### TiDB 的日志中 EXPENSIVE_QUERY 是什么意思？ +### 测试数据库的日志中 EXPENSIVE_QUERY 是什么意思？ TiDB 在执行 SQL 时，预估出来每个 operator 处理了超过 10000 条数据就认为这条 query 是 expensive query。可以通过修改 tidb-server 配置参数来对这个门限值进行调整，调整后需要重新启动 tidb-server。 -### 如何预估 TiDB 中一张表的大小？ +### 如何预估测试数据库中一张表的大小？ 要预估 TiDB 中一张表的大小，你可以参考使用以下查询语句： @@ -373,14 +373,14 @@ TiKV 支持单独进行接口调用，理论上也可以起个实例做为 Cache TiKV 的内存占用主要来自于 RocksDB 的 block-cache，默认为系统总内存的 40%。当 TiKV 容易出现 OOM 时，检查 `block-cache-size` 配置是否过高。还需要注意，当单机部署了多个 TiKV 实例时，需要显式地配置该参数，以防止多个实例占用过多系统内存导致 OOM。 -### TiDB 数据和 RawKV 数据可存储于同一个 TiKV 集群里吗？ +### 测试数据库数据和 RawKV 数据可存储于同一个 TiKV 集群里吗？ 这取决于你使用的 TiDB 版本以及是否启用了 TiKV API V2 （即 [`storage.api-version = 2`](/tikv-configuration-file.md#api-version-从-v610-版本开始引入)）。 - 如果你使用的是 v6.1.0 或之后版本的 TiDB，并且启用了 TiKV API V2，那么 TiDB 数据和 RawKV 数据可以共存于同一个 TiKV 集群。 - 否则，不可以将 TiDB 数据和 RawKV 数据存储于同一个 TiKV 集群中，因为 TiDB 数据（或使用事务 API 创建的数据）的 key 的格式与使用 RawKV API 创建的数据（或来自其他基于 RawKV 的服务生成的数据）不兼容。 -## TiDB 测试 +## 测试数据库测试 本小节介绍 TiDB 测试中的常见问题、原因及解决方法。 @@ -391,21 +391,21 @@ TiKV 的内存占用主要来自于 RocksDB 的 block-cache，默认为系统总 - 大家不要用过多精力纠结这类基准测试上，应该更多关注 TiDB 的场景上的区别。 - 大家可以直接参考 [TiDB Sysbench 性能测试报告](/benchmark/v3.0-performance-benchmarking-with-sysbench.md)。 -### TiDB 集群容量 QPS 与节点数之间关系如何，和 MySQL 对比如何？ +### 测试数据库集群容量 QPS 与节点数之间关系如何，和 MySQL 对比如何？ - 在 10 节点内，TiDB 写入能力 (Insert TPS) 和节点数量基本成 40% 线性递增，MySQL 由于是单节点写入，所以不具备写入扩展能力。 - MySQL 读扩容可以通过添加从库进行扩展，但写流量无法扩展，只能通过分库分表，而分库分表有很多问题，具体参考[方案虽好，成本先行：数据库 Sharding+Proxy 实践解析](http://dbaplus.cn/news-11-1854-1.html)。 - TiDB 不管是读流量、还是写流量都可以通过添加节点快速方便的进行扩展。 -### 我们的 DBA 测试过 MySQL 性能，单台 TiDB 的性能没有 MySQL 性能那么好？ +### 我们的 DBA 测试过 MySQL 性能，单台测试数据库的性能没有 MySQL 性能那么好？ TiDB 设计的目标就是针对 MySQL 单台容量限制而被迫做的分库分表的场景，或者需要强一致性和完整分布式事务的场景。它的优势是通过尽量下推到存储节点进行并行计算。对于小表（比如千万级以下），不适合 TiDB，因为数据量少，Region 有限，发挥不了并行的优势。其中最极端的例子就是计数器表，几行记录高频更新，这几行在 TiDB 里，会变成存储引擎上的几个 KV，然后只落在一个 Region 里，而这个 Region 只落在一个节点上。加上后台强一致性复制的开销，TiDB 引擎到 TiKV 引擎的开销，最后表现出来的就是没有单个 MySQL 好。 -## TiDB 备份恢复 +## 测试数据库备份恢复 本小节介绍 TiDB 备份恢复中的常见问题、原因及解决方法。 -### TiDB 主要备份方式？ +### 测试数据库主要备份方式？ 目前，数据量大时（大于 1 TB）推荐使用 [Backup & Restore (BR)](/br/backup-and-restore-overview.md) 进行备份。其他场景推荐使用 [Dumpling](/dumpling-overview.md) 进行备份。 diff --git a/faq/migration-tidb-faq.md b/faq/migration-tidb-faq.md index 7c025068a839..855de89fca5f 100644 --- a/faq/migration-tidb-faq.md +++ b/faq/migration-tidb-faq.md @@ -16,7 +16,7 @@ summary: 介绍 TiDB 迁移中的常见问题。 ## 全量数据导出导入 -### 如何将一个运行在 MySQL 上的应用迁移到 TiDB 上？ +### 如何将一个运行在 MySQL 上的应用迁移到测试数据库上？ TiDB 支持绝大多数 MySQL 语法，一般不需要修改代码。 @@ -69,11 +69,11 @@ iperf Done. 如果输出的各指标良好，请尝试更新各组件版本。如果更新后仍无法解决问题，请移步 [AskTUG 论坛](https://asktug.com/)寻求帮助。 -### 不小心把 MySQL 的 user 表导入到 TiDB 了，或者忘记密码，无法登录，如何处理？ +### 不小心把 MySQL 的 user 表导入到测试数据库了，或者忘记密码，无法登录，如何处理？ 重启 TiDB 服务，配置文件中增加 `-skip-grant-table=true` 参数，无密码登录集群后，可以根据情况重建用户，或者重建 mysql.user 表，具体表结构搜索官网。 -### 如何导出 TiDB 数据？ +### 如何导出测试数据库数据？ 你可以通过以下方式导出 TiDB 数据： @@ -91,7 +91,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 目前看来 OGG 最为合适。 -### 用 Sqoop 批量写入 TiDB 数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ +### 用 Sqoop 批量写入测试数据库数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ - 在 Sqoop 中，`--batch` 是指每个批次提交 100 条 statement，但是默认每个 statement 包含 100 条 SQL 语句，所以此时 100 * 100 = 10000 条 SQL 语句，超出了 TiDB 的事务限制 5000 条，可以增加选项 `-Dsqoop.export.records.per.statement=10` 来解决这个问题，完整的用法如下： @@ -119,7 +119,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 在上述情况下，Dumpling 划分导出子范围时，会划分出过大的子范围，从而向上游发送结果过大的查询。请联系 [AskTUG 社区专家](https://asktug.com/)获取实验版本的 Dumpling。 -### TiDB 有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ +### 测试数据库有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ 有，也支持 DDL。详细参考 [TiDB 历史数据回溯](/read-historical-data.md)。 @@ -135,7 +135,7 @@ DB2、Oracle 到 TiDB 数据迁移（增量+全量），通常做法有： 我们建议通过 [TiDB Data Migration](/dm/dm-overview.md) 进行 MySQL -> TiDB 的业务数据的迁移；业务读写可以按照需求分阶段通过修改网络配置进行流量迁移，建议 DB 上层部署一个稳定的网络 LB（HAproxy、LVS、F5、DNS 等），这样直接修改网络配置就能实现无缝流量迁移。 -### TiDB 总读写流量有限制吗？ +### 测试数据库总读写流量有限制吗？ TiDB 读流量可以通过增加 TiDB server 进行扩展，总读容量无限制，写流量可以通过增加 TiKV 节点进行扩容，基本上写容量也没有限制。 @@ -151,7 +151,7 @@ TiDB 限制了单条 KV entry 不超过 6MB，可以修改配置文件中的 [`t 导入数据的时候，可以分批插入，每批最好不要超过 1w 行。 -### TiDB 中删除数据后会立即释放空间吗？ +### 测试数据库中删除数据后会立即释放空间吗？ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DROP 操作，在达到 TiDB 的 GC (garbage collection) 时间后（默认 10 分钟），TiDB 的 GC 机制会删除数据并释放空间。对于 DELETE 操作 TiDB 的 GC 机制会删除数据，但不会释放空间，而是当后续数据写入 RocksDB 且进行 compact 时对空间重新利用。 @@ -159,7 +159,7 @@ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DRO 不可以，加载数据期间不能对目标表执行任何 DDL 操作，这会导致数据加载失败。 -### TiDB 是否支持 replace into 语法？ +### 测试数据库是否支持 replace into 语法？ 支持。 @@ -171,7 +171,7 @@ DELETE，TRUNCATE 和 DROP 都不会立即释放空间。对于 TRUNCATE 和 DRO 在删除大量数据的时候，建议使用 `Delete from t where xx limit 5000`（xx 建议在满足业务过滤逻辑下，尽量加上强过滤索引列或者直接使用主键选定范围，如 `id >= 5000*n+m and id <= 5000*(n+1)+m` 这样的方案，通过循环来删除，用 `Affected Rows == 0` 作为循环结束条件，这样避免遇到事务大小的限制。如果一次删除的数据量非常大，这种循环的方式会越来越慢，因为每次删除都是从前向后遍历，前面的删除之后，短时间内会残留不少删除标记（后续会被 GC 掉），影响后面的 Delete 语句。如果有可能，建议把 Where 条件细化。可以参考官网[最佳实践](https://pingcap.com/blog-cn/tidb-best-practice/)。 -### TiDB 如何提高数据加载速度？ +### 测试数据库如何提高数据加载速度？ 主要有两个方面： diff --git a/faq/monitor-faq.md b/faq/monitor-faq.md index c947d972925a..1bd55e8c7a88 100644 --- a/faq/monitor-faq.md +++ b/faq/monitor-faq.md @@ -3,7 +3,7 @@ title: TiDB 监控常见问题 summary: 介绍在监控 TiDB 集群时的常见问题、原因及解决方法。 --- -# TiDB 监控常见问题 +# 测试数据库监控常见问题 本文介绍在监控 TiDB 集群时的常见问题、原因及解决方法。 diff --git a/faq/sql-faq.md b/faq/sql-faq.md index 18a578cbb7a6..ae20718dd97d 100644 --- a/faq/sql-faq.md +++ b/faq/sql-faq.md @@ -7,11 +7,11 @@ summary: 介绍 SQL 操作相关的常见问题。 本文档介绍 TiDB 中常见的 SQL 操作问题。 -## TiDB 是否支持二级键？ +## 测试数据库是否支持二级键？ 支持。你可以在具有唯一[二级索引](/develop/dev-guide-create-secondary-indexes.md)的非主键列上设置 [`NOT NULL` 约束](/constraints.md#非空约束)。在这种情况下，该列用作二级键。 -## TiDB 在对大表执行 DDL 操作时，性能表现如何？ +## 测试数据库在对大表执行 DDL 操作时，性能表现如何？ TiDB 在对大表执行 DDL 操作时，一般不会有什么问题。TiDB 支持在线 DDL 操作，且这些 DDL 操作不会阻塞 DML 操作。 @@ -56,11 +56,11 @@ DROP GLOBAL BINDING for SELECT * FROM t1, t2 WHERE t1.id = t2.id; ``` -## TiDB 对哪些 MySQL variables 兼容？ +## 测试数据库对哪些 MySQL variables 兼容？ 详细可参考[系统变量](/system-variables.md)。 -## 省略 `ORDER BY` 条件时 TiDB 中返回结果的顺序与 MySQL 中的不一致 +## 省略 `ORDER BY` 条件时测试数据库中返回结果的顺序与 MySQL 中的不一致 这不是 bug。返回结果的顺序视不同情况而定，不保证顺序统一。 @@ -124,7 +124,7 @@ MySQL 中，返回结果的顺序可能较为固定，因为查询是通过单 在 TiDB 中，你还可以使用系统变量 [`tidb_enable_ordered_result_mode`](/system-variables.md#tidb_enable_ordered_result_mode) 来指定是否对最终的输出结果进行自动排序。 -## TiDB 是否支持 `SELECT FOR UPDATE`？ +## 测试数据库是否支持 `SELECT FOR UPDATE`？ 支持。当 TiDB 使用悲观锁（自 TiDB v3.0.8 起默认使用）时，TiDB 中 `SELECT FOR UPDATE` 的行为与 MySQL 中的基本一致。 @@ -132,7 +132,7 @@ MySQL 中，返回结果的顺序可能较为固定，因为查询是通过单 详情参考 [SELECT 语句语法元素说明](/sql-statements/sql-statement-select.md#语法元素说明)。 -## TiDB 的 codec 能保证 UTF8 的字符串是 memcomparable 的吗？我们的 key 需要支持 UTF8，有什么编码建议吗？ +## 测试数据库的 codec 能保证 UTF8 的字符串是 memcomparable 的吗？我们的 key 需要支持 UTF8，有什么编码建议吗？ TiDB 的默认字符集是 `utf8mb4`，字符串是 memcomparable 格式。关于字符集的更多信息，参见[字符集和排序规则](/character-set-and-collation.md)。 @@ -142,18 +142,18 @@ TiDB 的默认字符集是 `utf8mb4`，字符串是 memcomparable 格式。关 在使用乐观事务并开启事务重试的情况下，默认限制 5000，可通过 [`stmt-count-limit`](/tidb-configuration-file.md#stmt-count-limit) 调整。 -## TiDB 中，为什么出现后插入数据的自增 ID 反而小？ +## 测试数据库中，为什么出现后插入数据的自增 ID 反而小？ TiDB 的自增 ID (`AUTO_INCREMENT`) 只保证自增且唯一，并不保证连续分配。TiDB 目前采用批量分配的方式，所以如果在多台 TiDB server 上同时插入数据，分配的自增 ID 会不连续。当多个线程并发往不同的 TiDB server 插入数据的时候，有可能会出现后插入的数据自增 ID 小的情况。此外，TiDB 允许给整型类型的字段指定 AUTO_INCREMENT，且一个表只允许一个属性为 `AUTO_INCREMENT` 的字段。详情可参考[自增 ID](/mysql-compatibility.md#自增-id)和 [AUTO_INCREMENT](/auto-increment.md)。 -## 如何在 TiDB 中修改 `sql_mode`？ +## 如何在测试数据库中修改 `sql_mode`？ TiDB 支持在会话或全局作用域上修改 [`sql_mode`](/system-variables.md#sql_mode) 系统变量。 - 对全局作用域变量的修改，设置后将作用于集群中的其它服务器，并且重启后更改依然有效。因此，你无需在每台 TiDB 服务器上都更改 `sql_mode` 的值。 - 对会话作用域变量的修改，设置后只影响当前会话，重启后更改消失。 -## 用 Sqoop 批量写入 TiDB 数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ +## 用 Sqoop 批量写入测试数据库数据，虽然配置了 `--batch` 选项，但还是会遇到 `java.sql.BatchUpdateException:statement count 5001 exceeds the transaction limitation` 的错误，该如何解决？ 问题原因：在 Sqoop 中，`--batch` 是指每个批次提交 100 条 statement，但是默认每个 statement 包含 100 条 SQL 语句，所以此时 100 * 100 = 10000 条 SQL 语句，超出了 TiDB 的事务限制 5000 条。 @@ -174,11 +174,11 @@ TiDB 支持在会话或全局作用域上修改 [`sql_mode`](/system-variables.m - 也可以选择增大 TiDB 的单个事物语句数量限制，不过此操作会导致内存增加。详情参见 [SQL 语句的限制](/tidb-limitations.md#sql-statements-的限制)。 -## TiDB 有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ +## 测试数据库有像 Oracle 那样的 Flashback Query 功能么，DDL 支持么？ 有，也支持 DDL。详细参考[使用 AS OF TIMESTAMP 语法读取历史数据](/as-of-timestamp.md)。 -## TiDB 中删除数据后会立即释放空间吗？ +## 测试数据库中删除数据后会立即释放空间吗？ 在 TiDB 中使用 `DELETE`，`TRUNCATE` 和 `DROP` 语句删除数据都不会立即释放空间。对于 `TRUNCATE` 和 `DROP` 操作，在达到 TiDB 的 GC (garbage collection) 时间后（默认 10 分钟），TiDB 的 GC 机制会删除数据并释放空间。对于 DELETE 操作，TiDB 的 GC 机制会删除数据，但不会立即释放空间，而是等到后续进行 compaction 时释放空间。 @@ -198,7 +198,7 @@ TiDB 中的 `SHOW PROCESSLIST` 与 MySQL 中的 `SHOW PROCESSLIST` 显示内容 + 在查询执行期间，TiDB 中的 `State` 列不会持续更新。由于 TiDB 支持并行查询，每个语句可能同时处于多个状态，因此很难显示为某一种状态。 -## 在 TiDB 中如何控制或改变 SQL 提交的执行优先级？ +## 在测试数据库中如何控制或改变 SQL 提交的执行优先级？ TiDB 支持改变[全局](/system-variables.md#tidb_force_priority)或单个语句的优先级。优先级包括： @@ -224,7 +224,7 @@ TiDB 支持改变[全局](/system-variables.md#tidb_force_priority)或单个语 2. 全表扫会自动调整为低优先级，[`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 也是默认低优先级。 -## 在 TiDB 中 `auto analyze` 的触发策略是怎样的？ +## 在测试数据库中 `auto analyze` 的触发策略是怎样的？ 当一张表或分区表的单个分区达到 1000 条记录，且表或分区的（修改数/当前总行数）比例大于 [`tidb_auto_analyze_ratio`](/system-variables.md#tidb_auto_analyze_ratio) 的时候，会自动触发 [`ANALYZE`](/sql-statements/sql-statement-analyze-table.md) 语句。 @@ -326,7 +326,7 @@ TiDB 在执行 SQL 语句时，会根据隔离级别确定一个对象的 `schem ## SQL 优化 -### TiDB 执行计划解读 +### 测试数据库执行计划解读 详细解读[理解 TiDB 执行计划](/explain-overview.md)。 @@ -371,7 +371,7 @@ RUNNING_JOBS: ID:121, Type:add index, State:running, SchemaState:write reorganiz - `ADMIN SHOW DDL JOBS`：用于查看当前 DDL 作业队列中的所有结果（包括正在运行以及等待运行的任务）以及已执行完成的 DDL 作业队列中的最近十条结果。 - `ADMIN SHOW DDL JOBS QUERIES 'job_id' [, 'job_id'] ...`：用于显示 `job_id` 对应的 DDL 任务的原始 SQL 语句。此 `job_id` 只搜索正在执行中的任务以及 DDL 历史作业队列中的最近十条结果。 -### TiDB 是否支持基于 COST 的优化 (CBO)？如果支持，实现到什么程度？ +### 测试数据库是否支持基于 COST 的优化 (CBO)？如果支持，实现到什么程度？ 是的，TiDB 基于成本的优化器 (CBO) 对代价模型、统计信息进行持续优化。除此之外，TiDB 还支持 hash join、sort-merge join 等 join 算法。 @@ -383,7 +383,7 @@ RUNNING_JOBS: ID:121, Type:add index, State:running, SchemaState:write reorganiz ID 没什么规律，只要是唯一就行。不过在生成执行计划时，有一个计数器，生成一个计划 ID 后序号就加 1，执行的顺序和序号无关。整个执行计划是一颗树，执行时从根节点开始，不断地向上返回数据。要理解执行计划，请参考[理解 TiDB 执行计划](/explain-overview.md)。 -### TiDB 执行计划中，task cop 在一个 root 下，这个是并行的吗？ +### 测试数据库执行计划中，task cop 在一个 root 下，这个是并行的吗？ 目前 TiDB 的计算任务隶属于两种不同的 task：cop task 和 root task。cop task 是指被下推到 KV 端分布式执行的计算任务，root task 是指在 TiDB 端单点执行的计算任务。 @@ -393,11 +393,11 @@ ID 没什么规律，只要是唯一就行。不过在生成执行计划时， ## 数据库优化 -### TiDB 参数及调整 +### 测试数据库参数及调整 详情参考 [TiDB 配置参数](/command-line-flags-for-tidb-configuration.md)。 -### 如何避免热点问题并实现负载均衡？TiDB 中是否有热分区或热范围问题？ +### 如何避免热点问题并实现负载均衡？测试数据库中是否有热分区或热范围问题？ 要了解热点问题的场景，请参考[常见热点问题](/troubleshoot-hot-spot-issues.md#常见热点场景)。TiDB 的以下特性旨在帮助解决热点问题： diff --git a/faq/tidb-faq.md b/faq/tidb-faq.md index 1e8dae0804ff..be7f0614113b 100644 --- a/faq/tidb-faq.md +++ b/faq/tidb-faq.md @@ -3,19 +3,19 @@ title: TiDB 产品常见问题 summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型数据库，支持在线事务处理与在线分析处理，具备水平扩容、高可用、实时 HTAP、云原生的特性。TiDB 不是基于 MySQL 开发的，而是由 PingCAP 团队完全自主开发的产品。TiDB 易用性很高，支持绝大部分 MySQL 8.0 的语法，但不支持触发器、存储过程、自定义函数等。TiDB 支持分布式事务，兼容 MySQL Client/Driver 的编程语言，支持其他存储引擎，如 TiKV、UniStore 和 MockTiKV。获取 TiDB 知识的途径包括官方文档、官方博客、AskTUG 社区论坛和 PingCAP Education。用户名长度限制为 32 个字符，最大列数为 1017，单行大小不超过 6MB。TiDB 不支持 XA，但支持对列存储引擎的高并发 INSERT 或 UPDATE 操作。 --- -# TiDB 产品常见问题 +# 测试数据库产品常见问题 -## 1.1 TiDB 介绍及整体架构 +## 1.1 测试数据库介绍及整体架构 -### 1.1.1 TiDB 是什么？ +### 1.1.1 测试数据库是什么？ [TiDB](https://github.com/pingcap/tidb) 是 [PingCAP](https://pingcap.com/about-cn/) 公司自主设计、研发的开源分布式关系型数据库，是一款同时支持在线事务处理与在线分析处理 (Hybrid Transactional and Analytical Processing, HTAP) 的融合型分布式数据库产品，具备水平扩容或者缩容、金融级高可用、实时 HTAP、云原生的分布式数据库、兼容 MySQL 协议和 MySQL 生态等重要特性。目标是为用户提供一站式 OLTP (Online Transactional Processing)、OLAP (Online Analytical Processing)、HTAP 解决方案。TiDB 适合高可用、强一致要求较高、数据规模较大等各种应用场景。更多详细信息，请参阅 [TiDB 简介](/overview.md)。 -### 1.1.2 TiDB 整体架构 +### 1.1.2 测试数据库整体架构 参见 [TiDB 整体架构](/tidb-architecture.md)，以及 TiDB 数据库的[存储](/tidb-storage.md)、[计算](/tidb-computing.md)与[调度](/tidb-scheduling.md)。 -### 1.1.3 TiDB 是基于 MySQL 开发的吗？ +### 1.1.3 测试数据库是基于 MySQL 开发的吗？ 不是。虽然 TiDB 支持 MySQL 语法和协议，但是 TiDB 是由 PingCAP 团队完全自主开发的产品。 @@ -25,25 +25,25 @@ summary: TiDB 是 PingCAP 公司自主设计、研发的开源分布式关系型 - TiKV 是分布式 Key-Value 存储引擎，用来存储真正的数据，简而言之，TiKV 是 TiDB 的存储引擎。 - PD 是 TiDB 集群的管理组件，负责存储 TiKV 的元数据，同时也负责分配时间戳以及对 TiKV 做负载均衡调度。 -### 1.1.5 TiDB 易用性如何？ +### 1.1.5 测试数据库易用性如何？ TiDB 使用起来很简单，可以将 TiDB 集群当成 MySQL 来用。你可以将 TiDB 用在任何以 MySQL 作为后台存储服务的应用中，并且基本上不需要修改应用代码，同时你可以用大部分流行的 MySQL 管理工具来管理 TiDB。 -### 1.1.6 TiDB 和 MySQL 兼容性如何？ +### 1.1.6 测试数据库和 MySQL 兼容性如何？ TiDB 支持绝大部分 MySQL 8.0 的语法，但目前还不支持触发器、存储过程、自定义函数等。详情参见[与 MySQL 兼容性对比](/mysql-compatibility.md)。 -### 1.1.7 TiDB 支持分布式事务吗？ +### 1.1.7 测试数据库支持分布式事务吗？ 支持。无论是一个地方的几个节点，还是[跨多个数据中心的多个节点](/multi-data-centers-in-one-city-deployment.md)，TiDB 均支持 ACID 分布式事务。 TiDB 事务模型灵感源自 Google Percolator 模型，主体是一个两阶段提交协议，并进行了一些实用的优化。该模型依赖于一个时间戳分配器，为每个事务分配单调递增的时间戳，这样就检测到事务冲突。在 TiDB 集群中，[PD](/tidb-scheduling.md) 承担时间戳分配器的角色。 -### 1.1.8 TiDB 支持哪些编程语言？ +### 1.1.8 测试数据库支持哪些编程语言？ 只要支持 MySQL Client/Driver 的编程语言，都可以直接使用 TiDB。 -### 1.1.9 TiDB 是否支持其他存储引擎？ +### 1.1.9 测试数据库是否支持其他存储引擎？ 是的，除了 TiKV 之外，TiDB 还支持一些单机存储引擎，比如 UniStore 和 MockTiKV。注意，TiDB 后续版本可能不再支持 MockTiKV。 @@ -70,25 +70,25 @@ Usage of ./bin/tidb-server: ...... ``` -### 1.1.10 除了官方文档，有没有其他 TiDB 知识获取途径？ +### 1.1.10 除了官方文档，有没有其他测试数据库知识获取途径？ - [官方文档](https://docs.pingcap.com/zh/)：获取 TiDB 相关知识最主要、最及时的途径。 - [官方博客](https://cn.pingcap.com/blog/)：了解产品技术解读、观点洞察、案例实践。 - [AskTUG 社区论坛](https://asktug.com)：与社区用户、技术专家互动交流。 - [PingCAP Education](https://cn.pingcap.com/education/)：学习线上课程，获得数据库能力认证。 -### 1.1.11 TiDB 用户名长度限制？ +### 1.1.11 测试数据库用户名长度限制？ 在 TiDB 中，用户名最长为 32 个字符。 -### 1.1.12 TiDB 中列数和行大小的限制是多少？ +### 1.1.12 测试数据库中列数和行大小的限制是多少？ - TiDB 中默认的最大列数为 1017。你可以调整这个限制，最大可调整到 4096 列。 - TiDB 中默认单行大小不超过 6 MB。你可以调整这个限制，最大可调整到 120 MB。 更多信息，请参考 [TiDB 限制](/tidb-limitations.md)。 -### 1.1.13 TiDB 是否支持 XA？ +### 1.1.13 测试数据库是否支持 XA？ 虽然 TiDB 的 JDBC 驱动用的就是 MySQL Connector/J，但是当使用 Atomikos 的时候，数据源要配置成类似这样的配置：`type="com.mysql.jdbc.jdbc2.optional.MysqlXADataSource"`。MySQL JDBC XADataSource 连接 TiDB 的模式目前是不支持的。MySQL JDBC 中配置好的 XADataSource 模式，只对 MySQL 数据库起作用（DML 去修改 redo 等）。 @@ -96,7 +96,7 @@ Atomikos 配好两个数据源后，JDBC 驱动都要设置成 XA 模式，然 MySQL 是单机数据库，只能通过 XA 来满足跨数据库事务，而 TiDB 本身就通过 Google 的 Percolator 事务模型支持分布式事务，性能稳定性比 XA 要高出很多，所以不会也不需要支持 XA。 -### 1.1.14 TiDB 如何在不影响性能的情况下支持对列存储引擎 (TiFlash) 的高并发 `INSERT` 或 `UPDATE` 操作？ +### 1.1.14 测试数据库如何在不影响性能的情况下支持对列存储引擎 (TiFlash) 的高并发 `INSERT` 或 `UPDATE` 操作？ - [TiFlash](/tiflash/tiflash-overview.md) 引入了 DeltaTree 这种特殊结构来处理列存引擎的修改。 - TiFlash 作为 Raft Group 中的 Learner 角色，不参与 log commit 选举，也不会写入数据。这意味着 DML 操作不需要等待 TiFlash 的确认，所以 TiFlash 不会影响 OLTP 的性能。另外，TiFlash 和 TiKV 分开部署在不同的实例上，不会相互影响。 @@ -105,13 +105,13 @@ MySQL 是单机数据库，只能通过 XA 来满足跨数据库事务，而 TiD TiFlash 默认保持数据强一致性。Raft Learner 流程会更新数据。此外 TSO 检查可以确保查询中的数据与事务完全一致。更多信息，请参考[异步复制](/tiflash/tiflash-overview.md#异步复制)和[一致性](/tiflash/tiflash-overview.md#一致性)。 -## 1.2 TiDB 原理 +## 1.2 测试数据库原理 ### 1.2.1 存储 TiKV 详细解读 [三篇文章了解 TiDB 技术内幕 - 说存储](https://cn.pingcap.com/blog/tidb-internal-1) -### 1.2.2 计算 TiDB 详细解读 +### 1.2.2 计算测试数据库详细解读 [三篇文章了解 TiDB 技术内幕 - 说计算](https://cn.pingcap.com/blog/tidb-internal-2) diff --git a/filter-binlog-event.md b/filter-binlog-event.md index 1bf5908aba01..6ded496d946a 100644 --- a/filter-binlog-event.md +++ b/filter-binlog-event.md @@ -97,7 +97,7 @@ filters: action: Do ``` -### 过滤 TiDB 不支持的 SQL 语句 +### 过滤测试数据库不支持的 SQL 语句 ``` filters: diff --git a/foreign-key.md b/foreign-key.md index ad1b96089a2f..8cace3891f01 100644 --- a/foreign-key.md +++ b/foreign-key.md @@ -283,7 +283,7 @@ mysql> explain analyze delete from parent where id = 1; ## 兼容性 -### TiDB 版本间兼容性 +### 测试数据库版本间兼容性 TiDB 在 v6.6.0 之前已经支持创建外键的语法，但创建的外键并不生效。如果将之前创建的 TiDB 集群升级到 v6.6.0 及之后的版本，之前创建的外键依然是不生效的，可以先删除不生效的外键后再创建外键使外键约束生效。只有在 v6.6.0 及之后版本中新创建的外键才生效。你可以使用 `SHOW CREATE TABLE` 语句查看外键是否生效，不生效的外键会有一条 `/* FOREIGN KEY INVALID */` 注释。 @@ -299,14 +299,14 @@ Create Table | CREATE TABLE `child` ( ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin ``` -### 与 TiDB 工具的兼容性 +### 与测试数据库工具的兼容性 - [DM](/dm/dm-overview.md) 不兼容外键功能。DM 在同步数据到下游 TiDB 时，会显式关闭下游 TiDB 的 [`foreign_key_checks`](/system-variables.md#foreign_key_checks)，所以由外键产生的级联操作不会从上游同步到下游，这会导致上下游数据不一致。 - [TiCDC](/ticdc/ticdc-overview.md) v6.6.0 兼容外键功能。旧版本的 TiCDC 在同步带外键的表时，可能会报错，建议使用 v6.6.0 之前版本 TiCDC 时先关闭下游 TiDB 集群的 `foreign_key_checks`。 - [BR](/br/backup-and-restore-overview.md) v6.6.0 兼容外键功能。之前版本的 BR 在恢复带外键的表到 v6.6.0 及之后版本的集群时，可能会报错，建议先关闭下游 TiDB 集群的 `foreign_key_checks` 后再恢复集群。 - [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 导入数据到 TiDB 前，如果目标表使用了外键，建议先关闭 TiDB 集群的 `foreign_key_checks`。对于 v6.6.0 之前的版本，关闭该系统变量也不会生效，你需要为下游数据库用户添加 `REFERENCES` 权限，或者提前手动在下游数据库中创建好目标表，以确保顺利导入数据。 - [Dumpling](/dumpling-overview.md) 兼容外键功能。 -- [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) 在对比上下游数据时，如果上下游数据库的版本不一样，且下游 TiDB 中存在[不生效的外键](#tidb-版本间兼容性)，则 sync-diff-inspector 可能会报上下游表结构不一致的错误。因为 TiDB v6.6.0 会对表结构中不生效的外键添加一条 `/* FOREIGN KEY INVALID */` 注释。 +- [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) 在对比上下游数据时，如果上下游数据库的版本不一样，且下游 TiDB 中存在[不生效的外键](#测试数据库版本间兼容性)，则 sync-diff-inspector 可能会报上下游表结构不一致的错误。因为 TiDB v6.6.0 会对表结构中不生效的外键添加一条 `/* FOREIGN KEY INVALID */` 注释。 ### 与 MySQL 的兼容性 diff --git a/functions-and-operators/aggregate-group-by-functions.md b/functions-and-operators/aggregate-group-by-functions.md index b8424cf2c785..adb4dd8e1a36 100644 --- a/functions-and-operators/aggregate-group-by-functions.md +++ b/functions-and-operators/aggregate-group-by-functions.md @@ -7,7 +7,7 @@ summary: TiDB支持的聚合函数包括 COUNT、COUNT(DISTINCT)、SUM、AVG、M 本文将详细介绍 TiDB 支持的聚合函数。 -## TiDB 支持的聚合函数 +## 测试数据库支持的聚合函数 TiDB 支持的 MySQL `GROUP BY` 聚合函数如下所示： diff --git a/functions-and-operators/information-functions.md b/functions-and-operators/information-functions.md index c3bd28fd388a..23742f57c6d4 100644 --- a/functions-and-operators/information-functions.md +++ b/functions-and-operators/information-functions.md @@ -7,7 +7,7 @@ summary: TiDB 支持 MySQL 8.0 中提供的大部分信息函数。 TiDB 支持使用 MySQL 8.0 中提供的大部分[信息函数](https://dev.mysql.com/doc/refman/8.0/en/information-functions.html)。 -## TiDB 支持的 MySQL 信息函数 +## 测试数据库支持的 MySQL 信息函数 | 函数名 | 功能描述 | | ------ | ---------------------------------------- | @@ -279,7 +279,7 @@ Store: tikv 如需更改该函数返回的版本，可以修改 [`server-version`](/tidb-configuration-file.md#server-version) 配置项。 -## TiDB 特有的信息函数 +## 测试数据库特有的信息函数 下列函数为 TiDB 中特有的信息函数，MySQL 中无对应的函数。 @@ -287,7 +287,7 @@ Store: tikv | ------ | ---------------------------------------- | | [`CURRENT_RESOURCE_GROUP()`](/functions-and-operators/tidb-functions.md#current_resource_group) | 返回当前连接的资源组名 | -## TiDB 不支持的信息函数 +## 测试数据库不支持的信息函数 * `CHARSET()` * `COERCIBILITY()` diff --git a/functions-and-operators/tidb-functions.md b/functions-and-operators/tidb-functions.md index 8ff820badc69..a17a4aa75663 100644 --- a/functions-and-operators/tidb-functions.md +++ b/functions-and-operators/tidb-functions.md @@ -3,7 +3,7 @@ title: TiDB 特有的函数 summary: 学习使用 TiDB 特有的函数。 --- -# TiDB 特有的函数 +# 测试数据库特有的函数 以下函数为 TiDB 中特有的函数，与 MySQL 不兼容： diff --git a/get-started-with-tidb-lightning.md b/get-started-with-tidb-lightning.md index 3f74b6ae26bd..9f020bb7af8b 100644 --- a/get-started-with-tidb-lightning.md +++ b/get-started-with-tidb-lightning.md @@ -42,7 +42,7 @@ summary: TiDB Lightning 可快速将 MySQL 数据导入到 TiDB 集群中。首 导出的全量备份数据将保存在 `/data/my_database` 目录中。 -## 第 2 步：部署 TiDB 集群 +## 第 2 步：部署测试数据库集群 在开始导入数据之前，你需要先部署一个要进行导入的 TiDB 集群。如果你已经有 TiDB 集群，可以跳过这一步。 diff --git a/glossary.md b/glossary.md index 593fee6d2950..8dbf9e818162 100644 --- a/glossary.md +++ b/glossary.md @@ -21,7 +21,7 @@ ACID 是指数据库管理系统在写入或更新资料的过程中，为保证 * 原子性 (atomicity) 指一个事务中的所有操作，或者全部完成，或者全部不完成，不会结束在中间某个环节。TiDB 通过 Primary Key 所在 [Region](#regionpeerraft-group) 的原子性来保证分布式事务的原子性。 * 一致性 (consistency) 指在事务开始之前和结束以后，数据库的完整性没有被破坏。TiDB 在写入数据之前，会校验数据的一致性，校验通过才会写入内存并返回成功。 -* 隔离性 (isolation) 指数据库允许多个并发事务同时对其数据进行读写和修改的能力。隔离性可以防止多个事务并发执行时由于交叉执行而导致数据的不一致，主要用于处理并发场景。关于 TiDB 支持的隔离级别，请参考 [TiDB 事务隔离级别](/transaction-isolation-levels.md#tidb-事务隔离级别)。 +* 隔离性 (isolation) 指数据库允许多个并发事务同时对其数据进行读写和修改的能力。隔离性可以防止多个事务并发执行时由于交叉执行而导致数据的不一致，主要用于处理并发场景。关于 TiDB 支持的隔离级别，请参考 [测试数据库事务隔离级别](/transaction-isolation-levels.md#测试数据库事务隔离级别)。 * 持久性 (durability) 指事务处理结束后，对数据的修改就是永久的，即便系统故障也不会丢失。在 TiDB 中，事务一旦提交成功，数据全部持久化存储到 TiKV，此时即使 TiDB 服务器宕机也不会出现数据丢失。 ## B diff --git a/grafana-tidb-dashboard.md b/grafana-tidb-dashboard.md index c8bc4b57f9ae..c6bed930ff52 100644 --- a/grafana-tidb-dashboard.md +++ b/grafana-tidb-dashboard.md @@ -3,7 +3,7 @@ title: TiDB 监控指标 summary: 了解 Grafana Dashboard 中展示的关键指标。 --- -# TiDB 重要监控指标详解 +# 测试数据库重要监控指标详解 使用 TiUP 部署 TiDB 集群时，你可以一键部署监控系统 (Prometheus & Grafana)，参考监控架构 [TiDB 监控框架概述](/tidb-monitoring-framework.md)。 diff --git a/hardware-and-software-requirements.md b/hardware-and-software-requirements.md index 46bc3a1884b9..73f748ad44f8 100644 --- a/hardware-and-software-requirements.md +++ b/hardware-and-software-requirements.md @@ -3,7 +3,7 @@ title: TiDB 软件和硬件环境需求 summary: TiDB 是一款开源的一站式实时 HTAP 数据库，支持部署在多种硬件环境和操作系统上。软件和硬件环境建议配置包括操作系统要求、编译和运行依赖库、Docker 镜像依赖、软件配置要求、服务器建议配置、网络要求、磁盘空间要求、客户端 Web 浏览器要求以及 TiFlash 存算分离架构的软硬件要求。 --- -# TiDB 软件和硬件环境需求 +# 测试数据库软件和硬件环境需求 -# TiDB 配置文件描述 +# 测试数据库配置文件描述 TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/config.toml.example](https://github.com/pingcap/tidb/blob/release-8.5/pkg/config/config.toml.example) 找到默认值的配置文件，重命名为 `config.toml` 即可。本文档只介绍未包含在[命令行参数](/command-line-flags-for-tidb-configuration.md)中的参数。 diff --git a/tidb-distributed-execution-framework.md b/tidb-distributed-execution-framework.md index 5f09d8105d02..c132d6efed39 100644 --- a/tidb-distributed-execution-framework.md +++ b/tidb-distributed-execution-framework.md @@ -3,7 +3,7 @@ title: TiDB 分布式执行框架 summary: 了解 TiDB 分布式执行框架的使用场景、限制、使用方法和实现原理。 --- -# TiDB 分布式执行框架 +# 测试数据库分布式执行框架 TiDB 采用计算存储分离架构，具有出色的扩展性和弹性的扩缩容能力。从 v7.1.0 开始，TiDB 引入了一个分布式执行框架，以进一步发挥分布式架构的资源优势。该框架的目标是对基于该框架的任务进行统一调度与分布式执行，并提供整体和单个任务两个维度的资源管理能力，更好地满足用户对于资源使用的预期。 diff --git a/tidb-global-sort.md b/tidb-global-sort.md index 750f767b6973..66d29d4aa1a4 100644 --- a/tidb-global-sort.md +++ b/tidb-global-sort.md @@ -3,7 +3,7 @@ title: TiDB 全局排序 summary: 了解 TiDB 全局排序功能的使用场景、限制、使用方法和实现原理。 --- -# TiDB 全局排序 +# 测试数据库全局排序 > **注意：** > diff --git a/tidb-in-kubernetes.md b/tidb-in-kubernetes.md index 4de95ac839b8..85277f93d1fc 100644 --- a/tidb-in-kubernetes.md +++ b/tidb-in-kubernetes.md @@ -3,7 +3,7 @@ title: 在 Kubernetes 上部署 TiDB 集群 summary: 你可以使用 TiDB Operator 在 Kubernetes 上部署 TiDB。TiDB Operator 是 Kubernetes 上的 TiDB 集群自动运维系统，提供部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或自托管的 Kubernetes 集群上。TiDB Operator 的文档目前独立于 TiDB 文档。要查看如何在 Kubernetes 上部署 TiDB 的详细步骤，请参阅对应版本的 TiDB Operator 文档。 --- -# 在 Kubernetes 上部署 TiDB 集群 +# 在 Kubernetes 上部署测试数据库集群 你可以使用 [TiDB Operator](https://github.com/pingcap/tidb-operator) 在 Kubernetes 上部署 TiDB 集群。TiDB Operator 是 Kubernetes 上的 TiDB 集群自动运维系统，提供包括部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或自托管的 Kubernetes 集群上。 diff --git a/tidb-lightning/tidb-lightning-glossary.md b/tidb-lightning/tidb-lightning-glossary.md index e71868e3ec7e..7206e5df7c2c 100644 --- a/tidb-lightning/tidb-lightning-glossary.md +++ b/tidb-lightning/tidb-lightning-glossary.md @@ -119,7 +119,7 @@ TiDB Lightning 通过引擎将数据传送到 TiKV Importer 中。TiDB Lightning 导入模式。指通过降低读取速度和减少空间使用，来优化 TiKV 写入的配置模式。 -导入过程中，TiDB Lightning 自动在导入模式和[普通模式](#normal-mode)中来回切换。如果 TiKV 卡在导入模式，你可以使用 `tidb-lightning-ctl` [强制切换回普通模式](/tidb-lightning/troubleshoot-tidb-lightning.md#使用-tidb-lightning-后tidb-集群变慢cpu-占用高)。 +导入过程中，TiDB Lightning 自动在导入模式和[普通模式](#normal-mode)中来回切换。如果 TiKV 卡在导入模式，你可以使用 `tidb-lightning-ctl` [强制切换回普通模式](/tidb-lightning/troubleshoot-tidb-lightning.md#使用-tidb-lightning-后测试数据库集群变慢cpu-占用高)。 ### Index engine diff --git a/tidb-lightning/troubleshoot-tidb-lightning.md b/tidb-lightning/troubleshoot-tidb-lightning.md index ee9565901d3f..f4d2e8c11429 100644 --- a/tidb-lightning/troubleshoot-tidb-lightning.md +++ b/tidb-lightning/troubleshoot-tidb-lightning.md @@ -50,7 +50,7 @@ strict-format = true 另外，如果从 TiDB Lightning 的 log 的最后一条日志显示遇到的错误是 "Context canceled"，需要在日志中搜索第一条 "ERROR" 级别的日志。在这条日志之前，通常也会紧跟有一条 "got signal to exit"，表示 Lightning 是收到中断信号然后退出的。 -## 使用 TiDB Lightning 后，TiDB 集群变慢，CPU 占用高 +## 使用 TiDB Lightning 后，测试数据库集群变慢，CPU 占用高 如果 `tidb-lightning` 异常退出，集群可能仍处于“导入模式” (import mode)，该模式不适用于生产环境。此时可执行以下命令查看当前使用的模式： diff --git a/tidb-monitoring-api.md b/tidb-monitoring-api.md index 2d71118359e1..7a1dbedba354 100644 --- a/tidb-monitoring-api.md +++ b/tidb-monitoring-api.md @@ -3,7 +3,7 @@ title: TiDB 集群监控 API summary: TiDB 提供状态接口和 Metrics 接口来监控集群状态。状态接口可获取 TiDB Server 的运行状态和存储信息，PD 的状态接口可查看整个 TiKV 集群的详细信息。Metrics 接口用于监控整个集群的状态和性能。部署 Prometheus 和 Grafana 后，配置 Grafana 即可使用 Metrics 接口。 --- -# TiDB 集群监控 API +# 测试数据库集群监控 API TiDB 提供了以下几种接口来监控集群状态： diff --git a/tidb-monitoring-framework.md b/tidb-monitoring-framework.md index 31c6bf7ef82d..03e6349bb9e1 100644 --- a/tidb-monitoring-framework.md +++ b/tidb-monitoring-framework.md @@ -3,11 +3,11 @@ title: TiDB 监控框架概述 summary: TiDB 使用 Prometheus 作为监控和性能指标存储，Grafana 用于可视化展示。Prometheus 提供多个组件，包括 Prometheus Server、Client 代码库和 Alertmanager。Grafana 展示 TiDB 集群各组件的相关监控，分组包括备份恢复、Binlog、网络探活、磁盘性能、Kafka、TiDB Lightning 等。每个分组包含多个监控项页签，以及详细的监控指标看板。观看培训视频可快速了解监控与报警系统的体系、数据流转方式、系统管理方法和常用监控指标。 --- -# TiDB 监控框架概述 +# 测试数据库监控框架概述 TiDB 使用开源时序数据库 [Prometheus](https://prometheus.io) 作为监控和性能指标信息存储方案，使用 [Grafana](https://grafana.com/grafana) 作为可视化组件进行展示。 -## Prometheus 在 TiDB 中的应用 +## Prometheus 在测试数据库中的应用 Prometheus 是一个拥有多维度数据模型的、灵活的查询语句的时序数据库。Prometheus 作为热门的开源项目，拥有活跃的社区及众多的成功案例。 @@ -21,7 +21,7 @@ Prometheus 提供了多个组件供用户使用。目前，TiDB 使用了以下 ![Prometheus in TiDB](/media/prometheus-in-tidb.png) -## Grafana 在 TiDB 中的应用 +## Grafana 在测试数据库中的应用 Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana 来展示 TiDB 集群各组件的相关监控，监控项分组如下图所示： @@ -51,6 +51,6 @@ Grafana 是一个开源的 metric 分析及可视化系统。TiDB 使用 Grafana ![Grafana Overview](/media/grafana_monitor_overview.png) -要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#tidb-报警规则)，请以文档内容为准。 +要快速了解 TiDB 监控与报警系统的体系、该系统背后的数据流转方式、系统管理方法、系统使用方法和常用监控指标，建议观看下面的培训视频（时长 29 分钟）。注意本视频只作为学习参考，具体的[监控指标与相关报警规则](/alert-rules.md#测试数据库报警规则)，请以文档内容为准。 diff --git a/tidb-scheduling.md b/tidb-scheduling.md index b88a408d3d8d..24a4358b3b77 100644 --- a/tidb-scheduling.md +++ b/tidb-scheduling.md @@ -3,7 +3,7 @@ title: TiDB 数据库的调度 summary: TiDB 数据库的调度由 PD（Placement Driver）模块负责管理和实时调度集群数据。PD 需要收集节点和 Region 的状态信息，并根据调度策略制定调度计划，包括增加 / 删除副本、迁移 Leader 角色等基本操作。调度需满足副本数量、位置分布、负载均衡、存储空间利用等需求。PD 通过心跳包收集信息，并根据策略生成调度操作序列，但具体执行由 Region Leader 决定。 --- -# TiDB 数据库的调度 +# 测试数据库数据库的调度 [PD](https://github.com/tikv/pd) (Placement Driver) 是 TiDB 集群的管理模块，同时也负责集群数据的实时调度。本文档介绍一下 PD 的设计思想和关键概念。 diff --git a/tidb-storage.md b/tidb-storage.md index 29a06f473cdf..6d5499666cc5 100644 --- a/tidb-storage.md +++ b/tidb-storage.md @@ -3,7 +3,7 @@ title: TiDB 数据库的存储 summary: 了解 TiDB 数据库的存储层。 --- -# TiDB 数据库的存储 +# 测试数据库数据库的存储 本文主要介绍 [TiKV](https://github.com/tikv/tikv) 的一些设计思想和关键概念。 diff --git a/tidb-troubleshooting-map.md b/tidb-troubleshooting-map.md index 36f11525971e..a5314bb2a74a 100644 --- a/tidb-troubleshooting-map.md +++ b/tidb-troubleshooting-map.md @@ -3,7 +3,7 @@ title: TiDB 集群问题导图 summary: 了解如何处理 TiDB 集群常见问题。 --- -# TiDB 集群问题导图 +# 测试数据库集群问题导图 本篇文档总结了使用 TiDB 及其组件时的常见错误。遇到相关错误时，可以通过本文档的问题导图来排查错误原因并进行处理。 @@ -50,7 +50,7 @@ summary: 了解如何处理 TiDB 集群常见问题。 - 2.2.5 其他原因，请参考[读写延迟增加](/troubleshoot-cpu-issues.md)。 -## 3. TiDB 问题 +## 3. 测试数据库问题 ### 3.1 DDL @@ -179,7 +179,7 @@ TiDB 作为分布式数据库，内建负载均衡机制，尽可能将业务负 TiDB 提供了完整的方案用于排查、解决或规避这类热点。通过均衡负载热点，可以提升整体性能，包括提高 QPS 和降低延迟等。详情参见 [TiDB 热点问题处理](/troubleshoot-hot-spot-issues.md)。 -### 3.7 TiDB 磁盘 I/O 过高 +### 3.7 测试数据库磁盘 I/O 过高 当出现系统响应变慢的时候，如果已经排查了 CPU 的瓶颈、数据事务冲突的瓶颈后，问题仍存在，就需要从 I/O 来入手来辅助判断目前的系统瓶颈点。参考 [TiDB 磁盘 I/O 过高的处理办法](/troubleshoot-high-disk-io.md)了解如何定位和处理 TiDB 存储 I/O 过高的问题。 diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index eee253950c5a..f3fda2329a8c 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -338,7 +338,7 @@ delta_index_cache_size = 0 TiFlash 支持单节点多盘部署。如果你的部署节点上有多块硬盘，可以通过以下的方式配置参数，提高节点的硬盘 I/O 利用率。TiUP 中参数配置格式参照[详细 TiFlash 配置模版](/tiflash-deployment-topology.md#拓扑模版)。 -#### TiDB 集群版本低于 v4.0.9 +#### 测试数据库集群版本低于 v4.0.9 TiDB v4.0.9 之前的版本中，TiFlash 只支持将存储引擎中的主要数据分布在多盘上。通过 `path`（TiUP 中为 `data_dir`）和 `path_realtime_mode` 这两个参数配置多盘部署。 @@ -348,9 +348,9 @@ TiDB v4.0.9 之前的版本中，TiFlash 只支持将存储引擎中的主要数 如果节点上有多块规格不一致的硬盘，推荐把 `path_relatime_mode` 参数设置为 `true`，并且把性能最好的硬盘目录放在 `path` 参数内的最前面。这表示第一个目录只会存放最新数据，较旧的数据会在其他目录之间进行均衡。注意此情况下，第一个目录规划的容量大小需要占总容量的约 10%。 -#### TiDB 集群版本为 v4.0.9 及以上 +#### 测试数据库集群版本为 v4.0.9 及以上 -TiDB v4.0.9 及之后的版本中，TiFlash 支持将存储引擎的主要数据和新数据都分布在多盘上。多盘部署时，推荐使用 `[storage]` 中的参数，以更好地利用节点的 I/O 性能。但 TiFlash 仍然支持 [TiDB 集群版本低于 v4.0.9](#tidb-集群版本低于-v409) 中的参数。 +TiDB v4.0.9 及之后的版本中，TiFlash 支持将存储引擎的主要数据和新数据都分布在多盘上。多盘部署时，推荐使用 `[storage]` 中的参数，以更好地利用节点的 I/O 性能。但 TiFlash 仍然支持 [测试数据库集群版本低于 v4.0.9](#测试数据库集群版本低于-v409) 中的参数。 如果节点上有多块相同规格的硬盘，推荐把硬盘目录填到 `storage.main.dir` 列表中，`storage.latest.dir` 列表留空。TiFlash 会在所有存储目录之间分摊 I/O 压力以及进行数据均衡。 diff --git a/tiflash/tune-tiflash-performance.md b/tiflash/tune-tiflash-performance.md index f9f4433c62c5..5bf6238a8761 100644 --- a/tiflash/tune-tiflash-performance.md +++ b/tiflash/tune-tiflash-performance.md @@ -11,7 +11,7 @@ summary: 介绍 TiFlash 性能调优的方法，包括机器资源规划和 TiDB 对于希望节省机器资源，并且完全没有隔离要求的场景，可以使用 TiKV 和 TiFlash 联合部署。建议为 TiKV 与 TiFlash 分别留够资源，同时避免共享磁盘。 -## TiDB 相关参数调优 +## 测试数据库相关参数调优 本部分介绍如何通过调整 TiDB 相关参数来提升 TiFlash 性能，具体包括如下几个方面： diff --git a/tiflash/use-tidb-to-read-tiflash.md b/tiflash/use-tidb-to-read-tiflash.md index 65ab251169a9..7f6f9f22e780 100644 --- a/tiflash/use-tidb-to-read-tiflash.md +++ b/tiflash/use-tidb-to-read-tiflash.md @@ -3,7 +3,7 @@ title: 使用 TiDB 读取 TiFlash summary: 了解如何使用 TiDB 读取 TiFlash 副本。 --- -# 使用 TiDB 读取 TiFlash +# 使用测试数据库读取 TiFlash 本文档介绍如何使用 TiDB 读取 TiFlash 副本。 diff --git a/time-to-live.md b/time-to-live.md index 7cb14c226c59..5bed0035b6b9 100644 --- a/time-to-live.md +++ b/time-to-live.md @@ -218,7 +218,7 @@ TiDB 会定时采集 TTL 的运行时信息，并在 Grafana 中提供了相关 其中列 `table_id` 为分区表 ID，而 `parent_table_id` 为表的 ID，与 `information_schema.tables` 表中的 ID 对应。`table_schema`、`table_name`、`partition_name` 分别对应表示数据库、表名、分区名。`create_time`、`finish_time`、`ttl_expire` 分别表示 TTL 任务的创建时间、结束时间和过期时间。`expired_rows` 与 `deleted_rows` 表示过期行数与成功删除的行数。 -## TiDB 数据迁移工具兼容性 +## 测试数据库数据迁移工具兼容性 TTL 功能能够与 TiDB 的迁移、备份、恢复工具一同使用。 @@ -228,7 +228,7 @@ TTL 功能能够与 TiDB 的迁移、备份、恢复工具一同使用。 | TiDB Lightning | v6.6.0 | 导入后如果表中有 TTL 属性，会自动将表的 `TTL_ENABLE` 属性设置为 `OFF`，关闭 TTL。这样可以防止 TiDB 在导入后立即删除过期的数据。此时你需要手动重新配置 `TTL_ENABLE` 属性来重新开启各个表的 TTL。 | | TiCDC | v7.0.0 | 上游的 TTL 删除将会同步至下游。因此，为了防止重复删除，下游表的 `TTL_ENABLE` 属性将被强制设置为 `OFF`。 | -## 与 TiDB 其他特性的兼容性 +## 与测试数据库其他特性的兼容性 | 特性名称 | 说明 | | :-- | :---- | diff --git a/tiproxy/tiproxy-load-balance.md b/tiproxy/tiproxy-load-balance.md index 37350cdb215f..fbe50481fca0 100644 --- a/tiproxy/tiproxy-load-balance.md +++ b/tiproxy/tiproxy-load-balance.md @@ -129,7 +129,7 @@ TiProxy 根据自身与 TiDB server 的地理位置，将连接优先路由到 TiProxy 根据自身和 TiDB server 的 `zone` 标签确定各自的地理位置。你需要同时设置以下配置项： -- 在 TiDB server 的 [`labels`](/tidb-configuration-file.md#labels) 配置项中将 `zone` 设置为当前可用区。配置方式请参阅[设置 TiDB 的 `labels`](/schedule-replicas-by-topology-labels.md#设置-tidb-的-labels可选)。 +- 在 TiDB server 的 [`labels`](/tidb-configuration-file.md#labels) 配置项中将 `zone` 设置为当前可用区。配置方式请参阅[设置测试数据库的 `labels`](/schedule-replicas-by-topology-labels.md#设置测试数据库的-labels可选)。 - 在 TiProxy 的 [`labels`](/tiproxy/tiproxy-configuration.md#labels) 配置项中将 `zone` 设置为当前可用区。 如果是使用 TiDB Operator 部署的集群，请参考[数据的高可用](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/configure-a-tidb-cluster#数据的高可用)进行配置。 diff --git a/tiproxy/tiproxy-overview.md b/tiproxy/tiproxy-overview.md index 183b7989b720..9a4e9e28c368 100644 --- a/tiproxy/tiproxy-overview.md +++ b/tiproxy/tiproxy-overview.md @@ -140,7 +140,7 @@ TiProxy 不适用于以下场景： tiup cluster upgrade --tiproxy-version ``` -### 重启 TiDB 集群 +### 重启测试数据库集群 使用 [`tiup cluster restart`](/tiup/tiup-component-cluster-restart.md) 重启 TiDB 集群时，TiDB server 不是滚动重启，会导致连接断开，请尽量避免使用。 diff --git a/tiup/tiup-cluster-topology-reference.md b/tiup/tiup-cluster-topology-reference.md index 37685e12f08f..8ac4474283cc 100644 --- a/tiup/tiup-cluster-topology-reference.md +++ b/tiup/tiup-cluster-topology-reference.md @@ -3,7 +3,7 @@ title: 通过 TiUP 部署 TiDB 集群的拓扑文件配置 summary: 介绍通过 TiUP 部署或扩容 TiDB 集群时提供的拓扑文件配置和示例。 --- -# 通过 TiUP 部署 TiDB 集群的拓扑文件配置 +# 通过 TiUP 部署测试数据库集群的拓扑文件配置 通过 TiUP 部署或扩容 TiDB 集群时，需要提供一份拓扑文件（[示例](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)）来描述集群拓扑。 diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index abd55090ce3a..725b2f02af37 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -3,7 +3,7 @@ title: 使用 TiUP 部署运维 TiDB 线上集群 summary: 使用 TiUP 的 cluster 组件可以快速部署生产集群，并提供强大的生产集群管理功能，包括升级、缩容、扩容、操作、审计等。部署集群的命令为 tiup cluster deploy，部署完成后可以通过 tiup cluster list 查看集群列表。启动集群的命令为 tiup cluster start，查看集群状态的命令为 tiup cluster display。可以使用 tiup cluster scale-in 进行集群缩容，tiup cluster scale-out 进行集群扩容。另外，还可以使用 tiup cluster upgrade 进行滚动升级，使用 tiup cluster edit-config 进行配置更新。最后，可以使用 tiup cluster exec 在集群节点机器上执行命令。 --- -# 使用 TiUP 部署运维 TiDB 线上集群 +# 使用 TiUP 部署运维测试数据库线上集群 本文重在介绍如何使用 TiUP 的 cluster 组件，如果需要线上部署的完整步骤，可参考[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。 diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 3b3087babc7b..4de65a1d8798 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -3,7 +3,7 @@ title: 本地快速部署 TiDB 集群 summary: TiDB 集群是分布式系统，由多个组件构成。想要快速体验 TiDB，可以使用 TiUP 中的 playground 组件快速搭建本地测试环境。通过命令行参数可以设置各组件的数量和配置，也可以启动多个组件实例。使用 `tiup client` 可以快速连接到本地启动的 TiDB 集群。还可以查看已启动集群的信息，扩容或缩容集群。 --- -# 本地快速部署 TiDB 集群 +# 本地快速部署测试数据库集群 TiDB 集群是由多个组件构成的分布式系统，一个典型的 TiDB 集群至少由 3 个 PD 节点、3 个 TiKV 节点和 2 个 TiDB 节点构成。对于想要快速体验 TiDB 的用户来说，手工部署这么多组件是非常耗时且麻烦的事情。本文介绍 TiUP 中的 playground 组件，以及如何通过 playground 组件快速搭建一套本地的 TiDB 测试环境。 @@ -31,7 +31,7 @@ tiup playground --help ## 使用示例 -### 查看可用的 TiDB 版本 +### 查看可用的测试数据库版本 {{< copyable "shell-regular" >}} @@ -39,7 +39,7 @@ tiup playground --help tiup list tidb ``` -### 启动一个指定版本的 TiDB 集群 +### 启动一个指定版本的测试数据库集群 {{< copyable "shell-regular" >}} @@ -49,7 +49,7 @@ tiup playground ${version} 将 `${version}` 替换为所需的版本号。 -### 启动一个每日构建版的 TiDB 集群 +### 启动一个每日构建版的测试数据库集群 {{< copyable "shell-regular" >}} @@ -99,7 +99,7 @@ tiup playground --tag ${tag_name} 以这种方式启动的集群，在集群关闭以后，数据文件会保留。下一次可以继续使用该 tag 启动集群，从而使用从上一次集群关闭时的数据。 -## 快速连接到由 playground 启动的 TiDB 集群 +## 快速连接到由 playground 启动的测试数据库集群 TiUP 提供了 `client` 组件，用于自动寻找并连接 playground 在本地启动的 TiDB 集群，使用方式为： diff --git a/transaction-isolation-levels.md b/transaction-isolation-levels.md index 9de6d8209605..0f26a8a11613 100644 --- a/transaction-isolation-levels.md +++ b/transaction-isolation-levels.md @@ -3,7 +3,7 @@ title: TiDB 事务隔离级别 summary: 了解 TiDB 事务的隔离级别。 --- -# TiDB 事务隔离级别 +# 测试数据库事务隔离级别 事务隔离级别是数据库事务处理的基础，[ACID](/glossary.md#acid) 中的 “I”，即 Isolation，指的就是事务的隔离性。 diff --git a/transaction-overview.md b/transaction-overview.md index e83722f6548f..1887922312da 100644 --- a/transaction-overview.md +++ b/transaction-overview.md @@ -3,7 +3,7 @@ title: TiDB 事务概览 summary: 了解 TiDB 中的事务。 --- -# TiDB 事务概览 +# 测试数据库事务概览 TiDB 支持分布式事务，提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。TiDB 3.0.8 及以后版本，TiDB 默认采用悲观事务模式。 diff --git a/troubleshoot-cpu-issues.md b/troubleshoot-cpu-issues.md index 78ef2460868e..06ea1e39169d 100644 --- a/troubleshoot-cpu-issues.md +++ b/troubleshoot-cpu-issues.md @@ -9,7 +9,7 @@ summary: 介绍读写延时增加、抖动时的排查思路，可能的原因 ## 常见原因 -### TiDB 执行计划不对导致延迟增高 +### 测试数据库执行计划不对导致延迟增高 查询语句的执行计划不稳定，偶尔执行计划选择错误的索引，导致查询延迟增加。 diff --git a/troubleshoot-high-disk-io.md b/troubleshoot-high-disk-io.md index 2c60d916ca4d..899878db7cb7 100644 --- a/troubleshoot-high-disk-io.md +++ b/troubleshoot-high-disk-io.md @@ -3,7 +3,7 @@ title: TiDB 磁盘 I/O 过高的处理办法 summary: 了解如何定位和处理 TiDB 存储 I/O 过高的问题。 --- -# TiDB 磁盘 I/O 过高的处理办法 +# 测试数据库磁盘 I/O 过高的处理办法 本文主要介绍如何定位和处理 TiDB 存储 I/O 过高的问题。 diff --git a/troubleshoot-hot-spot-issues.md b/troubleshoot-hot-spot-issues.md index 0ba60941ad97..a6112d64b0a1 100644 --- a/troubleshoot-hot-spot-issues.md +++ b/troubleshoot-hot-spot-issues.md @@ -3,7 +3,7 @@ title: TiDB 热点问题处理 summary: TiDB 热点问题处理：介绍定位和解决读写热点问题，包括常见热点场景、确定存在热点问题的方法、使用 TiDB Dashboard 定位热点表、使用 SHARD_ROW_ID_BITS 处理热点表、使用 AUTO_RANDOM 处理自增主键热点表、小表热点的优化、打散读热点。 --- -# TiDB 热点问题处理 +# 测试数据库热点问题处理 本文介绍如何定位和解决读写热点问题。 @@ -13,7 +13,7 @@ TiDB 提供了完整的方案用于排查、解决或规避这类热点。通过 ## 常见热点场景 -### TiDB 编码规则回顾 +### 测试数据库编码规则回顾 TiDB 对每个表分配一个 TableID，每一个索引都会分配一个 IndexID，每一行分配一个 RowID（默认情况下，如果表使用整数型的 Primary Key，那么会用 Primary Key 的值当做 RowID）。其中 TableID 在整个集群内唯一，IndexID/RowID 在表内唯一，这些 ID 都是 int64 类型。 diff --git a/troubleshoot-lock-conflicts.md b/troubleshoot-lock-conflicts.md index a21f79f6fccd..fe0989bf960b 100644 --- a/troubleshoot-lock-conflicts.md +++ b/troubleshoot-lock-conflicts.md @@ -3,7 +3,7 @@ title: TiDB 锁冲突问题处理 summary: 了解 TiDB 锁冲突问题以及处理方式。 --- -# TiDB 锁冲突问题处理 +# 测试数据库锁冲突问题处理 TiDB 支持完整的分布式事务，自 v3.0 版本起，提供[乐观事务](/optimistic-transaction.md)与[悲观事务](/pessimistic-transaction.md)两种事务模式。本文介绍如何使用 Lock View 排查锁相关的问题，以及如何处理使用乐观事务或者悲观事务的过程中常见的锁冲突问题。 diff --git a/troubleshoot-tidb-cluster.md b/troubleshoot-tidb-cluster.md index af0b255677f3..fe3b783ac751 100644 --- a/troubleshoot-tidb-cluster.md +++ b/troubleshoot-tidb-cluster.md @@ -3,7 +3,7 @@ title: TiDB 集群故障诊断 summary: TiDB 集群故障诊断包括收集出错信息、组件状态、日志信息、机器配置和 dmesg 中的问题。解决数据库连接问题需要确认服务是否启动，查看 tidb-server 日志并清空数据重新部署服务。解决 tidb-server 启动报错需检查参数、端口占用和 pd-server 连接。解决 tikv-server 启动报错需检查参数、端口占用和 pd-server 连接。解决 pd-server 启动报错需检查参数和端口占用。进程异常退出需检查是否在前台启动，使用 nohup+& 方式运行或写在脚本中。TiKV 进程异常重启需检查 OOM 信息和 panic log。连接被拒绝需确保网络参数正确。解决文件打开过多问题需确保 ulimit -n 足够大。数据库访问超时需检查拓扑结构、硬件配置、其他服务、操作、CPU 线程、网络 /IO 监控数据。 --- -# TiDB 集群故障诊断 +# 测试数据库集群故障诊断 当试用 TiDB 遇到问题时，请先参考本篇文档。如果问题未解决，请收集以下信息并通过 [TiDB 支持资源](/support.md)解决： diff --git a/tso.md b/tso.md index a36d0c77a673..f942c15410fa 100644 --- a/tso.md +++ b/tso.md @@ -3,7 +3,7 @@ title: TiDB 中的 TimeStamp Oracle (TSO) summary: 了解 TiDB 中的 TimeStamp Oracle (TSO)。 --- -# TiDB 中的 TimeStamp Oracle (TSO) +# 测试数据库中的 TimeStamp Oracle (TSO) 在 TiDB 中，Placement Driver (PD) 承担着 TSO 时间戳分配器的角色，负责为集群内各组件分配时间戳。这些时间戳用于为事务和数据分配时间标记。该分配机制对于在 TiDB 中启用 [Percolator](https://research.google.com/pubs/pub36726.html) 模型至关重要。Percolator 模型用于支持多版本并发控制（Multi-Version Concurrency Control, MVCC）和[事务管理](/transaction-overview.md)。 diff --git a/upgrade-monitoring-services.md b/upgrade-monitoring-services.md index 63ee4a2e8203..59b2a63c7133 100644 --- a/upgrade-monitoring-services.md +++ b/upgrade-monitoring-services.md @@ -3,7 +3,7 @@ title: 升级集群监控组件 summary: 介绍如何升级 TiDB 集群监控组件 Prometheus、Grafana 和 Alertmanager。 --- -# 升级 TiDB 集群监控组件 +# 升级测试数据库集群监控组件 使用 TiUP 部署 TiDB 集群时，TiUP 会同时自动部署 Prometheus、Grafana 和 Alertmanager 等监控组件，并且在集群扩容中自动为新增节点添加监控配置。通过 TiUP 自动部署的监控组件并不是这些三方组件的最新版本，如果你需要使用最新的三方组件，可以按照本文的方法升级所需的监控组件。 @@ -26,7 +26,7 @@ summary: 介绍如何升级 TiDB 集群监控组件 Prometheus、Grafana 和 Ale 从 [Prometheus 官网下载页面](https://prometheus.io/download/)下载组件安装包，并解压。 -### 第 2 步：下载 TiDB 官方 Prometheus 安装包 +### 第 2 步：下载测试数据库官方 Prometheus 安装包 1. 在 [TiDB 官网下载页面](https://cn.pingcap.com/product/#SelectProduct)下载 `TiDB-community-server` 软件包，并解压。 2. 在解压文件中，找到 `prometheus-v{version}-linux-amd64.tar.gz`，并解压。 @@ -66,7 +66,7 @@ tiup cluster patch prometheus-v{new-version}.tar.gz -R prometheus 1. 从 [Grafana 官网下载页面](https://grafana.com/grafana/download?pg=get&plcmt=selfmanaged-box1-cta1)下载组件安装包。你可以根据需要选择下载 `OSS` 版或 `Enterprise` 版。 2. 解压下载的软件包。 -### 第 2 步：下载 TiDB 官方 Grafana 安装包 +### 第 2 步：下载测试数据库官方 Grafana 安装包 1. 在 [TiDB 官网下载页面](https://cn.pingcap.com/product/#SelectProduct)下载 `TiDB-community-server` 软件包，并解压。 2. 在解压文件中，找到 `grafana-v{version}-linux-amd64.tar.gz`，并解压。 diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index 65da650608f5..5165868d5cb1 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -173,7 +173,7 @@ tiup cluster check --cluster 执行结束后，最后会输出 region status 检查结果。如果结果为 "All regions are healthy"，则说明当前集群中所有 region 均为健康状态，可以继续执行升级；如果结果为 "Regions are not fully healthy: m miss-peer, n pending-peer" 并提示 "Please fix unhealthy regions before other operations."，则说明当前集群中有 region 处在异常状态，应先排除相应异常状态，并再次检查结果为 "All regions are healthy" 后再继续升级。 -## 3. 升级 TiDB 集群 +## 3. 升级测试数据库集群 本部分介绍如何滚动升级 TiDB 集群以及如何进行升级后的验证。 @@ -297,7 +297,7 @@ Cluster version: v8.5.0 ### 4.2 升级到 v6.2.0 及以上版本时，如何解决升级卡住的问题 -从 v6.2.0 开始，TiDB 默认开启[并发 DDL 框架](/ddl-introduction.md#tidb-在线-ddl-异步变更的原理)执行并发 DDL。该框架改变了 DDL 作业存储方式，由 KV 队列变为表队列。这一变化可能会导致部分升级场景卡住。下面是一些会触发该问题的场景及解决方案： +从 v6.2.0 开始，TiDB 默认开启[并发 DDL 框架](/ddl-introduction.md#测试数据库在线-ddl-异步变更的原理)执行并发 DDL。该框架改变了 DDL 作业存储方式，由 KV 队列变为表队列。这一变化可能会导致部分升级场景卡住。下面是一些会触发该问题的场景及解决方案： - 加载插件导致的卡住 diff --git a/user-account-management.md b/user-account-management.md index 921e1ea978f7..93f99123b57a 100644 --- a/user-account-management.md +++ b/user-account-management.md @@ -3,7 +3,7 @@ title: TiDB 用户账户管理 summary: TiDB 用户账户管理主要包括用户名和密码设置、添加用户、删除用户、保留用户账户、设置资源限制、设置密码、忘记密码处理和刷新权限。用户可以通过 SQL 语句或图形化界面工具进行用户管理，同时可以使用 `FLUSH PRIVILEGES` 命令立即生效修改。 TiDB 在数据库初始化时会生成一个默认账户。 --- -# TiDB 用户账户管理 +# 测试数据库用户账户管理 本文档主要介绍如何管理 TiDB 用户账户。 diff --git a/vector-search-get-started-using-python.md b/vector-search-get-started-using-python.md index a29a0f2c8c02..ffa79c854fc5 100644 --- a/vector-search-get-started-using-python.md +++ b/vector-search-get-started-using-python.md @@ -51,7 +51,7 @@ pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv - `tidb-vector`：用于与 TiDB 向量搜索交互的 Python 客户端。 - [`sentence-transformers`](https://sbert.net)：提供预训练模型的 Python 库，用于从文本生成[向量嵌入](/vector-search-overview.md#向量嵌入)。 -### 第 3 步：配置 TiDB 集群的连接字符串 +### 第 3 步：配置测试数据库集群的连接字符串 根据不同的 TiDB 集群部署方式，配置集群的连接字符串。 @@ -134,7 +134,7 @@ def text_to_embedding(text): return embedding.tolist() ``` -### 第 5 步：连接到 TiDB 集群 +### 第 5 步：连接到测试数据库集群 使用 `TiDBVectorClient` 类连接到 TiDB 集群，并创建一个包含向量列的表 `embedded_documents`。 diff --git a/vector-search-get-started-using-sql.md b/vector-search-get-started-using-sql.md index d79a5d7e32ad..68355914ed47 100644 --- a/vector-search-get-started-using-sql.md +++ b/vector-search-get-started-using-sql.md @@ -32,7 +32,7 @@ TiDB 扩展了 MySQL 语法以支持[向量搜索](/vector-search-overview.md) ## 快速开始 -### 第 1 步：连接到 TiDB 集群 +### 第 1 步：连接到测试数据库集群 根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB 集群。 diff --git a/vector-search-integrate-with-django-orm.md b/vector-search-integrate-with-django-orm.md index 6f6d262a43f9..a36847aed01e 100644 --- a/vector-search-integrate-with-django-orm.md +++ b/vector-search-integrate-with-django-orm.md @@ -3,7 +3,7 @@ title: 在 Django ORM 中使用 TiDB 向量搜索 summary: 了解如何在 Django ORM 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 Django ORM 中使用 TiDB 向量搜索 +# 在 Django ORM 中使用测试数据库向量搜索 本文档将展示如何使用 [Django](https://www.djangoproject.com/) ORM 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -175,7 +175,7 @@ python manage.py runserver 你可以参考以下示例代码片段来完成自己的应用程序开发。 -### 连接到 TiDB 集群 +### 连接到测试数据库集群 打开 `sample_project/settings.py` 文件，添加以下配置： diff --git a/vector-search-integrate-with-jinaai-embedding.md b/vector-search-integrate-with-jinaai-embedding.md index ddc26e79bcf7..9c16103f0058 100644 --- a/vector-search-integrate-with-jinaai-embedding.md +++ b/vector-search-integrate-with-jinaai-embedding.md @@ -3,7 +3,7 @@ title: 结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索 summary: 了解如何结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索，以存储向量嵌入信息并执行语义搜索。 --- -# 结合 Jina AI 嵌入模型 API 使用 TiDB 向量搜索 +# 结合 Jina AI 嵌入模型 API 使用测试数据库向量搜索 本文档将展示如何使用 [Jina AI](https://jina.ai/) 为文本数据生成向量嵌入，然后将向量嵌入存储在 TiDB 中，并根据向量嵌入搜索相似文本。 @@ -174,7 +174,7 @@ def generate_embeddings(text: str): return response.json()['data'][0]['embedding'] ``` -### 连接到 TiDB 集群 +### 连接到测试数据库集群 通过 SQLAlchemy 连接 TiDB 集群： @@ -249,7 +249,7 @@ with Session(engine) as session: session.commit() ``` -### 使用 Jina AI 生成的向量嵌入在 TiDB 中执行语义搜索 +### 使用 Jina AI 生成的向量嵌入在测试数据库中执行语义搜索 通过 Jina AI 的嵌入 API 生成查询文本的向量嵌入，然后根据**查询文本的向量嵌入**和**向量表中各个向量嵌入**之间的余弦距离搜索最相关的 `document`： diff --git a/vector-search-integrate-with-langchain.md b/vector-search-integrate-with-langchain.md index b91a7591935d..18661dc07de6 100644 --- a/vector-search-integrate-with-langchain.md +++ b/vector-search-integrate-with-langchain.md @@ -3,7 +3,7 @@ title: 在 LangChain 中使用 TiDB 向量搜索 summary: 展示如何在 LangChain 中使用 TiDB 向量搜索 --- -# 在 LangChain 中使用 TiDB 向量搜索 +# 在 LangChain 中使用测试数据库向量搜索 本文档将展示如何在 [LangChain](https://python.langchain.com/) 中使用 [TiDB 向量搜索](/vector-search-overview.md)。 diff --git a/vector-search-integrate-with-llamaindex.md b/vector-search-integrate-with-llamaindex.md index d3408d396d4e..539ee9be87e5 100644 --- a/vector-search-integrate-with-llamaindex.md +++ b/vector-search-integrate-with-llamaindex.md @@ -3,7 +3,7 @@ title: 在 LlamaIndex 中使用 TiDB 向量搜索 summary: 了解如何在 LlamaIndex 中使用 TiDB 向量搜索。 --- -# 在 LlamaIndex 中使用 TiDB 向量搜索 +# 在 LlamaIndex 中使用测试数据库向量搜索 本文档将展示如何在 [LlamaIndex](https://www.llamaindex.ai) 中使用 [TiDB 向量搜索](/vector-search-overview.md)。 @@ -168,7 +168,7 @@ for index, document in enumerate(documents): ### 第 5 步：生成并存储文档向量 -#### 5.1 初始化 TiDB 向量存储 +#### 5.1 初始化测试数据库向量存储 以下代码将在 TiDB 中创建一个 `paul_graham_test` 表，该表针对向量搜索进行了优化。 diff --git a/vector-search-integrate-with-peewee.md b/vector-search-integrate-with-peewee.md index 064d951dd222..189f4849fdaa 100644 --- a/vector-search-integrate-with-peewee.md +++ b/vector-search-integrate-with-peewee.md @@ -3,7 +3,7 @@ title: 在 peewee 中使用 TiDB 向量搜索 summary: 了解如何在 peewee 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 peewee 中使用 TiDB 向量搜索 +# 在 peewee 中使用测试数据库向量搜索 本文档将展示如何使用 [peewee](https://docs.peewee-orm.com/) 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -168,7 +168,7 @@ Get documents within a certain distance: ### 创建向量表 -#### 连接到 TiDB 集群 +#### 连接到测试数据库集群 ```python import os diff --git a/vector-search-integrate-with-sqlalchemy.md b/vector-search-integrate-with-sqlalchemy.md index 6f25678c9c98..218c6ebf8e82 100644 --- a/vector-search-integrate-with-sqlalchemy.md +++ b/vector-search-integrate-with-sqlalchemy.md @@ -3,7 +3,7 @@ title: 在 SQLAlchemy 中使用 TiDB 向量搜索 summary: 了解如何在 SQLAlchemy 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。 --- -# 在 SQLAlchemy 中使用 TiDB 向量搜索 +# 在 SQLAlchemy 中使用测试数据库向量搜索 本文档将展示如何使用 [SQLAlchemy](https://www.sqlalchemy.org/) 与 [TiDB 向量搜索](/vector-search-overview.md)进行交互，以及如何存储向量和执行向量搜索查询。 @@ -152,7 +152,7 @@ Get documents within a certain distance: ### 创建向量表 -#### 连接到 TiDB 集群 +#### 连接到测试数据库集群 ```python import os