Oracle 命名

1、 编写目的

使用统一的命名和编码规范，使数据库命名及编码风格标准化，以便于阅读、理解和继承。

2、 适用范围

本规范适用于公司范围内所有以ORACLE作为后台数据库的应用系统和项目开发工作。

3、 对象命名规范

3.1 数据库和SID

数据库名定义为系统名+模块名

Ø         全局数据库名和例程SID名要求一致

Ø         因SID名只能包含字符和数字，所以全局数据库名和SID名中不能含有“_”等字符

3.2 表相关

3.2.1 表空间

Ø         面向用户的专用数据表空间以用户名+_+data命名 ，如Aud用户专用数据表空间可命名为Aud_data

Ø         面向用户的专用索引表空间以用户名+_+idx命名

Ø         面向用户的专用临时表空间以用户名+_+tmp命名

Ø         面向用户的专用回滚段表空间以用户名+_+rbs命名

Ø         面向应用的表空间以应用名+_data/应用名+_idx/应用名+_tmp/应用名+_rbs命名

Ø         LOB段数据专用表空间以其数据表空间+_+lobs命名，如上例中数据表空间为Aud_data，则LOB段表空间可命名为Aud_data_lobs

3.2.2 表空间文件

表空间文件命名以表空间名+两位数序号(序号从01开始)组成，如Aud_data01等

3.2.3 表

表命名要遵循以下原则：

Ø         一般表采用“系统名+t_+模块名+_+表义名” 格式构成

Ø         若数据库中只含有单个模块，命名可采用“系统名+t_+表义名”格式构成

Ø         模块名或表义名均以其汉语拼音的首字符命名，表义名中汉语拼音均采用小写，且字符间不加分割符；

Ø         表别名命名规则：取表义名的前3个字符加最后一个字符。如果存在冲突，适当增加字符（如取表义名的前4个字符加最后一个字符等）

Ø         临时表采用“系统名+t_tmp_+表义名” 格式构成

Ø         表的命名如

dft_gy_cbap：系统名（电费 df）+t_+模块名（高压 gy）+_+表义名（抄表安排 cbap）

dft_cbbj: 系统名（电费 df）+t_+表义名（抄表标记 cbbj）

dft_tmp_hj: 系统名（电费 df）+tmp+表义名（合计hj）(此处为临时表)

Ø         关联表命名为Re_表A_表B,Re是Relative的缩写，表A和表B均采用其表义名或缩写形式。

3.2.4 属性（列或字段）

属性命名遵循以下原则：

Ø             采用有意义的列名，为实际含义的汉语拼音的首字符，且字符间不加任何分割符

Ø             属性名前不要加表名等作为前缀

Ø             属性后不加任何类型标识作为后缀

Ø             不要使用“ID”作为列名

Ø             关联字段命名以 “cd+_+关联表的表义名（或缩写）+_+字段名”进行

3.2.5 主键

Ø         任何表都必须定义主键

Ø         表主键命名为：“pk+_+表名(或缩写)+_+主键标识”

如“pk_YHXX_IDKH”等

3.2.6 外键

表外键命名为： “fk+_+表名(或缩写)+_主表名(或缩写)+_+主键标识”

如“fk_YHLX_YHXX_SFZH”等

3.2.7 CHECK约束

CHECK约束命名为： “chk+_+CHECK约束的列名（或缩写）”

3.2.8 UNIQUE约束

UNIQUE约束命名为： “unq+_+UNIQUE约束的列名（或缩写）”

3.2.9 索引

索引的命名为：“表名（或缩写）+_+列名+_idx”。

其中多单词组成的属性列列名取前几个单词首字符再加末单词首字符组成

如yd_kh表khid上的index: yd_kh_khid_idx

3.2.10 触发器

Ø             AFTER型触发器

系统名+tr_+<表名>_+<i,u,d的任意组合> +[_row]

Ø             BEFORE型触发器

系统名+tr_+<表名>_+bef_<i,u,d的任意组合>+[_row]

Ø             INSTEAD OF型触发器

系统名+ti_+<表名>+_+<i,u,d的任意组合>+[_row]

Ø             各种类型的触发器中

i，u，d分别表示insert、update和delete

行级触发器，后加_row标识，语句级触发器不加，如 yddftr_CSH_i_row

3.2.11 簇

簇以簇中要存储的各个表（或表别名）及表间加and的组成命名，即表“A+And+表B…”,如存储GR(工人)和GRJN（工人技能）表的簇命名为GRAndGRJN

3.3 视图

视图命名以系统名v_+模块名作为前缀，其他命名规则和表的命名类似

3.4 序列

