Chaque développeur aime travailler sur un code parfaitement documenté, avec une documentation qui a du sens et qui fournit les informations et informations adéquates pour comprendre les fonctionnalités du code. La plupart des langages de programmation fournissent des outils spéciaux pour générer de la documentation. Par exemple, l'outil JavaDoc est utilisé pour générer la documentation de l'API au format HTML à partir des commentaires doc disponibles dans les programmes Java. Hélas, Microsoft SQL Server n'inclut aucune méthode pour générer de la documentation sur le schéma de table. Nous devons faire appel à des outils tiers pour documenter le schéma de table dans SQL Server.
DB> doc pour Microsoft SQL Server est un outil adapté pour générer la documentation du schéma de table. Cet outil utilise les tables système de SQL Server qui stockent des informations sur les structures, les vues et les contraintes de table afin de générer une documentation de schéma. La documentation générée à l'aide de DB> doc fournit une liste de tables classées par différents noms de schéma, ce qui facilite leur utilisation comme référence. Il utilise les propriétés étendues du serveur SQL que les développeurs utilisent pour documenter les objets de base de données.
DB> doc pour Microsoft SQL Server génère de la documentation dans de nombreux formats, notamment HTML, WikiPlex et XML. Le format de document préféré est HTML. Il génère un document HTML d'une seule page avec une liste de tables, classées par nom de schéma, et fournit également des hyperliens vers des clés étrangères permettant d'identifier les relations entre deux tables.
J'ai testé l'outil DB> doc avec les éditions Microsoft SQL Server 2008, 2008 R2, 2012 et 2014. C'est un Application en ligne de commande Windows. Vous devrez télécharger le format de fichier Exe à partir de la page CodePlex du projet DB> doc. Le lien direct pour télécharger l'outil est DB> doc pour Microsoft SQL Server.
Utiliser DB> doc pour Microsoft SQL Server pour générer une documentation HTML pour le schéma de table
1. Naviguez jusqu'au dossier où vous avez téléchargé le "Sqldbdoc.exe" dossier de candidature.
2. Allez dans la barre d’adresse et tapez "Cmd" pour ouvrir le chemin actuel dans l'explorateur de commandes.
3. Type "Sqldbdoc.exe /?" pour voir tous les paramètres admissibles.
Informations importantes sur les paramètres
1. lien - Chaîne de connexion, adresse IP du serveur de base de données, nom d'instance, nom d'utilisateur, mot de passe et nom de la base de données
2. nom de fichier - Nom du fichier de sortie
3. [/ y] - Ce commutateur sera utilisé pour écraser le nom de fichier généré existant.
Générer un document HTML
Vous pouvez suivre l'exemple ci-dessous pour générer un document HTML.
Pour l'authentification Windows
sqldbdoc "SERVEUR = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014" nom_fichier = AdventuresWork2014Doc.htm / y
Pour l'authentification SQL Server avec l'ID utilisateur et le mot de passe
sqldbdoc "SERVEUR = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014 id utilisateur = sa; [email protected];" filename = AdventuresWork2014Doc.htm / y
Vous pouvez voir les documents générés en HTML dans les formats suivants.
Ce tutoriel devrait vous aider à générer et à gérer la documentation du schéma de table pour Microsoft SQL Server. Vous pouvez consulter les tutoriels sur les archives techniques de SQL-Recipes pour plus d'informations.