概述

简介

本规范以产品生命周期为主线，详细描述产品设计和开发流程过程中与数据库相关的设计和开发规范。

规范以提高可读性、代码质量为原则，强调实用性、可操作性，对GaussDB数据库开发容易产生问题的地方做出了明确的规定。主要包括下列内容：

设计规范包括：数据库设计、性能设计。

编程规范包括：排版、命名、注释、语法、脚本、数据库编程。

同时，在必要时，对部分规范给出细则及具体的示例。

术语约定

本规范采用以下的术语描述：

• 规格：数据库规格，编程、设计必须遵守的原则，否则数据库将报错。
• 规则：编程、设计必须考虑遵守的原则。
• 建议：编程、设计推荐加以考虑的原则。
• 说明：对规则或建议进行必要的解释。
• 示例：对规则或建议进行或正或反方面的举例。
• 分片：将一个表中的数据按照指定的策略拆分并存储至多个DN上的同名表中，这些表中存储的数据互不重叠，可以理解为“表的水平分库”，举例：t_user表按主键userId Hash拆分到GaussDB的4个不同DN中就是4个分片，每个分片内都有一张同名的t_user表。

适用范围

本规范适用于GaussDB 1.x及以上版本。

本规范适合人群包括：设计人员、开发人员、开发DBA、运维DBA、运维人员。