序列命名以seq_+含义名组成

3.5 同义词

同义词命名与其基础对象的名称一致，但要去除其用户前缀或含有远程数据库链接的后缀

3.6 存储对象相关

3.6.1 存储过程

存储过程命名由“系统名+sp+_+存储过程标识(缩写)”组成

存储过程标识要以实际含义的汉语拼音的首字符构成，并用下划线分割各个组成部分。

如增加代理商的帐户的存储过程为“sfsp_ZJDLSZH”。

3.6.2 函数

函数命名由“系统名+f+_+函数标识”组成

3.6.3 包

包命名由“系统名+pkg+_+包标识”组成

3.6.4 函数文本中的变量采用下列格式命名：

Ø         参数变量命名采用“i (o或io)+_+名称”形式，前缀i或o表输入还是输出参数

Ø         过程变量命名采用“l+_+名称”形式

Ø         全局包变量命名采用“g+_+名称”形式

Ø         游标变量命名采用“名称+_+cur”形式

Ø         常量型变量命名采用“c+_+名称”形式

Ø         变量名采用小写，若属于词组形式，用下划线分隔每个单词

Ø         变量用来存放表中的列或行数据值时，使用%TYPE、%ROWTYPE方式声明变量，使变量声明的类型与表中的保持同步，随表的变化而变化

3.7 用户及角色

Ø             用户命名由“系统名称+_+user+_+名词(或缩写)或名词短语(或缩写)”组成

Ø             角色命名由“系统名称+_+role+_+名词(或缩写)或名词短语(或缩写)”组成

3.8 数据库链接

Ø             数据库链接命名由“远程服务器名+_+数据库名+_+link”组成

Ø             若远程服务器名和数据库名一致，上式“_+数据库名”部分省去

3.9 命名中的其它注意事项

Ø         命名都不得超过30个字符。

Ø         不要在对象名的字符之间留空格

Ø         小心保留词，要保证你的命名没有和保留词、数据库系统或者常用访问方法冲突

4、 编码规范

4.1 一般性注释

4.1.1 注释尽可能简洁、详细而全面

4.1.2 创建每一数据库对象时都要加上COMMENT ON注释，以说明该对象的功能和用途；建表时，对某些数据列也要加上COMMENT ON注释，以说明该列和/或列取值的含义。

如：XX表中有CZZT列属性为NUMBER(10, 0)可加COMMENT ON注释如下

          COMMENT ON COLUMN XX.CZZT IS '0 = 正常, 1 = 等待, 2 = 超时, 3 = 登出'

4.1.3 注释语法包含两种情况：单行注释、多行注释

单行注释：注释前有两个连字符（--），一般对变量、条件子句可以采用该类注释。

多行注释：符号之间的内容为注释内容。对某项完整的操作建议使用该类注释。

4.2 函数文本注释

4.2.1 在每一个块和过程（存储过程、函数、包、触发器、视图等）的开头放置注释

 

CREATE [OR REPLACE] PROCEDURE dfsp_xxx

…

4.2.2 传入参数的含义应该有所说明。如果取值范围确定，也应该一并说明。取值有特定含义的变量（如boolean类型变量），应给出每个值的含义。

4.2.3  在每一个变量声明的旁边添加注释。说明该变量要用作什么

通常，简单使用单行注释就行了，例如

        l_sfzh CHAR(11)         --身份证号码

4.2.4 在块的每个主要部分之前添加注释

在块的每个主要部分之前增加注释，解释下—组语句目的，最好是说明该段语句及算法的目的以及要得到的结果，但不要对其细节进行过多的描述

4.2.5 在块和过程的开头注释中还可以增加要访问的数据库等信息

4.3 常用SQL语句的编写规范

4.3.1 CREATE语句

CREATE TABLE dft_dksz(

    YHBS               VARCHAR2(20)          NOT NULL,

    ZHGX               DATE,

    DKKHD              VARCHAR2(24),

    CONSTRAINT pk_dksz_yhbs PRIMARY KEY (YHBS)

)

4.3.2 SELECT语句

查询语句采用以下原则编写（可最大化重用共享池中的SQL语句，提高应用程序性能）：

Ø         将SELECT语句分为5部分:

（1） 由SELECT开头，后跟一个显示查询结果的列表；

（2） 由FROM开头，后跟一个或多个获取数据所涉及的表；

（3） 由WHERE开头，后跟一个或多个确定所需值的条件；

（4） 由GROUP BY开头，后跟一个或多个表列名，通过这些列以对查询结果进行汇总；

（5） 由ORDER BY开头，后跟一个或多个表列名，通过这些列以对查询结果进行排序。

