A todos los desarrolladores les gusta trabajar en un código que está bien documentado con documentación que tiene sentido y proporciona información y conocimientos adecuados para comprender la funcionalidad del código. La mayoría de los lenguajes de programación proporcionan herramientas especiales para generar documentación. Por ejemplo, la herramienta JavaDoc se utiliza para generar documentación de API en formato HTML a partir de los comentarios de documentos disponibles en los programas de Java. Por desgracia, Microsoft SQL Server no incluye ningún método para generar documentación de esquema de tabla. Necesitamos confiar en herramientas de terceros para documentar el esquema de tabla en SQL Server.
DB> doc para Microsoft SQL Server es una herramienta adaptada para generar documentación de esquema de tabla. Esta herramienta utiliza las tablas del sistema de SQL Server que almacenan información para las estructuras de tablas, vistas y restricciones para generar documentación de esquema. La documentación generada usando DB> doc proporciona una lista de tablas clasificadas por diferentes nombres de esquema, lo que facilita su uso como referencia. Emplea las propiedades extendidas del servidor SQL que los desarrolladores utilizan para documentar objetos de base de datos.
DB> doc para Microsoft SQL Server genera documentación en numerosos formatos, incluidos HTML, WikiPlex y XML. El formato de documento más favorecido es HTML. Genera un documento HTML de una sola página con una lista de tablas clasificadas por su nombre de esquema y también proporciona hipervínculos a claves externas para identificar relaciones entre dos tablas.
He probado DB> doc tool con Microsoft SQL Server 2008, 2008 R2, 2012 y 2014 ediciones. Es un Aplicación de línea de comandos de Windows. Deberá descargar el formato de archivo Exe desde la página de CodePlex del proyecto de base de datos> doc. El enlace directo para descargar la herramienta es DB> doc para Microsoft SQL Server.
Use DB> doc para Microsoft SQL Server para generar documentación HTML para el esquema de tabla
1. Navegue a la carpeta donde ha descargado el “Sqldbdoc.exe” archivo de aplicación.
2. Vaya a la barra de direcciones y escriba "Cmd" para abrir la ruta actual en el explorador de comandos.
3. Tipo “Sqldbdoc.exe /?” Para ver todos los parámetros permisibles.
Información importante del parámetro
1. conexión - Cadena de conexión, dirección IP del servidor de la base de datos, nombre de la instancia, nombre de usuario, contraseña y nombre de la base de datos
2. nombre del archivo - Nombre del archivo de salida
3. [/ y] - Este interruptor se utilizará para sobrescribir el nombre de archivo generado existente.
Generando un documento HTML
Puedes seguir el siguiente ejemplo para generar un documento HTML.
Para la autenticación de Windows
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014" filename = AdventuresWork2014Doc.htm / y
Para la autenticación de SQL Server con ID de usuario y contraseña
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014 usuario id = sa; [correo electrónico protegido];" filename = AdventuresWork2014Doc.htm / y
Puede ver documentos generados en HTML en los siguientes formatos.
Este tutorial debería ayudarlo a generar y mantener la documentación del esquema de tabla para Microsoft SQL Server. Puede consultar los tutoriales de los archivos de SQL Server de Tech-Recipes para obtener más información.