Процесът на документиране на база данни на SQL Server е пълен и непрекъснат процес, който трябва да започне по време на фазите на проектиране и разработка на база данни и да продължи през всички жизнени цикли, свързани с базата данни по начин, който гарантира наличието на актуална версия на документацията на базата данни, която отразява реалността във всеки момент от време. Ако се извърши правилно, генерираният файл с документация на базата данни ще съдържа актуален и пълен списък за обектите на базата данни и кратко описание за тези обекти на базата данни.
Процесът на документиране на база данни на SQL Server може да се извърши по няколко начина. Можете просто да създадете диаграма на базата данни, която показва списък на всички таблици и колони на базата данни и да актуализира тази диаграма, когато се извърши някаква промяна. Но четенето и поддържането на такава диаграма не е лесен процес за големи бази данни с десетки таблици на база данни, като всяка таблица съдържа десетки колони.
Започвайки от SQL Server 2005, Microsoft въведе нова функция, наречена Extended Properties, която се съхранява в самата база данни и се осъществява достъп чрез системния обект sys.extended_properties и връща информация за метаданни, свързана с определената база данни или обекти на база данни. Документирането на базата данни на SQL Server с помощта на разширените свойства не е най-добрият избор, тъй като можете да документирате една база данни наведнъж, няма исторически данни, тъй като свойствата на обектите на базата данни ще бъдат изтрити, когато този обект бъде изтрит, това не е обикновен процес тъй като изисква добри умения за развитие, изисква големи усилия и отнема много време.
Използване на Visual Studio
Разработчиците, които са запознати с Microsoft Visual Studio, могат лесно да се възползват от типа проект на SQL Server, за да се свържат с база данни на SQL Server и да проверят метаданните за обектите на базата данни.
За да постигнете това, отворете инструмента Visual Studio и създайте нов проект за база данни на SQL Server от прозореца Нов проект, както е показано по-долу:
В прозореца Нов проект посочете уникално име за този проект, където да запишете този проект, след което щракнете върху OK, за да създадете проекта за база данни на SQL Server. Когато проектът е създаден, щракнете върху свойствата на проекта и конфигурирайте стойността на Target Platform с версията на SQL Server на целевата база данни, както е показано по-долу:
За да се свържете с конкретна база данни, щракнете с десния бутон върху създадения проект и изберете опцията Импортиране -> База данни, както следва:
От прозореца за импортиране на база данни изберете връзка от списъка с по-рано запазени връзки или посочете името на сървъра, удостоверените идентификационни данни и името на базата данни, за да се свържете с базата данни, която да бъде документирана, както следва:
Когато се свържете с бутона Connect, инструментът ще започне да събира информация за метаданни за всички обекти на базата данни, както е показано по-долу:
След събиране и импортиране на цялата информация за базата данни, избраните обекти на базата данни ще бъдат показани в изследователя на решения, категоризирани по схема, както следва:
За да видите информацията за метаданни за който и да е обект на база данни, разширете схемата от изследователя на решения и щракнете върху този обект и ще се отвори нов прозорец, показващ цялото описание за избрания обект, с T-SQL скрипт за създаване на този конкретен обект, както е показано по-долу:
Той също така ви предоставя възможността да покажете колоната Описание за всеки обект на база данни, като щракнете с десния бутон върху свободното пространство до избраната таблица и изберете опцията Описание. Ще се покаже нова колона, показваща описание за всяка колона, с възможност за редактиране на описанието, както е показано по-долу:
Въпреки че е твърде лесно да се документира вашата база данни с помощта на Visual Studio, тя не предоставя централизирано място за проверка на множество обекти на база данни, предоставя информация за една база данни за всеки проект и не може да бъде експортирана в удобен за потребителя или формат за печат!
Използване на dbForge Documenter за SQL Server
За да спестите вашето време и усилия и да актуализирате документацията на вашата база данни, по-добре е да използвате инструмент на трета страна, който улеснява процеса на документиране. dbForge Documenter за SQL Server е инструмент за документиране на база данни, който може лесно да бъде свързан към вашата база данни и генерира документация за всички обекти на база данни на SQL Server с няколко щраквания.
dbForge Documenter за SQL Server ни предоставя широка гама от стилови шаблони и опции, които помагат при персонализирането на генерираната документация, за да отговори на вашите собствени изисквания. За няколко секунди от конфигурирането, dbForge Documenter за SQL Server извлича цялата информация и обширни подробности за избраната база данни, както и междуобектни зависимости и DDL T-SQL скриптове за създаване на тези обекти, с възможност за експортиране на документацията в HTML с възможност за търсене , PDF и Markdown файлови формати. HTML форматът помага при публикуването на базата данни в мрежата, а PDF форматът е подходящ за разпространение в други системи и споделяне на други устройства. dbForge Documenter за SQL Server също може да бъде достъпен за документиране на базата данни директно чрез SQL Server Management Studio, тъй като е интегриран със SSMS.
dbForge Documenter за SQL Server може да бъде изтеглен от центъра за изтегляне на Devart и инсталиран на вашия сървър, като преминете през съветника за директна инсталация, както е показано по-долу:
Когато щракнете върху бутона Инсталиране, за да стартирате процеса на инсталиране, ще бъдете помолени да посочите инсталационния път за инструмента, ако успеете да създадете икона на работния плот за инструмента за по-бърз достъп до него, версиите на SQL Server Management Studio да имате този инструмент като добавка към него, разширенията на файловете, които ще бъдат свързани с инструмента dbForge Documenter за SQL Server и накрая ще бъдете помолени да посочите режима за оптимизация при стартиране на инструмента. След това процесът на инсталиране ще започне с полезна лента за напредък, която показва какво се инсталира в момента, както е показано по-долу:
Когато инсталационният процес завърши успешно, съветникът ще ви уведоми и ще ви предостави опция за директно стартиране на инструмента, както следва:
Първият изглед на dbForge Documenter за SQL Server ще бъде подобен на прозореца по-долу. За да създадете документация за вашата база данни с помощта на dbForge Documenter за SQL Server, щракнете върху прозореца Нова документация от началната страница, както е по-долу:
В отворения прозорец с документация щракнете върху Добавяне на връзка, за да изберете съществуваща връзка или да добавите нова връзка, като предоставите името на сървъра, валидни идентификационни данни и името на базата данни, с която да се свържете, като използвате приятелската страница по-долу:
След успешно свързване с базата данни, dbForge Documenter за SQL Server ще изброи всички бази данни и обекти на база данни под свързания екземпляр на SQL Server. В началото ви предоставя възможност да предоставите уникално име и описание за документацията, която ще бъде генерирана, в допълнение към вашето собствено лого, име и дата, които да се показват в тази документация, както е показано по-долу:
За да документирате конкретна база данни или обекти на база данни, проверете името на базата данни от списъка с бази данни, прегледайте и настройте различните свойства и опции на базата данни, които да бъдат включени в документацията, но включване или изключване на бутона за включване до всяко свойство и опция, както е показано по-долу:
След като персонализирате какво да включите във вашата документация, щракнете върху опцията Генериране, за да генерирате документация за база данни въз основа на вашите избори, както следва:
В прозореца Генериране на документация посочете формата на генерираната документация и пътя и характеристиката на името на генерирания файл, както е показано по-долу:
Ако щракнете върху бутона Генериране, процесът на генериране на документация ще започне, с лесен за потребителя контролен списък и лента за напредък, за да се покаже текущото състояние на процеса на генериране, както е по-долу:
Когато процесът на генериране на документация завърши успешно, dbForge Documenter за SQL Server ще ви уведоми с крайния резултат, както следва:
Преглеждайки пътя, където е записан файлът, ще видите, че документацията на базата данни се генерира под този път в PDF формат, както е показано по-долу:
Отчетът ще бъде отворен също в инструмента dbForge Documenter за SQL Server, показващ описание на базата данни, списък на всички обекти и файлове на базата данни и свойствата и опциите за избраната база данни, както е показано по-долу:
dbForge Documenter за SQL Server ви предоставя също така възможността да се потопите дълбоко във всеки обект на база данни. Например, щракнете върху хипервръзката Таблици, изберете таблицата, която ви интересува и пълната информация за избраната таблица ще бъде показана в отчета, както е показано по-долу:
От примера по-долу става ясно как можем да използваме инструмента dbForge Documenter за SQL Server на трета страна с няколко щраквания, за да генерираме персонализирана документация за вашите бази данни, която може да се използва за множество цели. Отидете и опитайте да документирате вашата база данни с помощта на dbForge Documenter за SQL Server!
