Il processo di documentazione di un database SQL Server è un processo completo e continuo che dovrebbe iniziare durante le fasi di progettazione e sviluppo del database e continuare durante tutti i cicli di vita relativi al database in modo da garantire una versione aggiornata della documentazione del database che riflette la realtà in qualsiasi momento. Se eseguito correttamente, il file di documentazione del database generato conterrà un elenco aggiornato e completo per gli oggetti del database e una breve descrizione per questi oggetti del database.
Il processo di documentazione del database di SQL Server può essere eseguito in più modi. Puoi semplicemente creare un diagramma del database che mostri un elenco di tutte le tabelle e colonne del database e aggiorni questo diagramma quando viene eseguita qualsiasi modifica. Ma leggere e mantenere un tale diagramma non è un processo facile per database di grandi dimensioni con dozzine di tabelle di database e ogni tabella contiene dozzine di colonne.
A partire da SQL Server 2005, Microsoft ha introdotto una nuova funzionalità denominata Proprietà estese, che viene archiviata nel database stesso e accessibile tramite l'oggetto di sistema sys.extended_properties e restituisce informazioni sui metadati associati al database o agli oggetti del database specificati. Documentare il database di SQL Server utilizzando le proprietà estese non è la scelta migliore, poiché puoi documentare un database alla volta, nessun dato storico poiché le proprietà degli oggetti del database verranno eliminate quando questo oggetto viene eliminato, non è un processo semplice poiché richiede buone capacità di sviluppo, richiede un grande sforzo e richiede molto tempo.
Utilizzo di Visual Studio
Gli sviluppatori che hanno familiarità con Microsoft Visual Studio possono facilmente trarre vantaggio dal tipo di progetto SQL Server per connettersi a un database SQL Server e controllare i metadati sugli oggetti del database.
Per ottenere ciò, apri lo strumento Visual Studio e crea un nuovo progetto di database di SQL Server dalla finestra Nuovo progetto, come di seguito:
Nella finestra Nuovo progetto, fornire un nome univoco per quel progetto, dove salvare il progetto, quindi fare clic su OK per creare il progetto di database di SQL Server. Una volta creato il progetto, fare clic sulle proprietà del progetto e configurare il valore Piattaforma di destinazione con la versione SQL Server del database di destinazione, come mostrato di seguito:
Per connetterti a un database specifico, fai clic con il pulsante destro del mouse sul progetto creato e scegli l'opzione Importa -> Database come segue:
Dalla finestra Importa database, selezionare una connessione dall'elenco delle connessioni salvate in precedenza o fornire il nome del server, le credenziali autenticate e il nome del database per connettersi al database da documentare, come segue:
Quando ti connetti sul pulsante Connetti, lo strumento inizierà a raccogliere informazioni sui metadati su tutti gli oggetti del database, come mostrato di seguito:
Dopo aver raccolto e importato tutte le informazioni del database, gli oggetti del database selezionati verranno visualizzati in Esplora soluzioni, classificati in base allo schema, come segue:
Per visualizzare le informazioni sui metadati su qualsiasi oggetto di database, espandi lo schema da Esplora soluzioni e fai clic su quell'oggetto e verrà aperta una nuova finestra che mostra tutta la descrizione per l'oggetto selezionato, con lo script T-SQL per creare quell'oggetto specifico, come mostrato di seguito:
Fornisce inoltre la possibilità di mostrare la colonna Descrizione per ogni oggetto del database, facendo clic con il pulsante destro del mouse sullo spazio libero accanto alla tabella selezionata e scegliendo l'opzione Descrizione. Verrà visualizzata una nuova colonna che mostra la descrizione per ciascuna colonna, con la possibilità di modificare la descrizione, come mostrato di seguito:
Sebbene sia troppo facile documentare il database utilizzando Visual Studio, non fornisce un luogo centralizzato per controllare più oggetti di database, fornisce informazioni su un singolo database per ogni progetto e non può essere esportato in un formato facile da usare o stampabile!
Utilizzo di dbForge Documenter per SQL Server
Per risparmiare tempo e fatica e tenere aggiornata la documentazione del database, è meglio utilizzare uno strumento di terze parti che semplifichi il processo di documentazione. dbForge Documenter per SQL Server è uno strumento di documentazione del database che può essere facilmente collegato al tuo database e genera la documentazione di tutti gli oggetti del database di SQL Server in pochi clic.
dbForge Documenter per SQL Server ci offre un'ampia gamma di modelli di stile e opzioni che aiutano a personalizzare la documentazione generata per soddisfare le proprie esigenze. In pochi secondi di configurazione, dbForge Documenter per SQL Server estrae tutte le informazioni e i dettagli estesi sul database selezionato, nonché le dipendenze tra oggetti e gli script DDL T-SQL per creare questi oggetti, con la possibilità di esportare la documentazione in HTML ricercabile formati di file , PDF e Markdown. Il formato HTML aiuta a pubblicare il database sul Web e il formato PDF è adatto per la distribuzione ad altri sistemi e condiviso su altri dispositivi. È inoltre possibile accedere a dbForge Documenter per SQL Server per documentare il database direttamente tramite SQL Server Management Studio poiché è integrato con SSMS.
dbForge Documenter per SQL Server può essere scaricato dall'area download Devart e installato sul server tramite la procedura guidata di installazione diretta, come illustrato di seguito:
Quando fai clic sul pulsante Installa per avviare il processo di installazione, ti verrà chiesto di specificare il percorso di installazione per lo strumento, se riesci a creare un'icona sul desktop per consentire allo strumento di accedervi più velocemente, le versioni di SQL Server Management Studio per avere questo strumento come componente aggiuntivo su di esso, le estensioni dei file che verranno associate allo strumento dbForge Documenter per SQL Server e infine ti verrà chiesto di specificare la modalità di ottimizzazione all'avvio per lo strumento. Dopodiché, inizierà il processo di installazione, con un'utile barra di avanzamento che mostra cosa viene installato ora, come mostrato di seguito:
Quando il processo di installazione è stato completato correttamente, la procedura guidata ti avviserà e ti fornirà un'opzione per avviare direttamente lo strumento, come segue:
La prima visualizzazione di dbForge Documenter per SQL Server sarà simile alla finestra seguente. Per creare documentazione per il tuo database utilizzando dbForge Documenter per SQL Server, fai clic sulla finestra Nuova documentazione dalla pagina di benvenuto, come di seguito:
Nella finestra della documentazione aperta, fare clic su Aggiungi connessione per selezionare una connessione esistente o aggiungere una nuova connessione, fornendo il nome del server, le credenziali valide e il nome del database a cui connettersi, utilizzando la pagina amica di seguito:
Dopo la corretta connessione al database, dbForge Documenter per SQL Server elencherà tutti i database e gli oggetti di database nell'istanza di SQL Server connessa. All'inizio, fornisce un'opzione per fornire un nome e una descrizione univoci per la documentazione da generare, oltre al proprio logo, nome e data da visualizzare in tale documentazione, come mostrato di seguito:
Per documentare un database o oggetti di database specifici, controllare il nome del database dall'elenco dei database, rivedere e ottimizzare le diverse proprietà e opzioni del database da includere nella documentazione, ma attivando o disattivando il pulsante di inclusione accanto a ciascuna proprietà e opzione, come mostrato di seguito:
Dopo aver personalizzato cosa includere nella documentazione, fai clic sull'opzione Genera per generare la documentazione del database, in base alle tue selezioni, come segue:
Nella finestra Genera documentazione, specifica il formato della documentazione generata e il percorso e le caratteristiche del nome del file generato, come mostrato di seguito:
Se fai clic sul pulsante Genera, inizierà il processo di generazione della documentazione, con un elenco di controllo intuitivo e una barra di avanzamento per mostrare lo stato corrente del processo di generazione, come di seguito:
Quando il processo di generazione della documentazione è stato completato correttamente, dbForge Documenter per SQL Server ti avviserà con il risultato finale, come indicato di seguito:
Navigando nel percorso in cui è stato salvato il file, vedrai che la documentazione del database viene generata in quel percorso in formato PDF, come mostrato di seguito:
Il report verrà aperto anche nello strumento dbForge Documenter per SQL Server, mostrando la descrizione del database, l'elenco di tutti gli oggetti e i file del database e le proprietà e le opzioni per il database selezionato, come mostrato di seguito:
dbForge Documenter per SQL Server ti offre anche la possibilità di approfondire ogni oggetto di database. Ad esempio, fai clic sul collegamento ipertestuale Tabelle, scegli la tabella che ti interessa e le informazioni complete sulla tabella selezionata verranno visualizzate nel rapporto, come mostrato di seguito:
Dall'esempio seguente è chiaro come possiamo utilizzare lo strumento dbForge Documenter per SQL Server di terze parti in pochi clic per generare documentazione personalizzabile per i tuoi database, che può essere utilizzata per molteplici scopi. Vai e prova a documentare il tuo database usando dbForge Documenter per SQL Server!
