SQL Server: Documentación del esquema de la tabla usando DB> Doc


A todos los desarrolladores les gusta trabajar en un código que esté completamente documentado con documentación sensata y que brinde información y conocimientos adecuados para comprender la funcionalidad del código. La mayoría de los lenguajes de programación brindan herramientas especiales para generar documentación. Por ejemplo, la herramienta JavaDoc se usa para generar documentación API en formato HTML a partir de comentarios de documentos disponibles en programas Java. Desafortunadamente, Microsoft SQL Server no incluye ningún método para generar documentación de esquema de tabla. Tenemos que confiar en herramientas de terceros para documentar el esquema de la tabla en SQL Server.

BD> doc for Microsoft SQL Server es una herramienta adaptada para generar documentación de esquemas de tablas. Esta herramienta utiliza tablas del sistema de SQL Server que almacenan información para estructuras de tablas, vistas y restricciones para generar documentación de esquema. La documentación generada con DB> doc proporciona una lista de tablas categorizadas con diferentes nombres de esquema que facilitan su uso como referencia. Emplear SQL Server Propiedades extendidas que los desarrolladores usan para documentar los objetos de la base de datos.

DB> doc para Microsoft SQL Server genera documentación en numerosos formatos, incluidos HTML, WikiPlex y XML. El formato de documento preferido es HTML. Genera un documento HTML de una sola página con una lista de tablas ordenadas por nombre de esquema y también proporciona hipervínculos a claves externas para identificar las relaciones entre dos tablas.

He probado la herramienta DB> doc con las ediciones Microsoft SQL Server 2008, 2008 R2, 2012 y 2014. Es una Aplicación de línea de comandos de Windows. Deberá descargar el formato de archivo exe de la página CodePlex del proyecto DB> doc. El enlace directo para descargar la herramienta es DB> doc para Microsoft SQL Server.

Use DB> doc para Microsoft SQL Server para generar la documentación HTML para el esquema de la tabla

1. Navegue a la carpeta donde se descargó el archivo "Sqldbdoc.exe" expediente de solicitud.
2. Vaya a la barra de direcciones y escriba "cmd" para abrir la ruta actual en Command Explorer.
3. Tipo “Sqldbdoc.exe /? para ver todos los parámetros permitidos.

Eliminar un objeto LDAP usando ldapmodify

Información importante sobre los parámetros

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 modificador se utilizará para sobrescribir el nombre de archivo generado existente.

Generación de un documento HTML
Puede seguir el ejemplo siguiente para generar un documento HTML.

Para la autenticación de Windows

sqldbdoc "SERVER=ANDRO100SQLSERVER2014;TRUSTED_CONNECTION=yes;DATABASE=AdventureWorks2014" filename=AdventuresWork2014Doc.htm /y

db_doc_sql_server_documentación_generador_windows_auth

Cómo crear un proyecto de base de datos de SQL Server en Visual StudioCómo crear un proyecto de base de datos de SQL Server en Visual Studio

Para la autenticación de SQL Server con ID de usuario y contraseña

sqldbdoc "SERVER=ANDRO100SQLSERVER2014; TRUSTED_CONNECTION=yes; DATABASE=AdventureWorks2014 user id=sa; [email protected];" filename=AdventuresWork2014Doc.htm /y

sql_server_auth_db_doc_schema_generation

Puede ver los documentos generados en HTML en los siguientes formatos.

html_document_schema db doc servidor sql

html_document_example db doc servidor sql

Una guía para principiantes para secuenciar objetos en SQL ServerUna guía para principiantes para secuenciar objetos en SQL Server

Este tutorial debería ayudarlo a generar y administrar la documentación del esquema de tablas para Microsoft SQL Server. Puede consultar los tutoriales de archivos de recetas técnicas de SQL Server para obtener más información.

Cuentas Seguras

Descubre más contenido

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Subir