特性名称(与文首 metadata 中的 title 名称保持一致)

模版说明:

  • 本文档为新增功能类模板,同时包含功能概念和使用信息。你可直接复制使用,并删除模板中不需要的说明。该类文档示例:聚簇索引
  • 功能一定要有对应的功能介绍文档。
  • 如果新增功能与其他厂商相同或相似,切忌完全照搬其他厂商文档中的示例。
  • 请在 TOC.md 中合适的位置加目录(思考用户最有可能在哪里找文档)。
  • 文内标题级别不可跳级,尽量避免使用五级标题。

警告:(可选)

当前该功能为实验特性,不建议在生产环境中使用。

本文档介绍 XXX 的使用场景、使用方法、使用限制和使用该功能的常见问题。

XXX 是什么。用于做什么,通过使用该特性,可以实现/优化什么(即下个小标题要叙述的使用场景的概括)。(实现细节或原理略写,或可考虑单独写成博客、参考指南)。

如果需要添加注意或警告事项,需严格遵循以下格式。其中,“注意”为一般的提示,“警告”含义则为”不要这样做“。示例如下:

注意:

读取历史数据时,即使当前数据的表结构相较于历史数据的表结构已经发生改变,历史数据也会以当时的历史表结构来返回。

警告:

在集群中有多个 TiDB 实例时,如果表结构中有自增 ID,建议不要混用显式插入和隐式分配(即自增列的缺省值和自定义值),否则可能会破坏隐式分配值的唯一性。

如果注意或警告事项嵌套在列表内,需要缩进四个空格(官网文档中的缩进建议统一采用四个空格,以避免 PingCAP 官网显示错乱)。

使用场景

使用场景非常重要。需要从用户的角度,介绍用户为什么要使用该特性、在什么场景下使用、能解决用户的什么问题。

xxx 在以下场景中使用/有优势:

  • 无序列表
  • 无序列表

具体场景一名称

具体场景二名称

前提条件(可选)

如需使用表格,应注意表格必须有表头(即第一行),且表格后需空一行。

条件 说明
条件 1 说明 1
准备 xxx 这里说明如何准备 xxx,可以给出参考文档的链接。
确保 xxx 这里说明如何能查看 xxx 是否符合条件。如果不符合条件,应该如何处理。

使用方法/操作步骤

TiDB 提供 x 种 xxx 的使用方法,分别是 xxx 方法 和 xxx 方法。

在 xxx 情况下,为了 xxx, 推荐使用 xxx 方法。

方法一名称 xxx

1.方法一步骤 1 1.方法一步骤 2 1.方法一步骤 3

方法二名称 xxx

1.方法二步骤 1 2.方法二步骤 2 3.方法二步骤 3

参数说明

如果此特性主要一个新增的语法或命令,请使用表格呈现具体配置项或参数说明、默认值和示例等相关信息。使用表格时,应注意表格必须有表头(即第一行),且表格后需空一行。

参数 说明 默认值 是否必填 示例
xxx xxx xxx xxx xxx

使用限制

这里列出使用限制。如果各个限制项之间没有顺序关系,推荐使用无序列表列出各项。

兼容信息

这里列出该特性的兼容性信息,通常包括与之前 TiDB 版本的兼容性信息,与 MySQL 的兼容性信息,或在不同架构或平台下的兼容性信息。

常见问题(可选)

如果内容较多,可以单独增加一篇常见问题文档。

探索更多

本小节给出更多用户可能想看到的相关文档,如:

或直接给出用户接下来可能感兴趣的文档,如: