Please start any new threads on our new site at https://forums.sqlteam.com. We've got lots of great SQL Server experts to answer whatever question you can come up with.

 All Forums
 General SQL Server Forums
 New to SQL Server Administration
 Query Documentation

Author  Topic 

Satya Ranjan
Starting Member

2 Posts

Posted - 2012-02-20 : 05:08:08
Hi,
I need to document my SQL queries for future reference of database developers and programmers.Please give some template/idea how people make documents of queries.

Rgds

visakh16
Very Important crosS Applying yaK Herder

52326 Posts

Posted - 2012-02-20 : 11:35:51
you just need to save the queries as .sql files and put it in a repository like VSS or SVN which provides versioning. Or are you asking for automated way to do this?

------------------------------------------------------------------------------------------------------
SQL Server MVP
http://visakhm.blogspot.com/

Go to Top of Page

Satya Ranjan
Starting Member

2 Posts

Posted - 2012-02-20 : 23:10:11
Hi,
I just want to know how people document their queries.
Its not a technical question, just need the format/template.
I mean what should I write(e.g. Tables/conditions etc.) in the document of a query.

Rgds

quote:
Originally posted by visakh16

you just need to save the queries as .sql files and put it in a repository like VSS or SVN which provides versioning. Or are you asking for automated way to do this?

------------------------------------------------------------------------------------------------------
SQL Server MVP
http://visakhm.blogspot.com/



Go to Top of Page

visakh16
Very Important crosS Applying yaK Herder

52326 Posts

Posted - 2012-02-21 : 14:36:56
we use seperate templates for DDL(CREATE,ALTER,DROP etc) and DML scripts (INSERT,DELETE,UPDATE etc)

In version control repository also we store them under different folders under each project.
Each script will have details of author,date,purpose and revision history if any with version increments

------------------------------------------------------------------------------------------------------
SQL Server MVP
http://visakhm.blogspot.com/

Go to Top of Page

jackv
Master Smack Fu Yak Hacker

2179 Posts

Posted - 2012-02-22 : 01:48:14
some good examples of templates , come with the databases supplied by MS on SQL Server. Open some of the stored procedures.
Similar to visakh - I create DML for all various actions and DDL. The main thing is to come up with a system and stick to it consistently across your organisation

Jack Vamvas
--------------------
http://www.sqlserver-dba.com
Go to Top of Page
   

- Advertisement -