2009-03-31 9 views
5

J'ai manqué cela d'une manière ou d'une autre dans mon processus d'apprentissage SQL Server. J'aimerais pouvoir documenter des tables/champs/procédures dans notre environnement SQL Server 2005, et je ne trouve pas de moyen de le faire. Est-ce possible ou aurais-je besoin d'une application tierce? Cela ressemble à une fonctionnalité simple, donc je l'ignore probablement.Comment puis-je documenter des tables et des champs dans SQL Server 2005

Merci!

JH

EDIT: specifially, je parle de la documentation des objets SQL ('ce tableau est utilisé pour blah, et est référencé par foo, et un bar.'). Merci pour toute l'aide - vous les avez cloués.

+0

Que voulez-vous dire par document? Juste une liste? –

+1

+ 1 pour même vouloir documenter quoi que ce soit! :-) –

Répondre

5

SQL Server a Extended Properties que vous pouvez utiliser à cette fin.

+0

Ceci est excellent - n'en avait pas entendu parler, et répondra parfaitement à nos besoins. Gloire. – Ducain

3

L'un des meilleurs outils de documentation est appelé SQL Doc par le logiciel RedGate.

0

Il ya beaucoup d'outils - Personnellement, j'aime vraiment SQL Doc (par Red-Gate, mentionné auparavant), mais aussi ApexSQL Doc d'ApexSQL. Mais beaucoup d'autres outils vont aussi lire et documenter des schémas de base de données - si vous avez déjà un rédacteur d'aide, vérifiez-le - il pourrait même soutenir la documentation de base de données, aussi!

Marc

0

Avec stored_procedures, les vues et les fonctions que vous pouvez simplement ajouter une syntaxe de commentaire à la définition de l'objet comme:

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

avec des tables et des champs, il est un peu plus compliqué, vous pouvez utiliser Extended Properties comme suggéré par Chris. Vous pouvez y accéder via Management Studio en sélectionnant la table dans l'objet exploré et Propriétés dans le menu contextuel.

Si vous pouvez vous permettre d'investir dans les outils que vous pouvez choisir SQL Doc comme suggéré par TheTXI

0

Vous devriez regarder www.aphilen.com ils ont un outil de documentation SQL disponibles, ils peuvent aider à ce que vous essayez d'atteindre ARR alternativement vous pouvez le faire tous manuellement si vous avez le temps en utilisant sp_help objectname

Questions connexes