MongoDB命名规范完全指南

MongoDB命名规范完全指南

引用

CSDN

1.

https://blog.csdn.net/cuclife/article/details/139865123

MongoDB 的命名规范非常重要，它不仅影响数据库的可读性和可维护性，还可能影响到数据的一致性和性能。以下是一些推荐的 MongoDB 命名规范：

一、数据库命名规范

• 数据库名称应该是小写的，并且只包含字母、数字和下划线。
• 数据库名不能是空字符串。
• 数据库名不能包含特殊字符，除了下划线。
• 数据库名不能以数字开头。
• 数据库名不应超过64个字符。
• 避免使用系统保留的数据库名称，如 admin、local、config。
• 数据库名应具有描述性，清晰地表明其用途。

二、集合命名规范

• 集合名同样应该是小写的，并且只包含字母、数字和下划线。
• 集合名不能是空字符串。
• 集合名不能包含空字符 \0。
• 集合名不能以 system. 开头，因为这是为系统集合保留的前缀。
• 集合名应尽可能简洁，但具有描述性，以反映其包含的数据类型或用途。
• 避免在集合名中使用点 . 和美元符号 $，尽管它们在某些情况下是允许的，但可能会导致混淆或意外行为，尤其是在使用 MongoDB 的聚合框架时。

三、文档键（Field）命名规范

• 键名应避免使用除下划线 _ 以外的特殊字符。
• 键名应该全部小写，多个单词可以使用下划线连接。
• 键名不能以数字开头。
• 避免使用 ._id 或任何以 _id 结尾的键名，以防止与 MongoDB 自动生成的 _id 字段冲突。
• 键名应具有描述性，清晰地表明其存储的数据类型或意义。

四、索引命名规范

• 索引名长度不应超过128个字符。
• 尽量使用描述性的名称，以便清楚地了解索引的目的。
• 当创建组合索引时，考虑将数据基数大的字段放在前面，以提高索引的效率。

五、其他注意事项

• 虽然 MongoDB 支持 Unicode 字符串作为数据库、集合和键名，但在命名时仍应考虑到国际化和编码问题。
• 遵循一致的命名约定有助于团队协作和代码的可读性。

这些规范可以帮助你建立一个清晰、一致且易于维护的 MongoDB 数据库架构。