Si hay una verdad innegable en Informática es que a la grandísima mayoría de los programadores no nos gusta documentar. Sabemos muy bien que eso es lo correcto, que debemos hacerlo … pero no lo hacemos.

Aunque no nos salvaremos de escribir algo, los scripts de Firebird nos ayudarán a escribir poco y sin embargo tener muy bien documentada a nuestra Base de Datos.

La técnica es la siguiente:

  • Cuando creamos una Base de Datos generamos su script. En él escribimos la fecha en que fue creada y algún otro comentario relevante.
  • Cada vez que modificamos los metadatos generamos un script. En él escribimos la fecha de la modificación, cual/es metadato/s cambiamos y algún otro comentario relevante

Si hacemos esto tendremos algo buenísimo: el historial completo de nuestra Base de Datos, con todos los cambios que alguna vez fueron realizados en ella y las fechas de tales cambios.

Entonces si alguien ¿nosotros mismos? por intención o por ignorancia modificó algún metadato podremos regresarlo a su estado original, rápidamente y sin esfuerzo.

¿Cómo se genera un script?

En este artículo se explica como hacerlo:

https://firebird21.wordpress.com/2013/05/22/entendiendo-a-los-scripts/

Ejemplo:

Queremos documentar mediante scripts una Base de Datos que se llama INTEGRAL.FDB entonces cuando terminamos de trabajar con ella el primer día generamos un script, le llamamos INTEGRAL001.SQL y le escribimos la fecha:

SCRIPT01

Captura 1. Si haces clic en la imagen la verás más grande

A partir de ese día cada vez que modificamos los metadatos, cuando terminamos de trabajar con ellos generamos otro script donde indicamos que fue lo que le hicimos. Este se llama INTEGRAL002.SQL:

SCRIPT02

Captura 2. Si haces clic en la imagen la verás más grande

Fíjate que no es necesario especificar cuales fueron los cambios realizados sino solamente qué se cambió. Si queremos saber cuales fueron los cambios (por ejemplo en la tabla CLIENTES) podemos buscar esa tabla en el script y allí los veremos. Desde luego que si quieres escribir cuales fueron los cambios en la cabecera del script también puedes hacerlo aunque en general no es necesario.

Conclusión:

Mantener bien documentados los cambios que le realizamos a nuestra Base de Datos es importantísimo para poder en cualquier momento saber que fue lo que hicimos (o algún otro le hizo, sin nuestra autorización) y en caso necesario retrotraerla a su estado anterior.

Es cierto, documentarla lleva un poco de tiempo y no nos gusta documentar pero los beneficios que obtendremos con esta práctica el día que ocurra algún problema serán inmensos y compensarán con creces el tiempo que empleamos en documentar la Base de Datos.

Es una buena idea que cuando instalas la Base de Datos en la computadora de tu cliente o cuando modificas esa Base de Datos especifiques cual script le corresponde. Por ejemplo: el cliente 1 tiene instalada la Base de Datos que corresponde al script 017, el cliente 2 tiene instalada la Base de Datos que corresponde al script 023, etc.

Artículos relacionados:

Entendiendo a los scripts

El índice del blog Firebird21