Ø         每个部分分行编写，将每一行的第一个关键字与第一行的SELECT尾部对齐，如

SELECT col1, col2, col3

  FROM table1

 WHERE col1 > col2

 GROUP BY col1, col2

 ORDER BY col1;

Ø         关键字用大写，列名和表名采用小写

Ø         语句中嵌入逗号时，在逗号后面加一空格，当逗号是最后一个字符时，把它放在本行

Ø         当语句的同一部分要延续到下一行时，按下列格式排列：

SELECT col1, col2, col3, col4, col5, col6,

 col7, col8, col9, col10

Ø         将语句中WHERE和AND部分格式化，书写布局类似于

WHERE

  AND

  AND

Ø         当语句中出现括号时，括号的两边不留空格

Ø         在SQL语句使用运算符时，操作两边应各留一个空格，如

WHERE X = Y

  AND A = B

  AND C = D

4.3.3 INSERT语句

          INSERT INTO <要插入的表名>

                    (<列1>, <列2>, .., <列n-1>, <列n>)

          VALUES   (<列1值>, <列2值>, .., <列n-1值>, <列n值>)

4.3.4 UPDATE语句

          UPDATE <要更新的表名>

          SET <要更新的列> = <列值>

4.3.5 DELETE语句

DELETE FROM table1

WHERE col1 = '???'

4.4 条件执行语句(IF)编写规范

条件执行语句IF…ELSE按以下格式编写

IF <条件表达式>

THEN

         <一条或多条语句>

[ELSE (或ELSIF<条件表达式>)

THEN

         <一条或多条语句>

END IF;

注:

（1）       在IF…THEN和ELSE(或ELSIF)及ELSE…THEN和END IF间可包含一条或多条PL/SQL语句，而不需要加BEGIN和END

（2）       IF…ELSE…ENDIF语句可以嵌套

（3）       注意ELSIF的写法

4.5 循环语句编写规范

4.5.1 简单循环语句

LOOP

         <零条或多条语句>

EXIT WHEN <条件表达式>

         <零条或多条语句>

END LOOP;

4.5.2 FOR循环语句

FOR 变量 IN [变量取值范围]

LOOP

         <一条或多条语句>

END LOOP;

4.5.3 WHILE循环语句

WHILE <条件表达式>

LOOP

         <一条或多条语句>

END LOOP;

4.6 函数文本（存储过程、函数和包等）

Ø         对于存储过程、函数等程序块都要有异常处理部分，在异常部分的最后都要设置OTHERS异常情态处理器，以提高程序的自检能力，格式如下：

BEGIN

　　…

EXCEPTION

　WHEN excep—name1 THEN

　　　…

　WHEN excep—name2 THEN

　　　…

　WHEN OTHERS THEN

　　　…

　　END;

Ø         对于子程序、触发器、包等带名的程序块，要使用结束标识，如

CREATE OR REPLACE PROCEDURE XXXsp_XXX IS

　　…

BEGIN

　　…

END XXXsp_XXX;

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

命名最好望文生义,避免使用数据库关键词

命名一律为大写字母(或小写，不要大下写混合)英文单词单数命名.例:FACTORY

英文单词缩写命名.例:DEPT

英文单词之间用下划线连结,且每个单词皆为单数.例:TASK_RESULT

用来存储历史资料,命名以HISTORY结尾.例:TASK_HISTORY

用来存储日志资料,命名以LOG结尾.例:TASK_LOG

用来存储类别资料,命名以TYPE结尾.例:TASK_TYPE

表字段

命名最好望文生义,避免使用数据库关键词

英文单词单数命名.例:MAIL

英文单词缩写命名.例:DEPT_ID

英文单词之间用下划线连结,且每个单词皆为单数.例:USER_NAME

字段用来存储流水号,命名以ID结尾.例: TASK_ID

字段用来存储代码,命名以NO结尾.例: TASK_NO

字段用来存储日期,命名以DATE结尾.例:CREATE_DATE

字段用来存储数量,命名以QTY结尾.例:PLAN_QTY

字段用来存储类别,命名以TYPE结尾.例:STATION_TYPE

字段用来存储名称,命名以NAME结尾.例:ENDUSER_NAME

字段用来存储描述,命名以DESC结尾.例:STATION_DESC

字段用来存储代码,命名以CODE结尾.例:ERROR_CODE

字段用来存储标志,命名以FLAG开头.例:DEBUG_FLAG

 

 

 

 

 

 

 

 

 

 

 

 

 

一、     命名约定 
１． 是指数据库、数据库对象如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’) 
= ‘20001-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