此编程规范在业界通用的编程规范基础上进行了整理，供开发者参考使用。清晰，易于维护、易于重构。简洁，易于理解，并且易于实现。风格统一，代码整体风格保持统一。通用性，遵循业界通用的编程规范。建议将工程按照功能模块划分子目录（可参考LiteOS的功能模块划分），子目录再定义头文件和源文件目录。使用驼峰风格进行命名，此风格大小写字母混用，不同单词

查看更多 →

规范要求 API生产 API开放 父主题： 附录-API治理规范指导

查看更多 →

使用规范 命名规范 索引规范 数据库连接 可靠性 数据库性能 Cursor使用规则 父主题： 产品介绍

查看更多 →

命名规范 数据库对象（库、表、字段、索引）命名建议全部使用小写字母开头，后面跟字母或者数字，长度不要超过32字节。 数据库名称不能使用特殊字符("",.,$,\,/,\0,*,?,~,#,:,?,|")，数据库名称不能使用系统数据库名，如：admin，local，config。

查看更多 →

BATCH规范 规则1：不支持logged batch，仅支持unlogged batch。 规则2：一个batch中，操作不超过25行数据。 规则3：一个batch中，请求大小不超过5KB。 规则4：一个batch中，跨partition不超过10个，只操作一张表。 父主题： 数据库规范

查看更多 →

使用规范 GaussDB (for MySQL)数据库权限规范 GaussDB(for MySQL)库表设计规范 GaussDB(for MySQL)索引设计规范 GaussDB(for MySQL)SQL使用规范 父主题： 使用数据库

查看更多 →

使用规范 实例使用规范 数据库使用规范 父主题： RDS for MariaDB用户指南

查看更多 →

使用规范 实例使用规范 数据库使用规范 父主题： 使用数据库

查看更多 →

使用规范 实例使用规范 数据库使用规范 父主题： RDS for PostgreSQL用户指南

查看更多 →

OSC服务规范 OSC服务规范介绍 服务包规范 开源服务包规范

查看更多 →

Doris表名称大小写敏感，统一使用小写方式，中间使用下划线（_）分隔，长度为64字节以内。 父主题： Doris应用开发规范

查看更多 →

对外API规范 API规范示例 为了对外API在调用时有用户信息，API调用时需要在header中传递Modifier、Creator字段。 值格式为：用户名+空格+用户id，如图1所示。 图1 示例 具有AccessControlled功能的实体，其API做了权限管控，权限管理

查看更多 →

DDL操作规范 建议3.1 DDL操作（CREATE除外）避免在业务高峰期和长事务中执行 违反规范的影响： DDL操作普遍持锁级别高，如ALTER、DROP、TRUNCATE、REINDEX、VACUUM FULL等，执行时会造成业务等锁阻塞。 高峰期执行持锁级别高的DDL操作，造成业务等锁阻塞。

查看更多 →

SELECT操作规范 规则3.7 禁止执行不下推的SQL GaussDB(DWS)为分布式架构，SQL语句必须下推才能分利用分布式的计算资源，达到性能最优。 违反规范的影响： 不下推的SQL执行性能差，严重情况会导致CN资源瓶颈，影响整体业务。 方案建议： 不使用不下推的语法和不下推的函数，具体参考语句下推调优。

查看更多 →

SELECT操作规范 规则3.7 禁止执行不下推的SQL GaussDB(DWS)为分布式架构，SQL语句必须下推才能分利用分布式的计算资源，达到性能最优。 违反规范的影响： 不下推的SQL执行性能差，严重情况会导致CN资源瓶颈，影响整体业务。 方案建议： 不使用不下推的语法和不下推的函数，具体参考语句下推调优。

查看更多 →

实例使用规范 数据库实例 数据库实例类型选择 主备 一主一备的经典高可用架构。适用于大中型企业的生产数据库，覆盖互联网、物联网、零售电商、物流、游戏等行业应用。 备机提高了实例的可靠性，创建主机的过程中，同步创建备机，备机创建成功后，用户不可见。 当主节点故障后，会发生主备切换，

查看更多 →

Huawei LiteOS（以下简称LiteOS）欢迎开发者参与到开源社区的贡献中来，本文主要介绍参与LiteOS文档贡献的写作规范，如果贡献者提交文档的修改或提交新的文档，请参照此规范。如需提交新的文档，在LiteOS代码仓doc目录下创建新的.md文件，命名需遵循xxx_xxx.md格式，根据文档的内容来声明。比如介绍写作规范的文档，

查看更多 →

签名审核规范 格式限制 签名名称不能含有黄赌毒及其他违反法律规定的信息； 签名不支持中性化签名，需能辨别所属公司或公司归属的网站、产品、APP； 国内短信签名由【】及签名名称组成，签名名称要求2~12个字（只能包含中文、数字、字母，不能为纯数字，国内短信签名名称尽量使用中文）；

查看更多 →

异形字、语句不通顺、非常用的表达法等。 如遇到违反规范并造成恶劣影响的，将严肃处理并进行封号。请严格遵守规范要求，加强自身业务安全，健康发送短信。 内容规范可能随运营商规则变化实时调整，以最终 内容审核 结果为准。 父主题： 审核规范

查看更多 →

设计规范 命名规范 数据库对象（库名、表名、字段名、索引名）命名建议全部使用小写字母开头，后面跟字母或者数字，数据库对象（库名、表名、字段名、索引名）名字长度建议都不要大于32字节。 数据库名称不能使用特殊字符("",.,$,\,/,*,?,~,#,:,|")和空字符\0，数据库

查看更多 →

构造规范请求 使用AK/SK方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与云服务API网关使用相同的请求规范，可以确保同一个HTTP请求的前后端得到相同的签名结果，从而完成身份校验。 HTTP请求规范伪代码如下： CanonicalRequest =

查看更多 →