INST Estándar Codificación SQL y PL-SQL

Transcripción

1 INST Estándar Codificación SQL y PL-SQL Convenciones de nombres y estándares de codificación para SQL y PL/SQL Objetivo: Establecer pautas para estandarizar los nombres de objetos Oracle y la confección de código SQL y PL/SQL, para lograr: código fácil de entender y, por lo tanto, de mantener (claridad) simplificar la decisión al momento de establecer nombres uniformidad en el criterio utilizado por todos los integrantes de SziCom Convención de nombres de objetos: General: Todos los nombres de objetos de la base de datos se deberán escribir en mayúsculas. Se utilizarán guiones bajos (_) para separar palabras. Se evitarán, en lo posible, las abreviaturas. Tablas: Se han adoptado algunas nomenclaturas para prefijar los nombres de las tablas: Prefijo Significado Ejemplo NTC_ Nominación Transporte Cliente DESPACHO.NTC_NOMINACION DCG_ Desbalance Cliente Gas DESPACHO.DCG_AJUSTE_INYECCION DCL_ Desbalance Cliente DESPACHO.DCL_AJUSTE_CONSUMO ABI_ Tablas que se alimentan directamente con datos del ABI de TGN ABI_BAL, ABI_COMPENSACION SPAC_ Tablas que se alimentan directamente con datos del SPAC de TGS SPAC_ASIGNACION_PUNTO MV_ Tablas Snapshot de vistas materializadas MV_CONSUMO Toda tabla deberá tener un breve comentario que describa su contenido. Columnas: Nombre del objeto Comentario Ejemplo ID_nombre_tabla Prefijo ID (aplica a campos enteros) ID_CLIENTE; ID_PUNTO FH_acción Prefijo FH indica fecha y hora FH_ENVIADO NOMINADO Implica el prefijo VOLUMEN NTC_NOMINACION.NOMINADO Toda columna deberá tener un breve comentario explicativo. Otras convenciones: Los campos que correspondan a valores del tipo SI/NO, VERDADERO/FALSO, se definirán como CHAR(1) y luego mediante una constraint se limitará el contenido a las letras S o N. Los campos que registren el usuario Oracle que realizó la acción, se denominarán USUARIO, serán del tipo VARCHAR2(32), pudiendo o no tener como default: USER. Los campos Año se denominarán ANIO y se definirán como NUMBER(4). Cuando una columna refiera al ID de otra tabla (FOREIGN KEY), deberá tener (en lo posible) el mismo nombre que el campo ID de la tabla referenciada. Esto facilita que muchas herramientas de generación de diagramas establezcan de manera automática las relaciones entre tablas. Todo campo "tipo" que tenga más de 3 (tres) estados posibles deberá transformarse en un campo ID que deberá referenciar a una tabla TIPO_X convenientemente creada a tal efecto.

2 Constraints: El espacio de nombre de las contraints es el del esquema. Prefijo Significado Ejemplo PK_xxx Clave primaria, xxx es el nombre de la tabla PK_CLIENTE UK_xxx_yyy Indice único sobre la tabla xxx y los campos yyy UK_CLIENTE_NEMONICO FK_xxx_yyy Foreign Key de la tabla xxx columna yyy FK_CESION_ID_CAMARA NN_xxx_yyy El campo yyy de la tabla xxx no puede ser nulo NN_CLIENTE_FECHA_ALTA POS_xxx_yyy El campo yyy de la tabla xxx debe ser positivo TRANSPORTE.POS_TARIFA_TARIFA_FIRME SN_xxx_yyy El campo yyy de la tabla xxx debe contener S o N DESPACHO.SN_NOMINACION_VERSION_CERRADA CHK_xxx_yyy El campo yyy de la tabla xxx debe cumplir el CHECK CHK_BALANCE_MES_MES Se recomienda no crear las constraints en el comando SQL CREATE TABLE, ya que éstas se generan como System Named. Si se utiliza el TOAD, no utilizar las columnas PK y NOT NULL de la grilla de armado de tablas, ya que las constraints resultantes se generan como System Named. Triggers: La primera letra del nombre indicará el momento en que disparará el trigger: B Before (Antes) A After (Después) Agregado de la letra S Si se trata de un trigger BEFORE o AFTER STATEMENT, si no se indica se supone FOR EACH ROW. Luego, las siguientes letras indicarán en el orden que se expone, qué acciones sobre la tabla involucrada disparán los triggers: I Insert U Update D Delete A continuación, el nombre de la tabla correspondiente. Nombre BIU_TARIFA BSIUD_TARIFA AIU_TARIFA Significado Before Insert/Update (for each row) en la tabla TARIFA Before Statement Insert/Update/Delete en la tabla TARIFA After Insert/Update (for each row) en la tabla TARIFA Secuencias: Se prefijará SEQ_ y luego se indicará el nombre de la tabla que tiene uno o más triggers que a su vez utilizan la secuencia. SEQ_CAMARA_BALANCE SEQ_GNC_CONTRATO_GAS Packages: Se prefijará PK_ y luego se indicará con una o más palabras el ámbito al que corresponde el package. PK_NOMINACION PK_CONTROL_FACTURACION PK_CONTRATO

