Guía de Programación Oracle

SIGPRE - Sistema de Gestin para
la Proforma Presupuestaria
Gua de Programacin Oracle
SIGPRE
- Sistema de Gestin para la Proforma
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versinii
Fecha: 3/12/2008
Histrico de Revisiones
Fecha
Versin
Descripcin
Autor
10/2/2007
1.0
Borrador
Roberto Lpez
11/14/2007
1.0
Convenciones Objetos de BDD
Roberto Lpez
11/15/2007
1.0
Convenciones Forms
Roberto Lpez
11/16/2007
1.0
Convenciones Reports
Roberto Lpez
11/26/2007
1.1
Revisin del personal tcnico del centro de

cmputo.
Centro de Cmputo
11/26/2007
1.1
Se agrega convenciones para uso de

Journal tables y TABLE API de Oracle
Designer
Roberto Lpez
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versiniii
Fecha: 3/12/2008
Contenido
1.
2.
Introduccin........................................................................................................................... 1
1.1
Propsito........................................................................................................................ 1
1.2
Alcance.......................................................................................................................... 1
Organizacin de Cdigo y Estilos......................................................................................... 1

2.1
Estndares para formato de cdigo...............................................................................1
2.1.1
Capitalizacin.......................................................................................................... 1
2.1.2
Identacin............................................................................................................... 1
2.1.3
Alineacin............................................................................................................... 3
3.
Comentarios.......................................................................................................................... 5
4.
Nombrado............................................................................................................................. 6
5.
Declaracin........................................................................................................................... 7
6.
5.1
Variables........................................................................................................................ 7
5.2
Parmetros.................................................................................................................... 8
5.2.1
Parmetros en funciones y procedimientos............................................................8
5.2.2
Parmetros en cursores..........................................................................................8
Expresiones y Sentencias..................................................................................................... 8
6.1
Procedimientos y Funciones..........................................................................................8
6.2
Bucles............................................................................................................................ 9
6.2.1
For Loops................................................................................................................ 9
6.2.2
Bucles While......................................................................................................... 10
6.2.3
Cursores............................................................................................................... 10
6.3
Sentencias IF............................................................................................................... 11
7.
Manejo de Errores y Excepciones.......................................................................................12
8.
Desempeo y Reusabilidad................................................................................................ 12
9.
8.1
SQL del lado del Cliente............................................................................................... 12
8.2
Modularidad................................................................................................................. 13
8.3
Cdigo duro................................................................................................................. 13
8.4
Funciones de agrupamiento innecesarias....................................................................14
Estndares de nombrado.................................................................................................... 15
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
9.1
Versiniv
Fecha: 3/12/2008
Base de Datos.............................................................................................................. 15
9.1.1
Objetos de BDD.................................................................................................... 15
9.1.2
Informacin de auditora.......................................................................................17
9.1.3
Glosario de prefijos............................................................................................... 17
9.2
Oracle Forms............................................................................................................... 18
9.3
Oracle Reports............................................................................................................. 19
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin1
Fecha: 3/12/2008

1.
Introduccin
Con el fin de estandarizar el desarrollo sobre la plataforma Oracle que se realice en el Centro
de Cmputo de EMELNORTE S.A., la presente gua establece recomendaciones para la
programacin con PL/SQL y FORMS y REPORTS.
1.1
Propsito
El propsito de sta gua es establecer un estndar o convencin de nombrado para el

desarrollo de aplicaciones bajo la plataforma Oracle, especficamente para Objetos de bases
de datos y Pl/SQL
1.2
Alcance
Aplicable al desarrollo de aplicaciones sobre plataforma Oracle:
Programacin PL/SQL
o Objetos de Base de Datos
Tablas, vistas, ndices
Triggers, Paquetes, Funciones y Procedimientos
o FORMS
o REPORTS
2.
Organizacin de Cdigo y Estilos
2.1
Estndares para formato de cdigo
2.1.1
Capitalizacin
Todas las palabras clave SQL deben estar en maysculas. Cualquier palabra clave Oracle o
built-ins debern tambin ser escritas en maysculas. No use capitalizacin mezclada.
Este mtodo facilita diferenciar entre una llamada a procedimientos built-in de una llamada a
procedimientos programados.
2.1.2
Identacin
Use tres espacios (en lugar de TAB) en los siguientes casos:

Para cdigo entre las sentencias BEGIN y END
Sentencias LOOP y END LOOP
Para el cdigo entre las sentencias IF, ELSE y ELSE IF
Se recomienda el uso de tres espacios en lugar de tabuladores, por las siguientes razones:
Los Tabuladores no son portables entre editores.
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin2
Fecha: 3/12/2008
Los Tabuladores no almacenan el cdigo de manera apropiada en la Base de datos

El cdigo fuente de la Base de datos puede ser visto usando el diccionario de datos, a travs
de las vistas USER_SOURCE, ALL_SOURCE, o DBA_SOURCE. Estas vistas no despliegan
apropiadamente el cdigo que ha sido formateado con tabuladores. Esto dificulta la
visualizacin de cdigo almacenado sin necesidad de extraerlo a un archivo.
Tabuladores usualmente son muy largos, algunos editores como Notepad y otros usan 8
espacios para desplegar un carcter de tabulacin.
Se recomienda el uso del editor del programa TOAD para la programacin sobre Oracle.
TOAD for Oracle es una herramienta que permite especificar opciones de formato que se
aplicarn a las unidades de programa que sean desarrolladas. Estos parmetros de formateo
de cdigo deben configurarse de manera que cumplan con las recomendaciones del presente
documento.
Figura 1 Opciones del Editor de TOAD for Oracle
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin3
Fecha: 3/12/2008
Figura 2 Opciones de Formato de cdigo en TOAD for Oracle

