Red Gate forums :: View topic - Improved project file format.
Return to www.red-gate.com RSS Feed Available

Search  | Usergroups |  Profile |  Messages |  Log in  Register 
Go to product documentation
SQL Doc 2
SQL Doc 2 forum

Improved project file format.

Search in SQL Doc 2 forum
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.
Jump to:  
Author Message
lewismoten



Joined: 28 Mar 2006
Posts: 43

PostPosted: Wed Apr 29, 2009 9:36 pm    Post subject: Improved project file format. Reply with quote

My goal is to automate documenting all objects under tables, views, programmability, storage, and security within a single database catalog. In other words - document all objects within a single database catalog.

I have a continuouse integration server setup to build my SQL documentation through the command line. The problem that I am having is that each time a new object is added to my database, I need to manually edit the sqldoc file and add the new object. This is counter productive in an agile development environment.

Upon opening the file, I noticed that it was xml, but was not compatable with generally matching all objects within a single database catalog. In addition, the way that the xml is formatted causes problems with viewing the xml file as text. The "Objects" element is 538,567 characters long on a single line for my database.

Here is my suggestion. First, make the xml managable via text readers such as notepad and visual studio. Break the objects tag apart.

<Objects>

<Object name="..." longname="..." type="..." filename="..." fqname="..." owner="..." issystem="..." parentname="..." parenttype="..." extra="..." />

<Object name="..." longname="..." type="..." filename="..." fqname="..." owner="..." issystem="..." parentname="..." parenttype="..." extra="..." />

...

</Objects>

Next - give us some wild cards.

<ObjectMatch name="%" longname="%" type="Function_Scaler" filename="" fqname="%" owner="dbo" issystem="False" parentname="%" parenttype="%" extra="%" />

As I indicated initially, my main goal is to automate a build to have it scan the database for new objects so that they too are included in the documentation. Anything that will do that would be helpful in getting the job done. Output to the log file stating that "WARN: documentation is missing for [object]" would be great for tracking down missing information.
Back to top
View user's profile Send private message
David Atkinson



Joined: 05 Dec 2005
Posts: 1122
Location: Twitter: @dtabase

PostPosted: Fri May 01, 2009 11:13 pm    Post subject: Reply with quote

Hi,

As far as I'm aware, new objects are select for documentation by default. Is this not the case for you?

Could you please post the command line parameters that you are using?

Thanks,

David Atkinson
Red Gate Software
Back to top
View user's profile Send private message Send e-mail
Display posts from previous:   
This topic is locked: you cannot edit posts or make replies. All times are GMT + 1 Hour
Page 1 of 1

 
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group