3 PK_VENTANA Vistas: Los nombres de las vistas se prefijarán según el siguiente criterio: Prefijo V_ VA_ MV_ VD_ X_, XX_ Significado Vista estándar Vista de valores acumulados Vista materializada Vista para desnormalizar tablas Vistas intermedias, utilizadas por lo general para no incluir subquerys en la vista final Al momento de redactar las vistas: Introducir un breve comentario explicativo, a renglón siguiente de la cláusula SELECT y antes de comezar a enumerar los campos. Prefijar las tablas/vistas utilizadas en la selección, con el esquema al que pertenecen. Cuando se trate de joins de tablas o vistas, establecer alias y utilizarlos al referenciar los campos, tanto en la cláusula SELECT como en las clásulas WHERE, ORDER BY o GROUP BY. Estándares de codificación para SQL y PL/SQL: Notación: Prefijo Significado Ejemplo p Parámetro de función/procedimiento pid_cliente, pdia_operativo v Variable local al procedimiento/función vcont, vfecha_desde g Variable global del package gdia_operativo k Constante kid_mercado_gu, kid_distco c Cursor cclientes_activos e Variable del tipo EXCEPTION eno_vigente r Registro, fila de un cursor, tupla rcliente_activo t Tipo tarr_nominacion a Array anominacion Comentarios: Cabecera de métodos: Es obligatorio escribir un comentario en la cabecera de un método (procedimiento o función). Se debe indicar al inicio del comentario las iniciales del programador que creó o modificó el método. El comentario no debe exceder las 2 líneas. Si se requiere más detalle se deberá recurrir a la especificación que motivó la creación o cambio del método, que seguramente tendrá el contexto. Historial de cambios: limitarlos a una línea por cambio y si una línea no es suficiente, hacer referencia al requerimiento (issue) que dio origen al cambio. Si son varios issues se indicarán.

4 -- Replicar el contrato para el cliente con los mismos servicios y la misma vigencia -- Autor. CSZ (20/12/2009)-Tomado de la version Modif. ACM (20/01/2009)-Replicar adecuadamente las tarifas y replicar volumenes. -- RAV (02/02/2009)-Issue DESPACHO-153. Nota: Este tipo de comentario dejará de utilizarse cuando se implemente svn para Oracle. Comentarios en un bloque interno de código: Valen las mismas consideraciones que para los comentarios de cabecera. Por ejemplo: descripción de un cursor. Comentarios adicionales: Corresponden a información que no es evidente, que no se puede deducir del comentario estandar y que el programador considera importante. -- Controlar que no se haya creado antes la misma cesión. -- Recorremos la lista de clientes que reciben, asignando hasta terminar el excedente Pautas generales: Nombrar los objetos de cada esquema con el prefijo del esquema, aunque sea redundante. SELECT ID_CLIENTE, NEMONICO FROM CI.CLIENTE vfirme_contratado := CI.PK_CONTRATO.FIRME_CONTRATADO; Utilizar tipo de variables enteras cuando los operandos sean enteros y el resultado un entero (PLS_INTEGER). Evitar el uso de "Números mágicos". Definir constantes con nombres representativos, prefijadas con k. Evitar el uso de EXIT o RETURN para salir de un ciclo FOR o WHILE. Utilizar nombres de variables en los ciclos que aporten mayor información que el simple uso de I, J, K, etc. -- Cuando no es un simple conteo de iteraciones... FOR vmes IN LOOP -- Cuando se trata de un registro de un cursor... FOR rcliente IN cclientes_activos LOOP Todo procedimiento o función deberá incluirse en un package afin. Escribir el nombre del procedimiento o función en el END de cierre (permite diferenciarlo fácilmente de otros ENDs del código).