Otra opcin es el uso de editores gratuitos que permitan parametrizar el numero de caracteres
para cuando se usa la un tabulador. Ejemplo:
PFE (Programmers File Editor). http://www.lancs.ac.uk/people/cpaap/pfe/
2.1.3
Alineacin
Considere las opciones de alineacin en el formateo de cdigo que realiza el editor de TOAD.
Adems, considere las siguientes recomendaciones:
Sentencias DECLARE, BEGIN, EXCEPTION, and END debern alinearse a la izquierda.
Las palabras claves de una sentencia SQL deben estar alineadas a la izquierda, clusulas
GROUP BY, ORDER BY, DELETE FROM, INSERT INTO, etc.
Cuando tenga ms de una sentencia condicional o sentencias de asignacin, alinee los
elementos para cada condicin Por ejemplo: El ejemplo presentado ms adelante contiene una
seccin que muestra la alineacin de este tipo de sentencias.
En declaraciones de procedimientos y funciones, alinee los nombres de parmetros cada uno a
la izquierda as como tambin los tipos de datos de cada parmetro. Observe el ejemplo
siguiente.
2.1.3.1 Ejemplos de sentencias SQL:
SELECT e.numero_etiqueta,
e.peso,
e.numero_piezas
FROM etiquetas e,
localizaciones l,
estados_localizaciones el
WHERE e.codigo_localizacion = l.codigo_localizacion
AND l.numero_sitio
= i_numero_sitio
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
AND
AND
AND
AND
AND
AND
AND
l.estado_localizacion = el.estado_localizacion
l.bandera_venta
= 'S'
l.tipo_localizacion = 'F'
e.numero_parte
= i_numero_parte
e.contrato
= i_contrato
e.numero_piezas
<> i_numero_piezas
e.numero_etiqueta NOT IN (SELECT numero_etiqueta
FROM ordenes
WHERE estado = 'ACTIVO');
UPDATE ordenes
SET estado = 'ACTIVO',
bandera_envio = 'Y'
WHERE numero_etiqueta = l_numero_etiqueta
AND numero_orden = i_numero_orden
AND codigo_orden = i_codigo_orden
AND numero_linea = i_numero_linea;
INSERT INTO ordenes
(numero_orden
,codigo_orden
,numero_linea)
VALUES
('123456'
,'O'
,1);
DELETE FROM ordenes
WHERE numero_orden = i_numero_orden
AND codigo_orden = i_ codigo_orden
AND numero_linea = i_ numero_linea;
2.1.3.2 Ejemplos de alineacin en programas

CREATEORREPLACEPROCEDUREcrear_envio
(i_numero_ordenINordenes.numero_orden%TYPE
,io_parametroINOUTNUMBER)
IS
CURSORl_cur_ordenes
IS
SELECTnumero_orden,
codigo_orden,
numero_linea
FROMdetalle_ordenes
WHEREnumero_orden=i_numero_orden;
l_reg_ordenesl_cur_ordenes%ROWTYPE;
BEGIN
OPENl_cur_ordenes;
FETCHl_cur_ordenesINTOl_reg_ordenes;
CLOSEl_cur_ordenes;
Versin4
Fecha: 3/12/2008
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin5
Fecha: 3/12/2008
FORl_contadorIN1..10LOOP
INSERTINTOenvios_ordenes
(numero_orden
,cdigo_orden
,numero_linea
,numero_envio)
VALUES
(l_reg_ordenes.numero_orden
,l_reg_ordenes.codigo_orden
,l_reg_ordenes.numero_linea
,l_contador);
ENDLOOP;
EXCEPTION
WHENOTHERSTHEN
raise_an_error;
ENDcreate_envio;
Ejemplo de una sentencia con mala alineacin:
l_mensaje:='Lasolicitudnmero'||i_numero_orden||'solicitada
por'||i_nombres_empleado||'hasidoenviadaconfecha'||
TO_CHAR(l_date_created,'MM/DD/YYYY');
Un mejor alineamiento sera:
l_mensaje:='Lasolicitudnmero'
||i_numero_orden
||''
||'solicitadapor'
||i_nombres_empleado
||''
||'hasidoenviadaconfecha'
||TO_CHAR(l_fecha_solicitud,'MM/DD/YYYY');
El cdigo que no se rige a las convenciones de alineacin puede resultar complicado en su

lectura por parte de un programador:
SET_ITEM_PROPERTY('block1.item1',ENABLE,PROPERTY_TRUE);
SET_ITEM_PROPERTY('block10.item2',ENABLE,PROPERTY_FALSE);
Una adecuada alineacin facilita la lectura del cdigo:

SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin6
Fecha: 3/12/2008
SET_ITEM_PROPERTY('block10.item2',ENABLE,PROPERTY_FALSE);
Al definir o invocar procedimientos con mltiples parmetros, ponga cada parmetro en una
lnea diferente:
PROCEDURE obtener_orden (numero_orden IN detalle_ordenes.numero_orden

%TYPE
,codigo_ordenINdetalle_ordenes.codigo_orden
%TYPE
,numero_lineaINdetalle_ordenes.numero_linea
%TYPE);
obtener_orden(l_numero_orden
,l_codigo_orden
,l_numero_linea);
Las comas deben ser ubicadas al inicio de la lnea en el caso de separar argumentos,
parmetros u otras listas encerradas en parntesis.
Las comas deben ser ubicadas al final de la lnea cuando son usadas para separar elementos
no contenidos entre parntesis, como en una lista de columnas en una sentencia SELECT.
3.
Comentarios
Incluya un comentario como encabezado en cada procedimiento y funcin. El encabezado

debe ser actualizado en cada modificacin realizada al cdigo. El encabezado debe ser un
resumen de la unidad de programa, por ejemplo:
/*
Autor:RLpez
Propsito:CrearunNuevoregistroenlatablaempleados
Estructura lgica: Documente el flujo bsico del programa en alto
nivel.
HistorialdeModificaciones:
FechaNombreResumendeRevisin
11/09/2007R.LpezCreacin
11/10/2007M.ReaAadidocdigodeseguridades
*/
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin7
Fecha: 3/12/2008
Una recomendacin para el caso de los cometarios es usar los wizard de creacin de
programas de TOAD, el cual agrega un encabezado para en cada creacin.
Use comentarios para explicar la lgica compleja en sus programas. En general, si se siguen
las convenciones de manera adecuada y se escribe cdigo de manera modular, la
programacin ser auto descriptible, es decir, no ser necesario agregar demasiados
comentarios.
Una recomendacin es no repetir en los comentarios lo que el cdigo por si solo puede
describir, por ejemplo:
sielcdigodeestadoesnuloentonceslanzarunaexcepcin
IF codigo_estado IS NULL THEN
RAISE FORM_TRIGGER_FAILURE;
END IF;
El ejemplo anterior es un comentario intil, pues el cdigo escrito describe la accin que se
est ejecutando.
El siguiente es un ejemplo de cmo un comentario ayuda a describir un clculo complejo:
/* 01/10/2007. Clculo aadido para corregir errores de redondeo
causados por el hecho de que se almacenan valores redondeados a 3
decimales.Bsicamenteelcdigoincrementaennmerodedgitos*/
SELECT (((ROUND(96 * (length_no - FLOOR(length_no)))/96) + FLOOR(length_no))
* cs.lbs_ft
* i_qty) exact_length
FROM cs_sizes cs,
part_description pd
WHERE pd.part_no = i_part_no
AND pd.contract = i_contract
AND pd.size_code = cs.size_code;
4.
Nombrado
Use nombres significativos. Evite el uso de nombres de variables pequeos o arbitrarios como
"x" o "var". stos nombres no transmiten el contenido almacenado en la variable. Los nombres
de los objetos dentro del cdigo deben proporcionar una auto-documentacin del mismo. En
otras palabras si nombramos los tems de manera significativa implcitamente indicamos lo que
estn realizando dentro del cdigo.
Si se est declarando una variable o un parmetro que haga referencia a un valor guardado en
una columna de la base de datos, use el nombre de la columna para declarar la variable. Por
ejemplo, v_nombre_empleado
Nunca use "a", "b", "c", etc. Como alias de tablas en sus sentencias SQL. En una consulta que
involucre algunas tablas se dificultar su lectura, comprensin y depuracin. Ejemplo:
SELECTa.fecha_orden
FROMordenesa,detalle_ordenesb,preciosc
WHERE a.numero_orden = b. numero_orden AND b.linea_orden =
c.linea_orden;
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin8
Fecha: 3/12/2008
Considere usar nombres significativos

SELECTord.fecha_orden
FROMordenesord,detalle_ordenesdet,preciosprc
WHEREord.numero_orden=det.numero_orden
ANDdet.linea_orden=prc.linea_orden;
Una tercera opcin es usar como alias las letras iniciales de los nombres de tablas
SELECTo.order_date
FROMordeneso,detalle_ordenesdo,preciosp
WHEREo.numero_orden=do.numero_orden
ANDdo.linea_orden=p.linea_orden;
El segundo y tercer ejemplos son aceptables, no as el primero. La tercera opcin puede

requerir pequeos ajustes cuando las iniciales de los nombres de las tablas involucradas en la
sentencia SQL coincidan, pero funciona.
Use guiones bajos
numero_orden_compra
para
separar
palabras
identificadores.
Por
ejemplo:
Cuando se declare tipos de datos de variables o parmetros que correspondan a columnas de

tablas de la base de datos, utilice el siguiente esquema:
nombre_tabla.nombre_columna%TYPE;
5.
Declaracin
5.1
Variables
El mbito de las variables est determinado por un prefijo, as:

Variables locales
v_nombre_variable
Incluye variables internas en

funciones y procedimientos
Variables Globales
g_nombre_variable
Variables a nivel de paquete
Constantes
c_nombre_constante
gc_nombre_constante
Cursores
cur_nombre_cursor
Note que los cursores pueden

ser identificados como locales
o globales tal como un
nombre de variable
Registros (records)
rec_nombre_registro
Aplica a registros definidos

