数据库开发文档
1. 公共约束
A. 命名尽量使用完整的小写英文单词,多个单词用下划线连接,如:wip_base.base_order。如单词过长,可使用缩写方式。缩写可参考字典,如:mon(monday);或删除单词元音(词首字母除外)和重复字母来缩写一个单词,如:current = crnt、address = adr、error = err、average = avg 。
B. 命名避免使用系统关键字,如使用“pswd”代替“password”。
C. 使用业务术语而不使用计算机术语来描述。如:complete_order 比 process_record 更适合。
D. 使用单数而不使用复数,如:使用customer,而不是customers。
E. 因系统中存在多个数据库并存在跨库的操作,所以SQL语句要求使用“数据库名”+“表名”的方式如:
SELECT * FROM my_database.my_table
F. 所有系统关键字必须大写,如:
3. 数据库、表、字段
A. 除了主键外,表中字段命名尽量不包含表名。如主键可用:member.member_id ;其它字段则用:member.eamil、member.domain而不要使用:member.member_email、member.member_domain。
B. 约定:日期型字段(DATE)以date结尾,如:login_date;时间型字段(DATETIME、TIMESTAMP)以time结尾,如logout_time;布尔型字段以is作为前缀,如:is_push;表示数量的字段以count结尾,如login_count;存放密码的字段可直接使用MySQL的PASSWORD函数进行MD5加密。
C. 表中字段的宽度尽可能小,如使用CHAR(6)来定义一个邮政编码而不使用CHAR(255)或VARCHAR类型。
D. 字段定义必须为NOT NULL,以减少查询时的NULL比较。
4. 存储过程
A. 存储过程以“pr_”作为前缀,如:pr_member_login。
B. 存储过程的命名尽量名词在前,动词在后。如:
pr_employee_insert
pr_employee_update
pr_employee_delete
pr_employee_list
C. 存储过程参数:输入参数以“i_”(input)作为前缀,输出参数以“o_”(output)作为前缀,见存储过程范例。
D. 变量:私有变量以“m_”(my)作为前缀,如:m_variable;公共变量以“p_”(public)作为前缀,如:@p_variable。
E. 存储过程中的逻辑尽可能多的进行注释,以方便大家协作开发;存储过程中使用必要的缩进,缩进符使用Tab,参见范例。
F. 存储过程范例:
CREATE PROCEDURE pt_admin.pr_admin_login(
IN i_email CHAR(128),
IN i_pswd CHAR(64),
IN o_result INT
)
BEGIN
/*私有变量*/
DECLARE m_variable INT DEFAULT 0;
SELECT 10001 INTO m_variable;
/*公共变量*/
SELECT 10000 INTO @p_ variable;
/*输出*/
SELECT @p_ variable + m_variable INTO o_result;
END;
5. 函数
A. 函数以“fc_”作为前缀,如:fc_common_pager
B. 函数范例:
CREATE FUNCTION my_database.fc_remake_client_id(
p_base_id BIGINT UNSIGNED,
p_site_id TINYINT UNSIGNED
) RETURNS INT
BEGIN
RETURN p_base_id - p_site_id * 10000000000;
END;
6. 优化
A. 使用连接(JOIN)来代替子查询(SUB-QIERIES)
B. 合理的使用索引