oracle,存储过程命名规范
oracle,存储过程命名规范
篇一:Oracle存储过程编码规范
Oracle存储过程编码规范
版 本 号:3.0
目 录
1. 目的 ................................................. 1 2. 名词解释与定义 ....................................... 1 3. 规范内容 ............................................. 1 3.1. 命名规范 ............................................. 1 3.2. 注释信息
............................................. 3 3.3. 错误处理 ............................................. 4 3.4. 其它规范 ............................................. 6 4.过程应用指南 ........................................... 8 4.1. 剪裁 ................................................. 8 4.2. 使用指南 ............................................. 8
1. 目的
规范项目SP代码的编写,保证程序风格的同一性和一致性。
2. 名词解释与定义
无
3. 规范内容
3.1. 命名规范 3.1.1. 存储过程名称
采用“p+模块名一位缩写+功能描述”的格式命名;如 p_YWRTJOB。
3.1.2. 存储过程的输入输出参数
存储过程根据需要自行决定参数的数目、类型和长度;
对于需要提交给任务管理器调用的存储过程,为了保证任务管理器的统一调度;需要用另外一个存储过程进行封装,该封装sp的输入参数采用i_parm命名,输出变量采用o_parm来命名,类型为varchar2(80), 如长度需要超过80,提交讨论,原则不应大于200。只能有一个输入和一个输出参数,输出参数的第一位是?O?(OK)或者?E?(ERROR),第2位开始开始直接写错误信息(如果正确返回,从第2位开始可以写返回信息,内容不作要求),用该sp来调用具体实现业务操作的存储过程。
3.1.3. 变量的命名
所有的变量采用格式为:变量前缀_变量描述。 一般变量的前缀使用类型的缩写: NCHAR:nc
CHAR:c
VARCHAR2: vc NVARCHAR2: nvc NUMBER: n DATE: d
ROWID: rid UROWID: urid BINARY_INTEGER: bi PLS_INTERGER: pi BOOLEAN:b BLOB: blb CLOB: clb NCLOB: nclb BFILE: bfl
例如:vc_StnName、n_FlightDate。 游标变量:前缀为cur。存放游标记录集。 记录型变量:前缀为rec。 存放记录型数据。 表类型变量:前缀为tab。 存放表类型数据。
3.1.4. 参数的命名
参数命名规范为: 参数方向缩写_变量名。参数方向缩写的缩写如下: IN: i OUT:o INOUT:io
例如: i_n_FlightDate
o_vc_AgentID
注意:需要被作业管理调用的封装过的存储过程,其参数是已经规定好的,不遵循本命名规范。
3.2. 注释信息 3.2.1. 开头注释
---------------------------------------------------------------------------------------------------------- -- -- PROCEDURE NAME
--
: SALMCH (SAMPLE)--
-- NAME IN SYSMTH :SALMCH -- -- -- DESCRIPTION --
--
: SQL PROCEDURE TEMPLATE -- FOR NEW DOMESTIC DEVELOPMENT --
: NONE
--
-- INVOKE
-- TYPE : BATCH/SCH/ONLINE-- -- -- PROGRAMMED BY : ARK-- MODIFIED BY -- MODIFIED BY
: ARK: ARK
--
DATE 2004/04/09-- DATE 2004/04/10 -- DATE 2004/05/09--
--
--
-- COPYRIGH