MySQL :: X DevAPI 用户指南（用于 JavaScript 模式下的 MySQL Shell） :: 5.3 了解文档 ID

X DevAPI 用户指南（用于 JavaScript 模式下的 MySQL Shell） / 使用文档 / 了解文档 ID

5.3 了解文档 ID

本节详细介绍文档 ID 的生成方式以及如何解释它们。X DevAPI 依赖于服务器端的文档 ID 生成，这会导致所有客户端的文档 ID 按顺序递增。 InnoDB 使用文档 ID 作为主键，从而实现高效的页面分割和树重组。

本节介绍自动生成的文档 ID 的属性和格式。

文档 ID 属性

文档的 _id 字段在查询期间的行为与文档中的任何其他字段相同，除了它的值在插入到集合后不能更改。 _id 字段用作集合的主键。可以通过在插入的文档中手动包含 ID 来覆盖自动生成文档 ID。

重要

X 插件不了解插入到集合中的数据，包括您使用的任何手动文档 ID。在使用手动文档 ID 时，您必须确保它们不会与服务器可能自动生成的任何 ID 冲突（有关详细信息，请参阅文档 ID 生成），以避免因主键重复而导致的任何错误。

只要在插入的文档中不存在 _id 字段值，服务器就会生成一个 _id 值。用于文档的生成的 _id 值作为 add() 操作的 Result（对于 Connector/J 为 Result）对象的一部分返回给客户端。如果您在 InnoDB 集群上使用 X DevAPI，则自动生成的 _id 必须在整个集群中是唯一的。通过将 mysqlx_document_id_unique_prefix 设置为每个集群实例的唯一值，您可以确保文档 ID 在所有实例中都是唯一的。

_id 字段必须是连续的（始终递增），以便在 InnoDB 插入时获得最佳性能（至少在一个服务器内）。_id 值的连续性在服务器重新启动后仍然保持。

在多主键组复制或 InnoDB 集群环境中，表的生成的 _id 值在各个实例中是唯一的，以避免主键冲突并最大程度地减少事务认证。

文档 ID 生成

本节介绍文档 ID 的格式。

自动生成的文档 ID 的格式为

unique_prefix	start_timestamp	serial
4 字节	8 字节	16 字节

其中

unique_prefix 是 InnoDB 集群分配给实例的值，用于使文档 ID 在同一个集群的所有实例中都是唯一的。 unique_prefix 的范围为 0 到 2¹⁶-1，以十六进制编码。默认值为 0，如果它既不是由 InnoDB 集群设置的，也不是由 mysqlx_document_id_unique_prefix 系统变量设置的。
start_timestamp 是服务器实例启动时间的毫秒数，以十六进制编码。在极少数情况下，如果 serial 的值溢出，则 start_timestamp 会加 1，然后 serial 值从 0 重新开始。
serial 是每个实例自动递增的整数序号值，以十六进制编码，范围为 0 到 2⁶⁴-1。 serial 的初始值设置为 auto_increment_offset 系统变量，值的增量由 auto_increment_increment 系统变量设置。

这种文档 ID 格式确保以下几点：

对于来自单个服务器实例的插入，主键值单调递增，尽管表中值的间隔不均匀。
在使用多主键组复制或 InnoDB 集群时，只要实例正确配置了 auto_increment_offset 和 auto_increment_increment 系统变量（有关详细信息，请参阅变量的描述），来自不同实例到同一个表的插入就不会出现主键值冲突。