Documents SQL Server 2000, 2005 and 2008 databases.


Postby dbaadm » Wed Jul 25, 2007 8:54 am

Would it possible to create ones own batch application with help of the SQL Doc API in order to automatic documentation of multi servers/instances?

Here I think in the lines of how the API for SQL Compare works.

The reason I would like to have only one compiled Microsoft HTML Help (.chm file) for a system that are located on more then one server.

I would like to be able to select on high object level (Database – Tables, Views Programmability and Security), what’s should in the .chm file.

I know that I could use the command line feature that’s comes with the Pro version, but is builds one file pr server and then merge the .chm files into one.
But it would be nice if I could use the SQL Doc API, since I now have the Pro version.
Posts: 4
Joined: Mon May 09, 2005 12:23 pm

Postby chris.buckingham » Mon Jul 30, 2007 1:36 pm

I'm afraid that there isn't a SQL Doc API that you can use, but it is possible to call a sequence of SQLdoc sessions by using a batch file calling the SQL Doc command line for each project.

You have to set up each project file first using the GUI, setting a target directory for each project, with source databases, passwords etc. The batch file can then call a CHM publisher through a command line to write CHM files using each target directory as a source. Simple root level html code would have to be written to call the 'index.html' from each target directory so that a tree structure would be displayed - however that would only have to be created once

The help file in SQL Doc under 'Using the Command Line' explains the command line syntax.
Chris Buckingham
Red-Gate support
Posts: 56
Joined: Mon Jul 30, 2007 12:39 pm

Postby dbaadm » Tue Jul 31, 2007 10:58 am

You input works partly. I looks like if the SQL Doc Application has been open and the output style has been changed to an outer style it's the "new" style the output saves - no matter the project file state the OutputStyle should be :(
I think that must be a bug or….
Posts: 4
Joined: Mon May 09, 2005 12:23 pm

Postby David Atkinson » Sun Nov 18, 2007 9:09 pm


The output style option is an application-level option, rather than a project-level option. Do you require different output styles depending on your project? If so I will raise this as an enhancement request. I would be interested to know any reasons behind this, as this would add weight to the request.

Best regards,

David Atkinson
Red Gate Software
David Atkinson
Posts: 1143
Joined: Mon Dec 05, 2005 3:54 pm
Location: Twitter: @dtabase

Return to SQL Doc Previous Versions

Who is online

Users browsing this forum: No registered users and 0 guests