数据库开发文档

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
  而避免使用 SELECT * FROM my_table

  F. 所有系统关键字必须大写，如：

SELECT * FROM my_database.my_table WHERE 1=1 AND 2=2 ORDER BY id DESC
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. 存储过程范例：

DROP PROCEDURE IF EXISTS pt_admin.pr_admin_login;
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. 函数范例：

DROP FUNCTION IF EXISTS my_database.fc_remake_client_id;
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. 合理的使用索引

7.索引使用原则：
1) 逻辑主键使用唯一的成组索引,对系统键(作为存储过程)采用唯一的非成组索引,对任何外键列采用非成组索引.考虑数据库的空间有多大,表如何进行访问,还有这些访问是否主要用作读写.
2) 大多数数据库都索引自动创建的主键字段,但是可别忘了索引外键,它们也是经常使用的键,比如运行查询显示主表和所有关联表的某条记录就用得上.
3) 不要索引blob/text等字段,不要索引大型字段(有很多字符),这样作会让索引占用太多的存储空间.
4) 不要索引常用的小型表
不要为小型数据表设置任何键,假如它们经常有插入和删除操作就更别这样作了.对这些插入和删除操作的索引维护可能比扫描表空间消耗更多的时间.


9.其他设计技巧
1) 避免使用触发器
触发器的功能通常可以用其他方式实现.在调试程序时触发器可能成为干扰.假如你确实需要采用触发器,你最好集中对它文档化.
2) 使用常用英语(或者其他任何语言)而不要使用编码或者拼音首字母缩写
在创建下拉菜单、列表、报表时最好按照英语名排序.假如需要编码或者拼音首字母缩写,可以在旁边附上用户知道的英语.
3) 保存常用信息
让一个表专门存放一般数据库信息非常有用.在这个表里存放数据库当前版本、最近检查/修复(对Access)、关联设计文档的名称、客户等信息.这样可以实现一种简单机制跟踪数据库,当客户抱怨他们的数据库没有达到希望的要求而与你联系时,这样做对非客户机/服务器环境特别有用.
4) 包含版本机制
在数据库中引入版本控制机制来确定使用中的数据库的版本.时间一长,用户的需求总是会改变的.最终可能会要求修改数据库结构.把版本信息直接存放到数据库中更为方便.
5) 编制文档
对所有的快捷方式、命名规范、限制和函数都要编制文档.
采用给表、列、触发器等加注释的数据库工具.对开发、支持和跟踪修改非常有用.
对数据库文档化,或者在数据库自身的内部或者单独建立文档.这样,当过了一年多时间后再回过头来做第2 个版本,犯错的机会将大大减少。
6) 测试、测试、反复测试
建立或者修订数据库之后,必须用用户新输入的数据测试数据字段.最重要的是,让用户进行测试并且同用户一道保证选择的数据类型满足商业要求.测试需要在把新数据库投入实际服务之前完成。
7) 检查设计
在开发期间检查数据库设计的常用技术是通过其所支持的应用程序原型检查数据库.换句话说,针对每一种最终表达数据的原型应用,保证你检查了数据模型并且查看如何取出数据。