Oracle编程的编码规范及命名规则

数 据 库 使 用 规 则
术语：
站点（SITE）
　　公司已建立的或待建立的网站，如：中文站（CHINA），国际站（ALIBABA），华商站（CHINESE）等。
OLPS
　　Online process system，在线处理系统，即我们的会员可以浏览的网站所连接的数据库，也是我们所说的前台。
BOPS
　　Back Office process system，后台处理系统，即我们的网站的发布系统。
BZO
　　Business Object(?)，公司网站低层JAVA对象，主要负责与数据库打交道。
一、 命名约定
１． 是指数据库、数据库对象如TABLE、SEQUENCE、PROCEDURE、COLUMN等的命名约定；
２． 命名富有意义英文词汇，除个别通用的（见列表），要避免使用缩写），多个单词组成的，中间以下划线分割；
３． 除数据库名称长度为1－8个字符，其余为1－30个字符，Database link名称也不要超过30个字符；
４． 命名只能使用英文字母，数字和下划线；
５． 避免使用Oracle的保留字如level、关键字如type（见列表）；
６． 名表之间相关列名尽量同名；
７． 数据库的命名：网上数据库命名为“OLPS”＋表示站点（SITE，以下同）的2－4个字符，后台数据库命名为“BOPS”＋表示站点的2－4个字符。测试数据库命名为“OLPS|BOPS”＋“TEST”，　开发数据库命名为“OLPS|BOPS”+“TEST”，用模式（SCHEMA／USER）的不同来区分不同的站点。
８． INDEX命名：table_name+column_name+index_type(1 byte)+idx,各部分以下划线（_）分割。多单词组成的column　name，取前几个单词首字母，加末单词组成column_name。如：sample表member_id上的index: sample_mid_idx 　 news表title上的unique index:news_titile_uidx；
９． SEQUENCE命名：seq_+table_name；
二、 注释说明
１． 本注释说明主要用于PL/SQL程序及其它SQL文件，其它可作参考；
２． SQLPLUS接受的注释有三种：
――　这儿是注释
／＊　这儿是注释　＊／
REM　这儿是注释
３． 开始注释，类似JAVAK中的开始注释，主要列出文件名，编写日期，版权说明，程序功能以及修改记录：
REM
REM　$Header: filename, version, created date,auther
REM
REM Copyright
REM
REM FUNCTION
REM function explanation
REM
REM NOTES
REM
REM MODIFIED　（yy/mm/dd）
REM who when - for what, recently goes first
４． 块注释，如表注释，PROCEDURE注释等，同JAVA:
/*
* This table is for TrustPass
* mainly store the information
* of TrustPass members
*/
５． 单行注释，如列注释：
login_id VARCHAR2(32) NOT NULL, -- 会员标识

三、 缩进
低级别语句在高级别语句后的，一般缩进4个空格：
DECLARE
v_MemberId VARCHAR2(32),
BEGIN
SELECT admin_member_id INTO v_MemberId
FROM company
WHERE id = 10;
DBMS_OUTPUT.PUT_LINE(v_MemberId);
END;

同一语句不同部分的缩进，如果为sub statement，则通常为2个空格，如果与上一句某部分有密切联系的，则缩至与其对齐：
BEGIN
FOR v_TmpRec IN
(SELECT login_id,
gmt_created, -- here indented as column above
satus
FROM member -- sub statement
WHERE site = 'china'
AND country='cn' )
LOOP
NULL;
END LOOP;
END;
四、 断行
• 一行最长不能超过80字符
• 同一语句不同字句之间
• 逗号以后空格
• 其他分割符前空格
SELECT　offer_name
||','
||offer_count as offer_category,
id
FROM category
WHERE super_category_id_1 = 0;
五、 大小写
属于ORACLE的关键字大小，表名、列名等小写。
六、 列类型的选择
• 用CHAR(1)代替布尔值；
• 应尽量使用VARCHAR2代替CHAR类型；
• VARCHAR(2)最多4000字符；
• DATE精确到微秒，而非天；
• 使用CLOB代替LONG，BLOB代替LONG　RAW；
• ORACLE只有NUMBER一种数据类型，使用时请给定长度；
七、 主键选择
选择有意义的，不太长且能唯一标识记录行的列做主键，没有这种列时，才考虑使用SEQUENCE做主健。
八、 列长度的选择
应当根据实际需要选择列长度。有对应web 页面的，与页面上对应列长度一致。

对数据的验证除数据库端实现外还要尽可能在表现层控制。
九、 使用SQL语句的约定
１． 尽量避免在循环中使用SQL语句。
２． 避免在WHERE字句中对列施以函数:
SELECT　＊　
FROM　service_promotion
WHERE TO_CHAR(gmt_modified,’yyyy-mm-dd’)
= ‘2 0001-09-01 ’;
　　而应使用：
SELECT *
FROM service_promotion
WHERE gmt_modified
>= TO_DATE(‘ 2001-9-01 ’,’yyyy-mm-dd’)
AND gmt_modified
< TO_DATE(‘ 2001-9-02 ’,’yyyy-mm-dd’);

３． 避免使用数据库的类型自动转换功能：
SELECT * FROM category
WHERE id = ‘123’; -- id’s type is number
４． 避免无效的连接:
SELECT count(*)
FROM offer a, count_by_email b
WHERE a.email(+) = b.email;
５． 连接（join）时要使用别名:
SELECT a.*,b.offer_count(*)
FROM offer a, count_by_email b
WHERE a.email(+) = b.email;
6. 取TABLE 的META信息：
SELECT *
FROM table_name
WHERE rowid is null (or rownum = 1 or pk = impossible_value);
可考虑使用：
SELECT *
FROM table_name
WHERE 1 = 0 ;



十、 关于ALIBABA表的约定
如果使用ALIBABA　BZO，设表至少有如下字段：
site VARCHAR2(32)
gmt_create DATE
gmt_modified DATE
如果从IdBizObject继承，则还有一个NUMBER型的列，通常是主键，并与某一个SEQUENCECF　对应；如果从StrIdBizObject继承，则还有一个VARCHAR2型的列。
十一、 列值约定
１． 有固定值列表的列，如status, action, site, 其值取小写；
２． 应尽可能选择数字来代表固定值列表中的值，相应的列定义为NUMBER型；
３． 用CHAR（1）表示布尔值的取大写：“Y”，“N”。
十二、 关于表重复属性的定义
不能有多择一的重复属性列；

对于能多选的重复属性列，如果不做查询列并且重复次数较多，应使用ID_VARRAY代替，如要用作查询列，重复次数多的，应另建一表，次数少的且列值为二择一时，应使用NUMBER类型，加位操作。
十三、 数据修改约定
发现Production环境中数据有误，需要改正的，应在RA　TERMINAL上提交数据更新表单，由数据库操作员在当日17时前修改完毕。

数据库更程序更新的结构变动及数据更新，类似处理。

提交SQTT测试需要准备数据或更新结构的，暂时先写入测试请求中，由SQTT同志MAIL（注明测试请求表单链接即可）通过数据库操作员修改数据库。待内部网TEAM增加新的表单后，测试请求分开提交。
十四、 数据库设计流程
在新项目设计阶段会议，应有DBA参加。在SCHEMA确定以后方可开始编码。


缩写字列表：
payment pymt
my trade activity mta

特殊字列表：
ACCESS DECIMAL INITIAL ON START
ADD NOT INSERT ONLINE SUCCESSFUL
ALL DEFAULT INTEGER OPTION SYNONYM
ALTER DELETE INTERSECT OR SYSDATE
AND DESC INTO ORDER TABLE
ANY DISTINCT IS PCTFREE THEN
AS DROP LEVEL PRIOR TO
ASC ELSE LIKE PRIVILEGES TRIGGER
AUDIT EXCLUSIVE LOCK PUBLIC UID
BETWEEN EXISTS LONG RAW UNION
BY FILE MAXEXTENTS RENAME UNIQUE
FROM FLOAT MINUS RESOURCE UPDATE
CHAR FOR MLSLABEL REVOKE USER
CHECK SHARE MODE ROW VALIDATE
CLUSTER GRANT MODIFY ROWID VALUES
COLUMN GROUP NOAUDIT ROWNUM VARCHAR
COMMENT HAVING NOCOMPRESS ROWS VARCHAR2
COMPRESS IDENTIFIED NOWAIT SELECT VIEW
CONNECT IMMEDIATE NULL SESSION WHENEVER
CREATE IN NUMBER SET WHERE
CURRENT INCREMENT OF SIZE WITH
DATE INDEX OFFLINE SMALLINT

CHAR VARHCAR VARCHAR2 NUMBER DATE LONG
CLOB BLOB BFILE
INTEGER DECIMAL
SUM COUNT GROUPING AVERAGE
TYPE