Varje utvecklare gillar att arbeta med en kod som är grundligt dokumenterad med dokumentation som är meningsfullt och ger adekvat insikt och information för att förstå kodens funktionalitet. De flesta programmeringsspråk ger specialverktyg för att generera dokumentation. Till exempel används JavaDoc-verktyget för att generera API-dokumentation i HTML-format från tillgängliga dokkommentarer i Java-program. Tyvärr innehåller inte Microsoft SQL Server några metoder för att generera tabellschema dokumentation. Vi måste förlita oss på verktyg från tredje part för att dokumentera tabellschema i SQL Server.
DB> doc för Microsoft SQL Server är ett verktyg som är anpassat för att generera tabellschema dokumentation. Detta verktyg använder SQL Server systemtabeller som lagrar information för tabellstrukturer, visningar och begränsningar för att generera schematdokumentation. Dokumentation som genereras med DB> doc ger en lista över tabeller som klassificeras av olika schemanamn, vilket gör det enkelt att använda som referens. Den använder SQL-serverns Utökade Egenskaper som utvecklare använder för att dokumentera databasobjekt.
DB> doc för Microsoft SQL Server genererar dokumentation i flera format inklusive HTML, WikiPlex och XML. Det mest gynnade dokumentformatet är HTML. Det genererar ett enkeltsidigt HTML-dokument med en lista med tabeller som sorteras med deras schemanamn och ger också hyperlänkar till främmande nycklar för att identifiera relationer mellan två tabeller.
Jag har testat DB> doc-verktyg med Microsoft SQL Server 2008, 2008 R2, 2012 och 2014-utgåvor. Det är en Windows-kommandoradsapplikation. Du måste ladda ner Exe-filformatet från DB> doc-projektets CodePlex-sida. Direktlänken för att ladda ner verktyget är DB> doc för Microsoft SQL Server.
Använd DB> doc för Microsoft SQL Server för att generera HTML-dokumentation för tabellschema
1. Navigera till mappen där du har laddat ner filen ”Sqldbdoc.exe” applikationsfilen.
2. Gå till adressfältet och skriv ”cmd” för att öppna den aktuella sökvägen i kommandot explorer.
3. Typ "Sqldbdoc.exe /?" för att se alla tillåtna parametrar.
Viktig parameterinformation
1. förbindelse - Anslutningsträng, databasserver IP-adress, förekomstnamn, användarnamn, lösenord och databasnamn
2. filnamn - Utgångsfilnamn
3. [/ Y] - Denna omkopplare används för att skriva över det befintliga genererade filnamnet.
Generera ett HTML-dokument
Du kan följa exemplet nedan för att skapa ett HTML-dokument.
För Windows-autentisering
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = ja; DATABASE = AdventureWorks2014" filename = AdventuresWork2014Doc.htm / y
För SQL Server Authentication med användar-ID och lösenord
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = ja; DATABASE = AdventureWorks2014 användar id = sa; [email protected];" filnamn = AdventuresWork2014Doc.htm / y
Du kan se HTML-genererade dokument i följande format.
Denna handledning ska hjälpa dig att generera och underhålla tabellschema dokumentation för Microsoft SQL Server. Du kan gå igenom Tech-Recept SQL Server arkiv handledning för mer information.