BD UD7 Documentación

Documentación

• Nota: Todos los ejemplos están basados en esta base de datos.

• Ya vimos que dentro de la definición del procedimiento podemos añadir un pequeño comentario indicando para que sirve y cual es la función de los parámetros.

Dicha documentación también puede ser indicada si la definición del procedimiento / función / trigger la vamos a hacer dentro de un guión el cual lo vamos a guardar en forma de fichero .sql.

En ese caso, podemos poner un comentario delante de la definición del procedimiento con el siguiente formato:

Nombre_archivo.sql

 1 /*
 2 NOMBRE PROCEDIMIENTO:                                        
 3 FECHA CREACIÓN:
 4 AUTOR: 
 5 TARE A AUTOMATIZAR:
 6 PARAMETROS REQUERIDOS:
 7 RESULTADOS PRODUCIDOS:
 8 ___________________________________________________________________________________
 9 */
10 Código procedimiento / función / trigger

Uso de snippets

• Como esa 'plantilla' la vamos a utilizar con todos los procedimientos, podemos crear en MysqlWorkBench lo que se denomina un Snippets que no es más que un texto que podemos insertar en cualquier momento.

• Creando un Snippets en MysqlWorkBench
• 

  Escribimos en una pestaña SQL el texto que queremos guardar.

• 

  Seleccionamos el texto que queremos añadir al Snippets.

• 

  En la parte derecha presionamos la pestaña Snippets y en la lista escogemos My Snippets. Pulsamos el botón derecho del ratón y escogemos la opción Add Snippet from Editor Content.

• 

  Le damos un nombre al Snippets y presionamos el botón Done.

• 

  Ahora sobre cualquier pestaña SQL podemos escoger la opción 'Insert Snippets' y automáticamente añade todo el texto.

Ejemplo de guión completo

• Un ejemplo de guión completo de nombre gestionPistas.sql podría ser:

 1 /*
 2 NOMBRE PROCEDIMIENTO: pistas_add                                        
 3 FECHA CREACIÓN: 08/04/2020
 4 AUTOR: Angel F.
 5 TARE A AUTOMATIZAR: Dar de alta una nueva pista
 6 PARAMETROS REQUERIDOS: IN
 7                           p_nombre: nombre de la pista.
 8                           p_aforo: aforo de la pista.
 9 RESULTADOS PRODUCIDOS: Número de filas añadidas. -1 si no añade ninguna
10 ___________________________________________________________________________________
11 */
12 USE CIRCO;
13 DELIMITER $$
14 CREATE DEFINER=`root`@`%` PROCEDURE `pistas_add`(p_nombre varchar(50),p_aforo smallint)
15     COMMENT 'Añade una nueva pista'
16 BEGIN
17     INSERT INTO PISTAS (nombre, aforo)		-- Mejor poner las columnas, ya que si modificamos la estructura de la tabla, la orden sigue funcionando
18     VALUES (p_nombre,p_aforo);
19     
20     SELECT ROW_COUNT();
21 
22 END$$
23 DELIMITER ;
24 
25 
26 /*
27 NOMBRE PROCEDIMIENTO: pistas_delete                                        
28 FECHA CREACIÓN: 08/04/2020
29 AUTOR: Angel F.
30 TARE A AUTOMATIZAR: Dar de baja una pista
31 PARAMETROS REQUERIDOS: IN
32                           p_nombre: nombre de la pista a borrar
33 RESULTADOS PRODUCIDOS: Número de filas borradas. -1 si no borra ninguna.
34 ___________________________________________________________________________________
35 */
36 USE CIRCO;
37 DELIMITER $$
38 CREATE DEFINER=`root`@`%` PROCEDURE `pistas_delete`(p_nombre varchar(50))
39     COMMENT 'Borra una pista'
40 BEGIN
41 
42 	DELETE FROM PISTAS
43     WHERE nombre LIKE CONCAT(p_nombre,'%');
44     
45     SELECT ROW_COUNT();
46 
47 END$$
48 DELIMITER ;

Enlace a la página principal de la UD7

Enlace a la página principal del curso

-- Ángel D. Fernández González -- (2020).