por el programador tales como
registros en base a cursores o
tablas.
Tipos de cursores
ct_nombre_tipo_cursor
TYPEtcur_registro_mes
ISREFCURSOR
Tipos de Registros (record
rt_nombre_registro
TYPErt_registro_mes
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
type)
Versin9
Fecha: 3/12/2008
ISRECORD(
Tipos de Tabla PL/SQL
tt_nombre_tabla
TYPEtt_registro_mes
ISTABLEOF
rt_registro_mes
INDEXBY
BINARY_INTEGER;
Tablas PL/SQL
t_nombre_tabla
Tipos Varray
tv_nombre_arreglo
Variables Arreglos
v_nombre_variable
Parahacerreferencia
aunarreglosimpre
necesitaremosindicar
sundice
v_numero(1)
5.2
Parmetros
5.2.1
Parmetros en funciones y procedimientos
De entrada (IN)
i_nombre_parametro
De salida (OUT)
o_nombre_parametro
De entrada y salida (in out)
io_nombre_parametro
5.2.2
Parmetros en cursores
p_parametro_cursor
6.
Expresiones y Sentencias
6.1
Procedimientos y Funciones
Al nombrar procedimientos, use una combinacin de verbos y sustantivos que describan lo que
el procedimiento realiza. Por ejemplo
pro_generar_rol
AL nombrar funciones, piense en como la funcin ser invocada desde el cdigo y nmbrela de
acuerdo al contexto, por ejemplo, si el numero de cdula es no vlido la funcin
fun_cedula_valida retorna un valor BOOLEAN
fun_cedula_valida
IFfun_cedula_valida(codigo_empleado)THEN
"accin";
ENDIF;
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin
10
Fecha: 3/12/2008
El uso de una funcin llamada fun_cedula_valida hace al cdigo escrito ms entendible,

situacin contraria si se usa por ejemplo:
IFfun_validar_cedula(codigo_empleado)THEN
"accin";
ENDIF;
6.2
Bucles
Los bucles deben tener un solo punto de entrada y un solo punto de salida. Intente evitar el uso
de mltiples puntos de salida. Esto provoca que el cdigo se vuelva muy confuso.
Use etiquetas de bucles cuando trabaje con bucles anidados y cuando el cdigo entre el inicio y
fin del bucle sea muy extenso y provoque saltos de pgina. Ejemplos:
Bucles anidados sin etiquetas:
LOOP
algunassentencias;
EXITWHENcondicion_finalizacion_1;
LOOP
algunassentenciasqueocasionansaltosdepagina;
EXITWHENcondicion_finalizacion_2;
ENDLOOP;
ENDLOOP;
Usando etiquetas de bucle:
<<loop_clientes>>
LOOP
algunassentenciasqueocasionansaltosdepgina
EXITloop_clientesWHENcondicion_finalizacon_1;
<<loop_ordenes>>
LOOP
algunassentenciasqueocasionansaltosdepgina
EXITloop_ordenesWHENcondicion_finalizacon_2;
ENDLOOPloop_ordenes;
ENDLOOPloop_clientes;
6.2.1
For Loops
Los bucles FOR LOOP tienen la siguiente sintaxis:
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin
11
Fecha: 3/12/2008
FORl_iteracionesIN1..l_max_iteracionesLOOP
ENDLOOP;
Un bucle for loop debe ser usado cuando se requiere ejecutar un nmero especfico de
iteraciones
No obligue a salir del bucle hasta que el nmero de iteraciones se hayan ejecutado. No cambie
el valor del ndice del bucle para obligar una salida temprana del bucle.
6.2.2
Bucles While
Sintaxis:
WHILEl_condicion_booleanaLOOP
ENDLOOP;
Los bucles while deben ser usados cuando se requiere ejecutar hasta que ocurra una condicin
especfica (definida en la clusula WHILE). No fuerce la salida del bucle hasta que la condicin
se haya cumplido.
Los bucles while son una mayor alternativa a los bucles for loop si se requiere una ejecucin
iterativa hasta que ocurra una condicin. Simplemente se puede especificar una condicin
booleana a TRUE cuando necesite salir del bucle. No use bucles WHILE en lugar de bucles
FOR. Ejemplo:
l_valor:=1;
WHILEl_valor<=10LOOP
ENDLOOP;
Si el bucle tiene una estructura como el anterior, use un bucle FOR en lugar de ste.
6.2.2.1 Bucles Simples

Sentencias como EXIT y EXIT WHEN son muy usadas en bucles con condiciones de salida
complicadas. Especficamente, se debe usar bucles simples cuando requerimos una salida del
bucle en un lugar diferente al inicio del mismo.
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
6.2.3
Versin
12
Fecha: 3/12/2008
Cursores
Evite el uso de cursores implcitos. Use cursores explcitos

Un cursor explcito es aquel que se ha definido en el bloque de declaraciones. Un cursor
implcito es aquel usado por Oracle para realizar un fetch cuando se ha escrito sentencias
como SELECT INTO .
Los cursores explcitos son ms eficientes debido a que el programador controla manualmente
el nmero de extracciones (fetches).
Ejemplo de cursor implcito:
PROCEDUREpro_obtener_nombre_cliente
(i_codigo_clienteINclientes.codigo_cliente%TYPE
,o_nombres_clienteOUTclientes.nombres%TYPE
,o_apellidos_clienteOUTclientes.apellido%TYPE)
IS
BEGIN
SELECTnombres,
apellidos
INTOo_nombres_cliente,
o_apellidos_cliente
FROMclientes
WHEREcdigo_cliente=i_codigo_cliente;
END;
El mismo cdigo convertido a cursor explicito:
PROCEDUREobtener_nombres_cliente
(i_codigo_clienteINclientes.codigo_cliente.%TYPE
,o_customer_fnameOUTclientes.nombres%TYPE
,o_customer_lnameOUTclientes.apellidos%TYPE)
IS
CURSORl_cur_nombres
IS
SELECTnombres,
apellidos
FROMclientes
WHEREcodigo_cliente=i_codigo_cliente;
l_reg_nombresl_cur_nombres%ROWTYPE;
BEGIN
OPENl_cur_nombres;
FETCHl_cur_nombresINTOl_reg_nombres;
CLOSEl_cur_nombres;
o_nombres_cliente:=l_reg_nombres.nombres;
o_apellido_cliente:=l_reg_nombres.apellidos;
END;
A primera vista, los cursores explcitos son algo difciles de entender pues requieren un tanto
ms de cdigo, sin embargo, el manejo de excepciones se facilita:
una excepcin
TOO_MANY_ROWS no ser lanzada cuando se realizan FETCH manual desde un cursor
explicito, permitiendo definir las acciones si el caso se presentare, en lugar de manejar
excepciones. Esto proporciona al programador una mayor flexibilidad in la estructura del
cdigo
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin
13
Fecha: 3/12/2008
El uso de variables del tipo RECORD facilita cambios futuros en las columnas de sentencia
SELECT. No es necesario extraer datos en una variable tipo RECORD si se esta ejecutando
sentencias como SELECT 1, consultas COUNT u operaciones similares.
6.3
Sentencias IF
Se debe alinear las sentencias IF con su correspondientes ELSIF, ELSE, y END IF.
IFELSIFELSEEND IF es la versin PL/SQLs de la sentencia CASE. Si usa una clausula
ELSIF en su sentencia IF, debe incluir una clusula ELSE. Esto permitir capturar cualquier
otro caso que la lgica del programa no tome en cuenta. An si piensa que no es posible que
exista otra condicin, es una Buena prctica de programacin capturar cualquier condicin con
el uso de la clausula ELSE.
Ejemplo:
IFl_booleanTHEN
accion;
ELSIFNOTl_booleanTHEN
accion;
ENDIF;
El cdigo anterior trabaja con valores TRUE y FALSE, pero que pasa con el valor NULL?. Es
mejor usar (asumiendo que el valor NULL no ser tratado de la misma manera como los
valores TRUE o FALSE):
IFl_booleanTHEN
accion;
ELSIFNOTl_booleanTHEN
accion;
ELSE
lanzar_excepcion;
ENDIF;
7.
Manejo de Errores y Excepciones
La alineacin de la palabra clave EXCEPTION ser a la izquierda y alineada tambin con el

bloque BEGIN y END que contiene el manejador de excepciones. Identar las dems lneas.
Ejemplo:
BEGIN
(variossentenciasDML)
EXCEPTION
WHENe_excepcion_de_usuarioTHEN
ROLLBACK;
escribir_log;
WHENOTHERSTHEN
ROLLBACK;
RAISE;
END;
Considere que una sentencia DML puede necesitar realizar un rollback en caso de problemas.
Por tanto, se debe incluir un manejador de excepciones con el manejo de transacciones.
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin
14
Fecha: 3/12/2008
NO use el manejador de excepciones WHEN OTHERS a menos que realmente lo necesite.

Normalmente, se requerir tomar acciones especficas dependiendo del tipo de problema
encontrado. WHEN OTHERS est diseado para manejar excepciones no tratadas.
Los manejadores de excepciones dentro de funciones debern retornar un valor si la ejecucin
del programa debe continuar luego de la excepcin.
En general, no use manejadores de excepciones para capturar eventos que se supone
ocurrirn. En estos casos se recomienda el uso de lgica condicional. (Existen ciertos casos
en que la lgica condicional es una mejor alternativa por razones de performance, etc.)
8.
Desempeo y Reusabilidad
8.1
SQL del lado del Cliente
No se usar sentencias SQL almacenadas en unidades de programa locales o trigger en el

lado del cliente. El lado de cliente reduce el desempeo y la reusabilidad del cdigo.
Excepciones a esta regla incluyen:
Consultas de grupos de registros (Record group queries).
SQL implcito desarrollado por Oracle Forms en conjuncin con bloques de tablas de base de
datos.
Situaciones que requieran procesar individualmente los registros extrados desde un cursor en
el nivel de forma (por ejemplo, bloques manuales o popularizacin de grupos de registros
(record group population)).
Extraccin del siguiente valor de una secuencia de base de datos (u otras extracciones desde
la tabla DUAL)
Siempre se ha de ubicar las funciones y procedimientos de base dentro de un paquete. Esto
permite un mximo reuso de cdigo y permite tambin mayor flexibilidad para el DBA al
momento de mantener su paquete en el rea de memoria compartida en el servidor de base de
datos para mejor desempeo.
Asegrese de que una funcin o procedimiento no exista en un paquete antes de dedicarse a
escribir el cdigo. El administrador del programa ser el responsable de administrar los
paquetes compartidos.
8.2
Modularidad
El mejor camino para lograr la mnima duplicacin de cdigo es promover la modularidad

limitando los procedimientos y funciones a tareas individuales. Si su funcin o procedimiento
hace ms de una cosa, considere dividirlo en mltiples unidades de programa. Una regla
general es que si su procedimiento o funcin sobrepasa las 3 o 4 pginas, debera ser revisado
con el fin de lograr la modularidad en el cdigo.
Si se tiene ms de una pgina de cdigo en un bloque IF..END IF, podra ser dificultoso
interpretar dicho cdigo. No es necesario manejar cdigo con bloques IF demasiado grandes.
Evite el manejar cdigo de ms de una pgina en estructuras IF y LOOP separando su cdigo
en funciones y procedimientos que luego pueden ser invocados dentro de dichas estructuras.
Si se mantienen las unidades de programas pequeas y con nombres significativos, ser
mucho ms fcil que un nuevo programador que no haya tenido contacto con ese cdigo pueda
entenderlo en alto nivel de manera rpida.
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
8.3
Versin
15
Fecha: 3/12/2008
Cdigo duro
Nunca haga referencia a un valor literal dentro de sus programas. Existen muchas alternativas
para usar valores literales en el cdigo, incluyendo constantes, variables pblicas y privadas a
nivel de paquetes, parmetros de procedimientos y funciones, y constantes basadas en
tablas.
Ejemplo:
Cdigo
Valor
Numrico
ESTADO_CERRADO
Valor
Cadena
Valor Fecha
CERRADO
DESCRIPCIN
Estado que indica si un
pedido ha sido completado
En el ejemplo, al hacer referencia a la constante ESTADO_CERRADO, podemos obtener el

valor de requerido CERRADO. De esta manera, si en algn momento el valor debe cambiar a
COMPLETO, no ser necesario realizar ajusten en la programacin.
Como se pudo observar, una tabla de constantes comnmente esta formada por una columna
de cdigo y una columna para cada tipo de dato que pueda contener esa constante: numrico,
string y fecha; adems puede contener una columna de descripcin o comentarios.
Las nuevas versiones de Oracle permiten realizar cast de los valores almacenados con el tipo
de dato varchar2, de tal manera que una tabla de constantes puede reducirse de la siguiente
manera:
Cdigo
Valor
DESCRIPCIN
ESTADO_CERRADO
CERRADO
Estado que indica si un

pedido ha sido completado
Otra manera sutil de cdigo duro es el caso en que se tiene una formula que aparece en el
cdigo varias veces. En estos casos es necesario encapsular la lgica repetitiva en una
funcin dentro de un paquete de tal manera que pueda ser invocada desde cualquier punto de
la aplicacin, por tanto, si la lgica de la frmula cambia, el cambio en programacin se
centrar en un solo lugar.
8.4
Funciones de agrupamiento innecesarias
Las funciones de agrupamiento son costosas cuando involucran un gran nmero de filas.
Problemas desempeo se presentan cuando las funciones de agrupamiento son usadas donde
realmente no se requiere agrupar datos.
El ejemplo ms obvio de este problema lo encontramos con la funcin COUNT. Hay una regla
simple que debe ser recordada para evitar problemas de desempeo relacionados con sta:
No use COUNT a menos que necesite conocer el nmero exacto de filas que cumplen con su
criterio de consulta. Nunca use COUNT si requiere solamente conocer si existe una fila o
mltiples filas. El uso de cursores explcitos y de extracciones (fetch) del nmero de registros
que necesite, satisface este requerimiento.
Ejemplo de una consulta COUNT innecesaria: Asumamos que se requiere conocer si existen 0,
1 o muchas filas de tal manera de lanzar una excepcin si no existen (zero), usar el dato
encontrado (si hay uno), o desplegar una lista que permita escoger al usuario el registro
correcto (muchos):
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin
16
Fecha: 3/12/2008
DECLARE
l_nombresclientes.nombres%TYPE;
l_contadorNUMBER:=0;
BEGIN
l_nombre:='ROBERTO'
SELECTNVL(COUNT(1),0)
INTOl_contador
FROMclientes
WHEREnombres=l_nombres;
IFl_contador=0THEN
desplegar_error;
ELSIFl_contador=1THEN
usar_dato;
ELSE
desplegar_lista;
ENDIF;
END;
Este procedimiento puede ser escrito de la siguiente manera:
DECLARE
CURSORl_cur_nombres
IS
SELECT1
FROMclientes
WHEREname=l_name;
l_nombresclientes.nombres%TYPE;
l_encontradoNUMBER:=0;
BEGIN
l_nombres:='ROBERTO';
OPENl_cur_nombres;
LOOP
FETCHl_cur_nombresINTOl_encontrado;
EXITWHENl_cur_nombres%NOTFOUNDORl_cur_nombres%ROWCOUNT>1;
ENDLOOP;
IFl_cur_nombres%ROWCOUNT=0THEN
CLOSEl_cur_nombres;
desplegar_error;
ELSIFl_cur_nombres%ROWCOUNT=1THEN
CLOSEl_cur_nombres;
usar_dato;
ELSE
CLOSEl_cur_nombres;
desplegar_lista;
ENDIF;
END;
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
9.
Estndares de nombrado
9.1
Base de Datos
9.1.1
Objetos de BDD
Versin
17
Fecha: 3/12/2008
La siguiente lista de reglas se aplica a los identificadores:

Longitud de 1 a 30 bytes con las siguientes excepciones:
Nombres de bases de datos estn limitadas a 8 bytes.
Nombres de database links pueden tener una longitud de 128 bytes.
Deben ser diferentes a las palabras reservadas de Oracle Database.
Objeto
Descripcin
Ejemplo
Tablespaces
Nombre significativo. Se recomienda usar un tablespace

para datos y otro para ndices
comercial_dat
Nombres tablespace
comercial_dat_01.dbf
Sufijo _DAT para tablespaces de datos, _IDX para el caso

de tablespaces designado para almacenar ndices
comercial_idx_01.dbf
Nombre directorio
ARCHIVOS_DIR
Data Files
Directorios
comercial_idx
Sufijo _DIR
Usuarios
Usuarios deben tener relacin con los nombres de

usuarios registrados en e l domino REDEMELNORTE
elopez
Tablas
Nombre largo
t_clientes
Prefijo T
identificador de modulo (3 caracteres y subguin)
Nombre tabla en plural
Nombre corto
tcomcli
Prefijo T
identificador de modulo (3 caracteres)
Nombre corto de la tabla (3 caracteres)
Vistas
Prefijo V
vcom_clientes
Identificador de mdulo
Nombre de la vista
ndices
Nombre columna (nombre del ndice)
codigo_cliente_idx
Sufijo _IDX
Los ndices correspondientes a claves primarias debern
contener el sufijo _PK
Secuencias
Sufijo SEQ_
Nombre corto de tabla donde es usada_
Nombre de la secuencia
Columnas
Nombre de columna
SEQ_PTOMED_CODI
GO
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Claves Primarias
Nombre de clave
Versin
18
Fecha: 3/12/2008
orden_compra_pk
Sufijo _PK
Claves Forneas
Prefijo (nombre corto) de la tabla a la que se hace

referencia
cli_codiigo_cliente_fk
Nombre de columna
Sufijo _FK
Check
Nombre de chexk constraint
cedula_nula_ck
Sufijo _CK
Procedimientos
Prefijo PRO_
pro_calcular_rol
Nombre procedimiento
Funciones
Prefijo FUN_
fun_cedula_valida
Nombre procedimiento
Paquetes
Identificador de paquete PCK_
pck_db_clientes
Indentificador de base de datos DB_

Nombre paquete
Triggers
Prefijo TR_
Abreviatura accin (AF)After, (BF)Before, (IN)Insert,
(UP)Update, (DL)Delete _
orden_compra_aiu
acceso_bd
Nombre trigger
Jobs
Sinnimos
En el mayor de los casos se usa el mismo nombre del

objeto al cual el sinnimo hace referencia
DB Links
Prefijo DBL_
dbl_alpha
Base de datos a la que hace referencia

Vistas
Materializadas
Prefijo VM_
vm_com_clientes
Identificador mdulo (3 caracteres)

Nombre de la vista materializada
Roles
Prefijo ROL_
Identificador de mdulo
Nombre del rol
9.1.2
Informacin de auditora
En general, las tablas que involucren:
Parametrizacin
Transacciones de la aplicacin
Seguridades
Debern incluir siempre las siguientes columnas de auditora:
USUARIO_CREACION
FECHA_CREACION
USUARIO_MODIFICACION
com_rol_cajero
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
Versin
19
Fecha: 3/12/2008
FECHA_MODIFICACION
9.1.2.1 Opcin de Journal tables de Oracle Designer.

Al tener el modelo de Base de Datos en la herramienta Oracle Designer, existe la opcin de
usar las siguientes caractersticas:
Journal Tables
Una tabla journal permite almacenar el detalle sobre cada insert, update o delete realizados en
la tabla asociada.
Table API
Un conjunto de objetos del lado del servidor (triggers y packages) diseados para
asegurara las reglas de datos en el servidor independientemente del tipo de aplicacin
cliente
9.1.3
Glosario de prefijos
Prefijo
Significado
Mdulos/Sistemas
GEN_
GENERAL. catlogos generales que pueden ser

comunes a los diferentes mdulos
COM
COMERCIAL
PRE_
PRESUPUESTO
CON_
CONTABILIDAD
ADQ_
ADQUISICIONES
CFG_
CONFIGURACIONES
NBX_
NOM_
NOMINAS
FAC_
FACTURACION
INV_
INVENTARIOS
Abreviaturas
CCO
Centros de Costo
LOC
Localizaciones
ARE
Areas
Prefijo
Significado
Esquemas (Usuarios propietarios de los

diferentes mdulos o sistemas)
SIGORG
Sistema de gestin de la organizacin
SIGCOM
Sistema comercial
SIGPRE
PRESUPUESTO
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
SIGCON
CONTABILIDAD
SIGADQ
ADQUISICIONES
SIGCFG
CONFIGURACIONES
NBX
SIGNOM
NOMINAS
SIGFAC
FACTURACION
SIGINV
INVENTARIOS
MEM
Mercado Elctrico Mayorista
Abreviaturas
9.2
CCO
Centros de Costo
LOC
Localizaciones
ARE
Areas
Oracle Forms
Objeto
Prefijo
Ejemplo
Nombres de
Formas
MEM_F_
MEM_F_CENTRAL.fmb
Alertas
ALE
ALE_ATENCION
Libreras PLSQL
LIB
LIB_ARCHIVOS
Libreras de objetos
LIB_OBJ_
LIB_OBJ_MEM
Bloques
El mismo nombre
de la fuente de
datos
t_com_clientes
Bloques de control
CTL
CTL01
Canvas
CNV
CNVCLIENTES
Parmetros
P_
P_CODIGO_EMPRESA
Grupos de
Registros
GRP_
GRP_EMPLEADOS
Atributos Visuales
VIS_
VIS_REGISTRO_ACTUAL
LOVs
LOV_
LOV_EMPLEADOS
Procedimientos
PRO_
PRO_REGISTRAR
Funciones
FUN_
FUN_HABILITAR_ITEM
Paquetes
PCK_FRM
FRM_PCK_ITEMS
Ventanas
VEN
VEN_CLIENTES
Mens
MEN_
MEN_ARCHIVO
Botones
BTN_
BTN_CERRAR
(Mdulo)
Versin
20
Fecha: 3/12/2008
SIGPRE
Presupuestaria
Confidencial
EMELNORTE
S. A. 2008
9.3
Versin
21
Fecha: 3/12/2008
Oracle Reports
Objeto
Prefijo
Ejemplo
Nombres de
Reportes
Prefijo identificador del mdulo PRE_
pre_periodos.rdf
Parmetros
Prefijo P_
Nombre reporte
P_CODIGO_EMPRESA
Nombre del parmetro

Procedimientos
PRO_
PRO_REGISTRAR
Funciones
FUN_
FUN_HABILITAR_ITEM
Paquetes
REP_PCK_
REP_PCK_ITEMS

Guía de Programación Oracle

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Guía de Programación Oracle

Transféré par

Droits d'auteur :

Formats disponibles

SIGPRE - Sistema de Gestin para

Convenciones Objetos de BDD

Revisin del personal tcnico del centro de

Se agrega convenciones para uso de

Organizacin de Cdigo y Estilos......................................................................................... 1

Estndares para formato de cdigo...............................................................................1

Parmetros en funciones y procedimientos............................................................8

Manejo de Errores y Excepciones.......................................................................................12

SQL del lado del Cliente............................................................................................... 12

Funciones de agrupamiento innecesarias....................................................................14

Gua de Programacin Oracle

El propsito de sta gua es establecer un estndar o convencin de nombrado para el

Aplicable al desarrollo de aplicaciones sobre plataforma Oracle:

Organizacin de Cdigo y Estilos

Estndares para formato de cdigo

Use tres espacios (en lugar de TAB) en los siguientes casos:

Los Tabuladores no almacenan el cdigo de manera apropiada en la Base de datos

Figura 1 Opciones del Editor de TOAD for Oracle

Figura 2 Opciones de Formato de cdigo en TOAD for Oracle

2.1.3.2 Ejemplos de alineacin en programas

El cdigo que no se rige a las convenciones de alineacin puede resultar complicado en su

Una adecuada alineacin facilita la lectura del cdigo:

PROCEDURE obtener_orden (numero_orden IN detalle_ordenes.numero_orden

Incluya un comentario como encabezado en cada procedimiento y funcin. El encabezado

Considere usar nombres significativos

El segundo y tercer ejemplos son aceptables, no as el primero. La tercera opcin puede

Cuando se declare tipos de datos de variables o parmetros que correspondan a columnas de

El mbito de las variables est determinado por un prefijo, as:

Incluye variables internas en

Variables a nivel de paquete

Note que los cursores pueden

Aplica a registros definidos

Tipos de Registros (record

Tipos de Tabla PL/SQL

Parmetros en funciones y procedimientos

De entrada y salida (in out)

El uso de una funcin llamada fun_cedula_valida hace al cdigo escrito ms entendible,

Bucles anidados sin etiquetas:

Usando etiquetas de bucle:

Los bucles FOR LOOP tienen la siguiente sintaxis:

6.2.2.1 Bucles Simples

Evite el uso de cursores implcitos. Use cursores explcitos

Manejo de Errores y Excepciones

La alineacin de la palabra clave EXCEPTION ser a la izquierda y alineada tambin con el

NO use el manejador de excepciones WHEN OTHERS a menos que realmente lo necesite.

SQL del lado del Cliente

No se usar sentencias SQL almacenadas en unidades de programa locales o trigger en el

El mejor camino para lograr la mnima duplicacin de cdigo es promover la modularidad

En el ejemplo, al hacer referencia a la constante ESTADO_CERRADO, podemos obtener el

Estado que indica si un

Funciones de agrupamiento innecesarias

Este procedimiento puede ser escrito de la siguiente manera:

La siguiente lista de reglas se aplica a los identificadores:

Nombre significativo. Se recomienda usar un tablespace

Sufijo _DAT para tablespaces de datos, _IDX para el caso

Usuarios deben tener relacin con los nombres de

Nombre columna (nombre del ndice)

Prefijo (nombre corto) de la tabla a la que se hace

Nombre de chexk constraint

Identificador de paquete PCK_

Indentificador de base de datos DB_

En el mayor de los casos se usa el mismo nombre del

Base de datos a la que hace referencia

Identificador mdulo (3 caracteres)