5 END BORRAR_APERTURA_NTC_NOM_CLIE; Longitud máxima para un procedimiento/función/trigger: 30 líneas de código. Evitar el uso de IF para asignar valores a variables booleanas. -- Usar: vvencido := vfecha_hasta <= vfecha_limite; -- En lugar de: IF vfecha_hasta <= vfecha_limite THEN vvencido := TRUE; ELSE vvencido := FALSE; END IF; Utilizar variables booleanas para mejorar la legibilidad. velegible_para_aumento := remp.salario BETWEEN AND AND ESTADO_EMPLEADO(rEMP.ID_EMPLEADO) = 'N' AND MONTHS_BETWEEN (remp.fecha_alta, SYSDATE) > 10; IF velegible_para_aumento THEN DAR_AUMENTO(rEMP.ID_EMPLEADO); END IF; Indentación (ejemplos): Al definir variables: vversion PLS_INTEGER; vid_tipo_consumo PLS_INTEGER; vclave VARCHAR2(255); etipo_consumo EXCEPTION; eversion EXCEPTION; vfh_proceso DATE; vdesde DATE; vhasta DATE; vtipo VARCHAR2(12);

6 Al escribir DMLs: SELECT CL.ID_CLIENTE, CL.NEMONICO, CT.ID_CONTRATO, CT.FECHA_INICIO, CT.FECHA_FIN FROM CI.CLIENTE CL, CI.CONTRATO CT WHERE CL.ID_CONTRATO = CT.ID_CONTRATO AND CT.FECHA_FIN < SYSDATE; INSERT INTO BALANCE.LOG_PROCESO ( FH_PROCESO, ID_PROCESO, ID_TIPO_ERROR, DETALLE) VALUES ( SYSDATE, vproceso, verror, vdetalle); UPDATE CI.CESION_DIA SET APERTURA_NOMINADO = NOMINADO, APERTURA_AUTORIZADO = AUTORIZADO, ASIGNADO = NULL WHERE DIA_OPERATIVO = vdia_operativo AND ID_CESION IN (SELECT C.ID_CESION FROM CI.V_CESION C WHERE C.ID_CLIENTE_RECIBE = vid_cliente); DELETE BALANCE.CONSUMO_LOCALIDAD WHERE ANIO = vanio AND MES = vmes AND VERSION = vversion AND ID_LOCALIDAD = TC.ID_LOCALIDAD AND ID_TIPO_CONSUMO = vid_tipo_consumo; Al escribir IFs:

7 IF a = 1 AND ( b = 2 OR c = 3 OR d = 4 ) THEN accion_verdadero ELSE accion_falso END IF; Al asignar valores: vexcedente := vexcedente + GREATEST(0, TC.VOLUMEN); vfaltante := vfaltante - LEAST(0, TC.VOLUMEN); Al definir procedimientos o funciones: -- Breve comentario explicativo FUNCTION AUTORIZADO_INICIAL (psolicitado PLS_INTEGER, pfirme PLS_INTEGER, pgas_total PLS_INTEGER, ptiene_ti PLS_INTEGER) RETURN PLS_INTEGER IS Manejo de los errores - Excepciones: Texto en las excepciones: Si el mensaje hace referencia a un objeto que causa el error, el objeto debe estar identificado por el nombre. 'No está definido el punto ' vnombrepunto ' en la tabla RED.PUNTO'