Cómo documentar bases de datos SQL automáticamente

Muchos Administradores de Bases de Datos piensan acerca de la documentación de la base de datos como un “trabajo sucio”. Es una de esas tareas para la que usted nunca tiene suficiente tiempo, ya que siempre está ocupado con otras tareas de prioridad más alta.

¿Pero qué si pudiera ser automático?

Crear documentación para la base de datos y mantenerla al día no tiene que ser una carga. ApexSQL Doc puede ayudar.

ApexSQL Doc es una herramienta que documenta SQL Servers, objetos y paquetes SSIS. Crea documentación para bases de datos en una variedad de formatos, incluyendo ayuda compilada (.CHM), HTML, PDF y MS Word. Y lo mejor de todo, todo el proceso de documentación puede ser programado y correr por sí solo:

  1. Inicie ApexSQL Doc
  2. 2En la pestaña Home, en el grupo Projects, haga clic en el botón New para crear un nuevo proyecto
  3. Para añadir bases de datos a la documentación, en la pestaña Database engine haga clic en el botón Add
  4. En el diálogo Add SQL Server, seleccione y haga clic en el botón Connect:

  5. Si usted quiere documentar bases de datos desde múltiples SQL Server, repita los pasos 3 y 4
  6. Seleccione los objetos del Servidor para documentar desde la pestaña Server objects
  7. Especifique las opciones de documentación de la base de datos, como incluir scripts DDL, resaltar código T-SQL, opciones de la tabla de contenido, etc. Desde la pestaña Database options
  8. Desde la pestaña Database objects, seleccione los tipos de objetos que serán documentados
  9. Si usted tiene algún objeto que depende de los objetos documentados, usted puede codificarlos si usted selecciona Include dependency lists/tables en la pestaña Dependencies. Incluir objetos dependientes mejora la precisión de la documentación
  10. Para documentar paquetes SSIS, añádalos desde la pestaña Integration services:

  11. Desde la pestaña Custom text, especifique el texto de la cabecera y el pie de página que aparecerán en cada página
  12. Cuando todas las opciones para la documentación estén establecidas, haga clic en el botón Save desde la pestaña Home en el grupo Projects
  13. Si desea crear la documentación inmediatamente, haga clic en el botón Generate desde la pestaña Home, en el grupo Actions
  14. Para programar la documentación, cree un archivo batch que se ejecutará en el proyecto ApexSQL Doc creado. Grabe el siguiente comando:

    “C:Program Files\ApexSQL\ApexSQLDoc2014\ApexSQLDoc..com” /pr:D:AdventureWorks2012.axdp /of:html /od:D:doc /v /on:{databasename}.{date} br>

    Como el archivo batch D:docDocBatch.bat

    La etiqueta {date} en el archivo de salida creará un nuevo nombre para su documento cada día, por ejemplo, AdventureWorks.10_03_2012. Si usted no desea mantener las versiones más antiguas, use la plantilla de nombre de archivo /on:{databasename} y añada /f para sobrescribir el archivo antiguo.

  15. Inicie SQL Server Management Studio
  16. En Object Explorer expanda SQL Server Agent, haga clic derecho en Jobs y seleccione New job de la lista:

  17. En la pestaña General, especifique el nombre de la tarea. En la pestaña Steps, haga clic en el botón New para añadir un nuevo paso a la tarea, y especifique un tipo de “Operating system (CmdExec)” para ello
  18. Ingrese el siguiente comando:

    Cmd.exe /c “D:docDocBatch.bat”

  19. Abra la pestaña Schedules y especifique cuándo debería ocurrir la tarea:

Pruebe el proceso entero, siéntese y relájese. Sus bases de datos serán automáticamente documentadas por usted:

Traductor: Daniel Calbimonte

junio 4, 2015