A ogni sviluppatore piace lavorare su un codice che è accuratamente documentato con documentazione che ha senso e fornisce informazioni e informazioni adeguate per comprendere le funzionalità del codice. La maggior parte dei linguaggi di programmazione fornisce strumenti speciali per generare documentazione. Ad esempio, lo strumento JavaDoc viene utilizzato per generare documentazione API in formato HTML dai commenti dei documenti disponibili nei programmi Java. Purtroppo, Microsoft SQL Server non include alcun metodo per generare documentazione dello schema della tabella. Dobbiamo affidarci a strumenti di terze parti per documentare lo schema della tabella in SQL Server.
DB> doc per Microsoft SQL Server è uno strumento adatto a generare documentazione dello schema della tabella. Questo strumento utilizza le tabelle di sistema di SQL Server che memorizzano le informazioni relative a strutture di tabelle, viste e vincoli per generare documentazione dello schema. La documentazione generata mediante DB> doc fornisce un elenco di tabelle classificate con nomi di schemi diversi che ne facilitano l'utilizzo come riferimento. Impiega le Proprietà estese del server SQL che gli sviluppatori usano per documentare gli oggetti del database.
DB> doc per Microsoft SQL Server genera documentazione in numerosi formati, tra cui HTML, WikiPlex e XML. Il formato di documento più favorito è l'HTML. Genera un documento HTML a pagina singola con un elenco di tabelle assortite in base al nome dello schema e fornisce inoltre collegamenti ipertestuali a chiavi esterne per l'identificazione delle relazioni tra due tabelle.
Ho testato DB> doc tool con Microsoft SQL Server 2008, 2008 R2, 2012 e 2014. È un Applicazione da riga di comando di Windows. Dovrai scaricare il formato file Exe dalla pagina CodePlex di DB> doc project. Il collegamento diretto per scaricare lo strumento è DB> doc per Microsoft SQL Server.
Utilizzare DB> doc per Microsoft SQL Server per generare documentazione HTML per schema tabella
1. Passare alla cartella in cui è stato scaricato il file “Sqldbdoc.exe” file di applicazione.
2. Vai alla barra degli indirizzi e digita “cmd” per aprire il percorso corrente in Command Explorer.
3. Digitare "Sqldbdoc.exe /?" per vedere tutti i parametri ammessi
Informazioni importanti sui parametri
1. connessione - Stringa di connessione, indirizzo IP del server database, nome dell'istanza, nome utente, password e nome del database
2. nome del file - Nome del file di output
3. [/ Y] - Questa opzione verrà utilizzata per sovrascrivere il nome del file generato esistente.
Generazione di un documento HTML
Puoi seguire l'esempio qui sotto per generare un documento HTML.
Per l'autenticazione di Windows
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014" filename = AdventuresWork2014Doc.htm / y
Per l'autenticazione di SQL Server con ID utente e password
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014 id utente = sa; [email protected];" filename = AdventuresWork2014Doc.htm / y
Puoi visualizzare documenti generati HTML nei seguenti formati.
Questo tutorial dovrebbe aiutare a generare e mantenere la documentazione dello schema della tabella per Microsoft SQL Server. È possibile consultare le esercitazioni sugli archivi di SQL Server di Tech-Recip per ulteriori informazioni.