Avatar of gudii9
gudii9Flag for United States of America

asked on 

database best documentation

we have hundreds of flows like registration, sales, cancellation from front end java applicatio to SQL database.

Microsoft SQL database has hundreds of stored procedures, tables, columns, joins, primary keys, foreign keys etc.

it is getting hard to check database stored procedures, tables if issue come on say sales flow to check quickly as no proper documention on database side.

what kind of documentation is good to have on database side.

i think like one excel spreadsheet  with columns like stored procedures, then next column relevant tables then next column table 1 columns, table 2 columns and then highight primary key as yellow color and then next column joins and other related tables

please advise any other better ways and best practices and links resources on it
Microsoft SQL ServerJavaMicrosoft SQL Server 2005Microsoft SQL Server 2008SQL

Avatar of undefined
Last Comment
Avatar of Jim Horn
Jim Horn
Flag of United States of America image

Blurred text
View this solution by signing up for a free trial.
Members can start a 7-Day free trial and enjoy unlimited access to the platform.
See Pricing Options
Start Free Trial
Avatar of D B
Flag of United States of America image

No points please, I just want to add to Jim's comments. I've used SQLDoc from Redgate and very highly recommend it. There is a 14-day free trial available that is 100% functional. It can create a Word or PDF document or a clickable .chm file that you can navigate through.

Along with his suggestion, I would also look into creating extended properties. They can be created on pretty much any object on any level (e.g. on the database, a table, table columns, indexes, stored procedures, functions, etc.). Most documenting utilities (like SQLDoc) will pick these up and include them in the documentation. They make for great self-documentation. It is a pain to do after the fact, but worth the effort if time can be devoted to it. In SSMS, right-click on the object, select Properties, then select the Extended Properties page.

Another good Redgate tool is their SQL Dependency Tracker, which allows you to map out dependencies within your database, You can print it out but I wouldn't recommend that unless you've got a relatively small database as it can get VERY crowded and you'll be unable to make heads or tails of the printout.
Microsoft SQL Server
Microsoft SQL Server

Microsoft SQL Server is a suite of relational database management system (RDBMS) products providing multi-user database access functionality.SQL Server is available in multiple versions, typically identified by release year, and versions are subdivided into editions to distinguish between product functionality. Component services include integration (SSIS), reporting (SSRS), analysis (SSAS), data quality, master data, T-SQL and performance tuning.

Top Experts
Get a personalized solution from industry experts
Ask the experts
Read over 600 more reviews


IBM logoIntel logoMicrosoft logoUbisoft logoSAP logo
Qualcomm logoCitrix Systems logoWorkday logoErnst & Young logo
High performer badgeUsers love us badge
LinkedIn logoFacebook logoX logoInstagram logoTikTok logoYouTube logo