Jak mogę dokumentować tabele i pola w SQL Server 2005

Question

Tęskniłem za tym jakoś w procesie uczenia się mojego serwera SQL.

Chciałbym móc dokumentować tabele/pola/procedury w naszym środowisku SQL Server 2005 i nie mogę znaleźć sposobu, aby to zrobić. Czy to możliwe, czy też potrzebowałbym jakiejś aplikacji innej firmy?

To brzmi jak nieobliczalna funkcja, więc prawdopodobnie przeoczyłem to.

Dzięki!

JH

EDIT: Specifially, mówię o dokumentowaniu obiektów SQL ('tabela ta służy do bla, i odwołuje się foo i bar.'). Dzięki za całą pomoc - przybraliście to.

Answer 1

Serwer SQL ma Extended Properties, którego można użyć do tego celu.

Answer 2

Jednym z najlepszych narzędzi do dokumentowania jest oprogramowanie o nazwie SQL Doc firmy RedGate.

Answer 3

Istnieje wiele narzędzi - ja osobiście bardzo lubię SQL Doc (od Red-Gate, wspomniano wcześniej), ale także ApexSQL's ApexSQL Doc.

Ale wiele innych narzędzi również będzie odczytywać i dokumentować schematy bazy danych - jeśli masz już program piszący o pomocy, sprawdź to - może nawet obsługiwać dokumentację bazy danych!

Marc

Answer 4

Z stored_procedures, widoków i funkcji można po prostu dodać składni komentarz do definicji obiektów takich jak:

/* 
some comment 
*/ 
create view dbo.view sample ... 

z tabel i pól jest to nieco bardziej skomplikowane, można użyć Extended Properties zgodnie z sugestią przez Chris. Możesz uzyskać do niego dostęp za pomocą Management Studio, wybierając tabelę w eksplorowanym obiekcie i Właściwości z menu kontekstowego.

Jeśli możesz sobie pozwolić na inwestowanie w narzędzia można odebrać SQL Doc jak sugeruje TheTXI

Answer 5

Należy spojrzeć na www.aphilen.com Mają dokumentacyjnych SQL dostępne mogą pomagać z czego ARR stara się osiągnąć alternatywnie możesz to wszystko zrobić ręcznie, jeśli masz czas używając sp_help nazwa_obiektu