Professional Documents
Culture Documents
Código:
Último revisor :
Vigencia hasta :
Autor:
Revisor:
Usuarios:
Dirigir Consultas a:
Índice
........................................................................................................................................................................2
2.Pauta para variables y estructuras de datos..................................................................................................3
3.Pauta para declaración y uso de variables de paquetes..............................................................................10
4.Pautas para el uso de estructuras de Control..............................................................................................14
5.Pautas para el manejo de excepciones.......................................................................................................18
6.Pautas mínimas para uso de SQL dentro de PL/SQL..................................................................................25
7.Reglas generales para performance ...........................................................................................................31
1.
2. Pauta para variables y estructuras de datos
• Declarar, definir el tipo, inicializar y asignar valor por defecto a las estructura de
datos antes de trabajar con ellas.
PL/SQL es un lenguaje fuertemente tipificado. Esto significa que antes de trabajar con
cualquier tipo de estructura de datos, es necesario declarar las mismas, definir el tipo y
opcionalmente inicializarlas o asignarles un valor por defecto.
Para el tipo VARCHAR2, Oracle separa la memoria necesaria según la longitud definida.
Es muy común ‘Hardcodear’ la longitud del mismo a su máxima tamaño para evitar
problemas, a costo de utilizar mas memoria de la necesaria. Aquí nuevamente se hace
conveniente el uso de %TYPE o %SUBTYPE para un mejor aprovechamiento de los
recursos de memoria.
Ejemplo:
Mal:
DECLARE
l_apellido VARCHAR2(45);
l_mensaje VARCHAR2(2000);
Bien:
DECLARE
l_apellido personas.nom_apellido%TYPE;
l_mensaje par_mensajes.mensaje%TYPE;
• En los datos numéricos, definir la precisión.
Ejemplo:
Mal:
DECLARE
l_importe NUMBER;
Bien:
DECLARE
l_importe NUMBER(12,2);
Permite que ciertos valores no sean modificados por otros desarrolladores y asegura que
los datos que se consideran confidenciales o que se utilizan en fórmulas o
parametrizaciones no sean manipulados en los códigos.
Ejemplo:
DECLARE
l_fec_actual DATE := TRUNC(SYSDATE);
l_trj_banco VARCHAR2(4) := ‘VISA’;
• Siempre que sea posible, utilizar el tipo de dato RECORD para manejar
estructuras.
Mal:
DECLARE
l_nombre personas.nom_nombre%TYPE;
l_apellido personas.nom_apellido%TYPE;
l_edad personas.num_edad%TYPE;
Bien:
DECLARE
TYPE r_persona IS RECORD
(nombre personas.nom_nombre%TYPE,
apellido personas.nom_apellido%TYPE,
edad personas.num_edad%TYPE);
Ejemplo:
Mal:
DECLARE
l_last_calificacion calificaciones.valor%TYPE:=last_busqueda (SYSDATE);
l_min_calificacion INTEGER:=a_calificacion.limits(a_calificacion.low);
BEGIN
Bien:
DECLARE
l_last_calificacion calificaciones.valor%TYPE;
l_min_calificacion INTEGER;
PROCEDURE init IS
BEGIN
l_last_calificacion := last_busqueda(SYSDATE);
l_min_calificacion := a_calificacion.limits(a_calificacion.low);
EXCEPTION
-- Manejo de errores en el programa.
END;
BEGIN
init;
Ejemplo:
Mal:
IF l_salario_total BETWEEN 10000 AND 50000
AND emp_estado(rec_empleado.numero) = 'N'
AND (MONTHS_BETWEEN (rec_empleado.fec_ingreso, SYSDATE) > 10) THEN
emp_informar(rec_empleado.empno);
END IF;
Bien:
DECLARE
condicion_para_informar BOOLEAN;
BEGIN
condicion_para_informar := total_sal BETWEEN 10000 AND 50000 AND
emp_estado(rec_empleado.numero) = 'N'
AND (MONTHS_BETWEEN (rec_empleado.fec_ingreso, SYSDATE) > 10;
.........
IF condicion_para_informar THEN
emp_informar(rec_empleado.empno);
END IF;
EXCEPTION
WHEN OTHERS THEN -- definir el manejo de errores.
…
END;
PROCEDURE check_control (
p_nro_cuenta IN cuentas.nro_cuenta%TYPE,
p_importe IN VARCHAR2)
IS
l_contador NUMBER(3);
l_baja BOOLEAN;
l_fecha_movimiento DATE := SYSDATE;
BEGIN
l_fecha_movimiento := r_cuenta.fecha_ult_mov (p_nro_cuenta);
IF ADD_MONTHS (SYSDATE, -60) > l_fecha_movimiento THEN
Informar_cuenta;
ELSIF ADD_MONTHS (SYSDATE, -24) > l_fecha_movimiento THEN
Check_baja (p_nro_cuenta, l_baja);
IF l_baja AND
/* agregado para forzar false */ FALSE THEN
armar_carta (p_nro_cuenta);
END IF;
-- arma proceso para control
-- pkg_procesos_cuenta.iniciar_control (p_nro_cuenta);
END IF;
END;
Lo que se puede observar es lo siguiente:
o p_Importe esta declarado, no se usa y no tiene asignación por defecto, por lo cual el valor
es totalmente ignorado.
o l_contador esta declarada, pero no se usa.
o l_fecha_movimiento está asignado con sysdate e inmediatamente recibe el valor de
r_cuenta.fecha_ult_mov (p_nro_cuenta);.
o La llamada a armar_carta se desactivo con el agregado de FALSE.
o La llamada a pkg_procesos_cuenta.iniciar_control esta comentada.
En algunos escenarios es crucial tener rutinas de cierre o limpieza, las cuales se deben
incluir al finalizar el programa y al final de cada excepción. Generalmente son
aplicables para el uso de cursores y manejo de archivos. A continuación se muestra
ejemplos:
Ejemplo:
Mal:
DECLARE
c_cursor NUMBER(2);
f_file UTL_FILE.FILE_TYPE;
BEGIN
c_cursor := DBMS_SQL.OPEN_CURSOR;
f_file := UTL_FILE.FOPEN (‘c:\temp’,’archivo.txt’, ‘R’);
….
EXCEPTION
WHEN NO_DATA_FOUND THEN
log_error;
RAISE;
END;
Se puede observar que tanto el cursor, como el archivo quedan abiertos en caso de existir alguna
excepción.
Bien:
DECLARE
c_cursor NUMBER(2);
f_file UTL_FILE.FILE_TYPE;
PROCEDURE limpiar
IS
IF c_cursor%ISOPEN THEN
DBMS_SQL.CLOSE (c_cursor);
END IF;
UTL_FILE.FCLOSE(f_file);
END limpiar;
BEGIN
c_cursor := DBMS_SQL.OPEN_CURSOR;
f_file := UTL_FILE.FOPEN (‘c:\temp’,’archivo.txt’, ‘R’);
…
limpiar;
EXCEPTION
WHEN NO_DATA_FOUND THEN
log_error;
limpiar;
raise;
END;
Ahora se puede ver que se definió la rutina que realiza el cierre de archivo y de cursor. Este tipo de
práctica evita que se produzcan errores que indiquen que el archivo está en uso o que el cursor ya se
encuentra abierto, cuando la rutina es llamada de distintos puntos, además que facilita a otros
desarrolladores agregar nuevas estructuras y contemplar el cierre o limpieza de las mismas.
Si bien es sabido que PL/SQL maneja las conversiones implícitas, existen al menos dos
grandes problemas con esto.
Las reglas de conversión no están bajo el control de desarrollador. Pueden cambiar con
el upgrade a una versión de Oracle o con el cambio de parámetros como
NLS_DATE_FORMAT.
Se puede convertir con el uso explícito de funciones como son: TO_DATE, TO_CHAR,
TO_NUMBER y CAST.
Ejemplo:
Mal:
DECLARE
l_fecha_fin DATE := ’01-MAR-04’;
Este código puede dar error si los parámetros de inicialización no corresponden a DD-MON-YY o DD-
MON-RR.
Bien:
DECLARE
l_fecha_fin date := TO_DATE (’01-MAR-04’,’DD-MON-RR’);
En este caso el uso de conversiones explícitas evita errores y no se esta sujeto a condiciones
externas del programa.
3. Pauta para declaración y uso de variables de paquetes.
Nunca colocar literales ‘en duro’, como ‘SI’ o 150 en el código. Es conveniente crear un
paquete para mantener estos nombres y valores publicados en reemplazo de los
literales.
Este tipo de práctica permite que el código no luzca ‘hard codeado’, lo cual lo hace
mas legible y mantenible y además evita que los literales sean modificados.
A medida que se usan los features del lenguaje, se definirán distintos TYPE entre los
que podemos incluir:
Esto permite tener estandarizados los tipos de datos para que sean usados por múltiples
programas. Los desarrolladores pueden escribir más rápidamente y disminuir los bugs.
También simplifica el mantenimiento de los types, ya que solo es necesario modificar
el/los paquetes donde están declarados.
Ejemplo
Una variable global es una estructura de datos que se puede referenciar fuera del
alcance o bloque en donde está declarada.
Cuando se declara una variable en un paquete, existe y retiene su valor durante la
duración de la sesión.
Son peligrosas porque crean dependencias ocultas o efectos laterales. El seguimiento de
las mismas es complejo, ya que es necesario ver la implementación para ver sus
instancias.
Una solución general para esto es pasar estas variables globales como un parámetro
para no referenciarlas directamente en el programa.
Ejemplo
En esta función el retorno depende de la variable global g_tasa_diaria. Esto hace que se pierda
flexibilidad ya que la función solo puede trabajar con el valor instanciado y además, si no tiene
valor, se corre el riesgo de que no trabaje en forma correcta.
• Exponer las variables globales de los paquetes usando ‘get and set’.
Ejemplo
END pkg_calculo_gastos;
Facilmente podemos manipular los datos desde cualquier lugar haciendo mención a:
BEGIN
pkg_calculo_gastos.g_gasto_mensual := 15;
….
Para evitar esto y poder manipular los datos según las reglas del negocio se puede reescribir el
código agregando ‘set’ y ‘get’ de esta manera:
CREATE OR REPLACE PACKAGE pkg_calculo_gastos IS
FUNCTION dias_atraso (p_cuenta IN cuentas.nro_cuenta%TYPE)
RETURN INTEGER;
END pkg_calculo_gastos;
Cada estructura repetitiva tiene un punto de control por donde se debe producir su
salida.
Combinando estos ciclos se puede hacer que las estructuras tengan un único punto de
control para el ciclo repetitivo. Esto facilita la lectura, comprensión y mantenimiento
del programa y permite hacer modificaciones en forma más simple.
• Una función debe tener un único RETURN exitoso como última línea de la
sección ejecutable. Normalmente, cada manejador de excepciones puede
retornar un valor.
Ejemplo
LOOP
read_line (file1, line1, file1_eof);
read_line (file2, line2, file2_eof);
IF (file1_eof AND file2_eof) THEN
RETURN (TRUE);
ELSIF (line1 != line2) THEN
RETURN (FALSE);
ELSIF (file1_eof OR file2_eof) THEN
RETURN ( FALSE);
END IF;
END LOOP;
Aquí existen muchas salidas, por lo que esto se puede reemplazar por lo siguiente:
...
LOOP
read_line (file1, line1, file1_eof);
read_line (file2, line2, file2_eof);
IF (file1_eof AND file2_eof) THEN
retval := TRUE;
exit_loop := TRUE;
ELSIF (line1 != line2) THEN
retval := FALSE;
exit_loop := TRUE;
ELSIF (file1_eof OR file2_eof) THEN
retval := FALSE;
exit_loop := TRUE;
END IF;
EXIT WHEN exit_loop;
END LOOP;
RETURN (retval);
En este caso se contemplan las condiciones en muchos puntos, pero se evalúa la salida solo en un
lugar para después realizar el RETURN.
Ejemplo
DECLARE
CURSOR c_cuenta IS
SELECT nro_cuenta
FROM cuentas;
r_cuenta cuentas%ROWTYPE;
BEGIN
FOR r_cuenta in c_cuenta LOOP
Calcula_saldo(r_cuenta.nro_cuenta);
END LOOP;
DBMS_OUTPUT.PUT_LINE(r_cuenta.nro_cuenta);
END;
La línea que se encuentra fuera del loop, retorna nulo, ya que está fuera del alcance del mismo.
La línea que se encuentra fuera del loop, retorna nulo, ya que está fuera del alcance
del mismo.
DECLARE
IF SEXO = ‘M’ THEN
<<sentencias>>
ELSIF SEXO = ‘F’ THEN
Ejemplo
DECLARE
l_logica BOOLEAN;
BEGIN
IF l_logica = TRUE THEN
…
ELSIF l_logica = FALSE THEN
…
END IF;
END;
Reemplazar por
DECLARE
l_logica BOOLEAN;
BEGIN
IF l_logica THEN
…
ELSIF NOT l_logica THEN
…
END IF;
END;
5. Pautas para el manejo de excepciones
Aunque se escriba un código perfecto, que no contenga errores y que nunca realice
operaciones inapropiadas, el usuario podría usar el programa incorrectamente,
produciendo una falla que no estaba contemplada.
El uso de excepciones permite capturar y administrar los errores que se pueden
producir dentro del código. Su buen uso trae como resultado un código con menos bugs
y mas fácil de corregir.
BEGIN
pkg_cuenta.determinar_estado (l_cuenta, error_code, error_msg);
IF error_code != 0 THEN
err.log (...);
GOTO end_of_program;
END IF;
pkg_cuenta.imprimir_estado (l_cuenta, error_code, error_msg);
IF error_code != 0 THEN
err.log (...);
GOTO end_of_program;
END IF;
END;
Cuando los programas PL/SQL son llamados por otros lenguajes de programación (Java,
Visual Basic, etc), al menos es necesario regresar el estado de error (código y mensaje)
para que administren los mismos.
Una manera sencilla de hacer esto es sobrecargar el programa original con otro del
mismo nombre y dos parámetros adicionales.
Ejemplo
Los desarrolladores pueden llamar al procedimiento que deseen y chequear los errores
de la manera mas apropiada para sus programas.
err.raise (errnums.sueldo_muy_bajo);
Los desarrolladores no tienen que determinar cual es el número de error que tienen que
usar, solo pasan la constante que desean usar y dejan que la rutina determine cual es el
RAISE correspondiente.
Ejemplo
PROCEDURE lecturas
IS
l_cuenta cuentas.nro_cuenta%TYPE;
l_linea VARCHAR2(1023);
fid UTL_FILE.FILE_TYPE;
no_table_data EXCEPTION;
no_file_data EXCEPTION;
BEGIN
BEGIN
--
SELECT nro_cuenta
INTO l_cuenta
FROM usrdemo.cuentas
WHERE 1 = 2;
EXCEPTION
WHEN NO_DATA_FOUND THEN
RAISE no_table_data;
END;
--
BEGIN
fid := UTL_FILE.FOPEN ('c:\temp', 'texto.txt', 'R');
UTL_FILE.GET_LINE (fid, l_linea);
UTL_FILE.GET_LINE (fid, l_linea);
EXCEPTION
WHEN NO_DATA_FOUND THEN
RAISE no_file_data;
END;
--
EXCEPTION
WHEN no_table_data THEN
pl ('Sin filas!');
WHEN no_file_data THEN
pl ('Leyendo fin de archivo!');
END lecturas;
Ejemplo
EXCEPTION
WHEN NO_DATA_FOUND THEN
l_msg := ‘Cuenta sin titular ‘|| to_char (p_cuenta);
l_err := SQLCODE;
l_prog := ‘EJEMPLO’ ;
INSERT INTO usrdemo.errlog (cod_error, des_msg, num_linea,
fec_ocurrencia, cod_usuario) VALUES (l_err, l_msg, l_prog,
SYSDATE, USER);
END;
EXCEPTION
WHEN NO_DATA_FOUND THEN
Err.handle (‘Cuenta sin titular’ ||to_char(p_cuenta), log => TRUE,
reraise => FALSE);
END;
Esta manera permite que todos manejen el error de la misma forma y hace más simple
el mantenimiento en caso de querer agregar funcionalidad a la administración de los
mismos.
Oracle define 1000 números de error, entre –20000 y –20999 para usar para nuestra
aplicación.
Se recomienda definir todos los errores en una tabla o un archivo del sistema operativo,
construir paquetes para manipular esos datos y ejecutar el RAISE usando esos nombres
y no códigos en duro.
Ejemplo
• Usar WHEN OTHERS solo para excepciones desconocidas que deben ser
ejecutadas.
No es conveniente usar WHEN OTHERS para cualquier error. Si se puede conocer el tipo
de excepción que se quiere ejecutar, es conveniente administrarla en forma específica.
Ejemplo
EXCEPTION
WHEN OTHERS THEN
IF SQLCODE = -1 THEN
Update_instancia(..);
ELSE
Err.log;
RAISE;
END IF;
END …;
Esta forma es mucho mas clara.
EXCEPTION
WHEN DUP_VAL_ON_INDEX THEN
Update_instancia(..);
WHEN OTHERS THEN
Err.log;
RAISE;
END …;
Es mas fácil leer lo que se espera que haga el código y además se evita el hardcodeo de
números de errores.
6. Pautas mínimas para uso de SQL dentro de PL/SQL
• Usar transacciones autónomas para aislar los efectos del ROLLBACK y COMMIT
Permite grabar o realizar rollback dentro de un código PL/SQL sin afectar la sesión
principal. Para hacer una transacción autónomas es necesario incluir en sección de
declaración la siguiente sentencia.
PRAGMA AUTONOMOUS_TRANSACTIONS;
Ejemplo
PROCEDURE log_error (
p_code IN error_log.errcode%TYPE,
p_msg IN error_log.errtext%TYPE)
IS
PRAGMA AUTONOMOUS_TRANSACTION;
BEGIN
INSERT INTO usrdemo.error_log (errcode, errtext, created_on,
created_by) VALUES(code, msg, SYSDATE, USER);
COMMIT;
EXCEPTION
WHEN OTHERS THEN
ROLLBACK;
END log_error;
Con este tipo de transacción se puede logear la transacción sin afectar la sesión
principal.
Cuando los procedimientos PL/SQL son llamados por otros lenguajes de programación
(Java, Visual Basic, etc.) no deben utilizar las sentencias de manejo de transacciones
COMMIT o ROLLBACK de modo de posibilitar un ordenado control de transacciones.
• Usar COUNT solo cuando es necesario saber el número de ocurrencias.
No usar COUNT para saber si hay una o más de una fila para una condición dada.
Solo se debe usar COUNT para saber cuantas filas hay.
Ejemplo
FUNCTION existe_filas(
p_tabla IN VARCHAR2,
p_condicion IN VARCHAR2 DEFAULT NULL,
p_cant_reg IN NUMBER DEFAULT 1)
RETURN BOOLEAN
IS
retval BOOLEAN := FALSE;
l_registros NUMBER;
l_cadena VARCHAR2(500);
BEGIN
BEGIN
l_cadena := 'SELECT count(1) FROM '||p_tabla ||' WHERE ';
IF p_condicion IS NOT NULL THEN
l_cadena := l_cadena ||p_condicion ||' AND ';
END IF;
EXECUTE INMEDIATE l_cadena||' ROWNUM < '||TO_CHAR(p_cant_reg + 1)
INTO l_registros;
IF l_registros >= p_cant_registros THEN
retval :=TRUE;
END IF;
EXCEPTION
WHEN OTHERS THEN
DBMS_OUTPUT.PUT_LINE('error '||SQLERRM);
END;
RETURN retval;
END existe_filas;
Esta forma permite tener una función genérica que evita recorrer toda la tabla y evita
problemas en caso de ser una tabla muy grande.
DECLARE
CURSOR c_cuentas IS
SELECT nro_cuenta,
fec_alta,
nom_apellido
FROM usrdemo.cuentas
WHERE titular = TRUE;
BEGIN
FOR r_cuentas IN c_cuentas LOOP
pl (r_cuentas.nro_cuenta || ': ' ||r_cuentas.nom_apellido);
END LOOP;
END;
El FOR LOOP está diseñado para múltiples filas de un cursor. Para un solo registro es
más eficiente un SELECT INTO o un cursor explícito.
Los cursores retornan información como lo haría una función, por lo cual también
pueden aceptar parámetros. Si se define un cursor con parámetros, se puede hacer que
sea reutilizable en diferentes circunstancias de un programa. Esto es mejor si se define
en un paquete.
Ejemplo
BEGIN
OPEN pkg_cta.c_titular(10);
• Usar RETURNING para obtener información sobre filas modificadas
Esta cláusula permite obtener información de las filas que se modificaron por INSERT,
UPDATE o DELETE.
Ejemplo
SELECT per_id
INTO l_per_id
FROM usrdemo.personas
WHERE apellido = p_apellido;
Hay un solo set de atributos SQL% en una sesión, el cual refleja la última operación
implícita realizada. Por lo cual el uso de estos atributos deberá hacerse con el mínimo
uso de código entre la operación y la referencia al atributo. De otra manera el valor
retornado por el atributo podría no corresponder al SQL deseado.
Ejemplo
BEGIN
SELECT nro_cliente,
nombre,
fecha_alta
BULK COLLECT INTO
l_nro_clientes,
l_nombres,
l_fechas
FROM usrdemo.clientes
WHERE sucursal_id = p_sucursal_id;
...
END procesar_clientes;
Se debe tener cuidado cuando el SELECT retorna miles de filas ya que si el mismo
programa está corriendo con diferentes usuarios en una misma instancia, puede haber
problemas de memoria.
Se podría restringir usando ROWNUM o LIMIT para cada instancia.
BEGIN
FOR r_cuentas IN pkg_ctas.c_cuentas LOOP
UPDATE usrdemo.prestamos
SET fecha_alta = SYSDATE,
Cliente_id = r_cuentas.cliente_id
WHERE cuenta_debito = r_cuentas.cuenta_id;
END LOOP;
END;
Uso individual de update dentro de un for
Ahora el mismo ejemplo implementado con FORALL. Realiza los mismo, pero con una sola llamada
al SQL engine. (Versión para 8i)
DECLARE
TYPE t_cliente IS TABLE OF cuentas.cliente_id%TYPE;
l_clientes t_cliente := t_cliente();
TYPE t_cuenta IS TABLE OF cuentas.cuenta_id%TYPE;
l_cuentas t_cuenta := t_cuenta();
BEGIN
FOR r_cuentas IN pkg_ctas.c_cuentas LOOP
l_clientes.EXTEND;
l_cuentas.EXTEND;
l_clientes(l_cliente.LAST):= rec_cuentas.cliente_id;
l_cuentas(l_cuentas.LAST) := rec_cuentas.cuenta_id;
END LOOP
FORALL indx IN l_clientes.FIRST .. l_clientes.LAST
UPDATE usrdemo.prestamos
SET fecha_alta = SYSDATE,
cliente_id = l_clientes(indx)
WHERE cuenta_debito = l_cuentas(indx);
END;
Para versiones 9i existen mejoras para este tipo de código y para el manejo de
excepciones.
7. Reglas generales para performance
Para el manejo de datos dentro de un código PL/SQL es necesario tener en cuenta las
siguientes premisas.
Siempre es preferible utilizar la potencia del SQL antes que emular su funcionamiento
con un PL/SQL largo y complejo.
Mientras menos solicitudes de servicios se hagan al sql engine, más rápido se ejecutará
un programa.
Para el caso de operaciones de SQL similares o repetitivas, utilizar FORALL, BULKS,
variables BIND, etc.
Es bueno conocer las mejoras existentes, ya que cada versión trae operaciones que
disminuyen el costo de escritura o brindan funcionalidades que reducen el tiempo de
desarrollo y mejoran la performance.