Database HTML Documentation Template

Jason,

All but the sproc dependancy information is available through SchemaExplorer. I think the more that we make full use of SchemaExplorer the better because not only is it a GREAT set of templates to generate documentation, but it's also a GREAT set of templates for demonstrating the capabilities of SchemaExplorer.

Thanks,
Eric J. Smith

Jason,

I needed to make a few changes in order for it to work on my Oracle DB.

Basicly lines like

if (column.ExtendedProperties["CS_IsIdentity"].Value == "true")

needed to be changed to

if (null!=column.ExtendedProperties["CS_IsIdentity"] && column.ExtendedProperties["CS_IsIdentity"].Value == "true")

Thanks for a great script!

Mike

Post Edited (VikingCoder) : 1/16/2004 3:56:27 PM GMT

Bert,

That rocks!! Very cool.

Eric J. Smith

Jason,

Matt, Bert and Jason,

Hi.. I just purchased a licence of CodeSmith this morning and I am having a little trouble using the DbDocumentor Template.

I used it a couple of months ago with the trial version (3.1) no problems.. but now.. either I am working of an older version of the template.. Or I am doing something wrong.

First, when I would try to load the Master.CST. I would get numerous errors. I removed the comments line at the beginning of all files used by the template... reloaded.. it went ok.

Now I filled in the properties.. Database , Server Name.. clicked generate.. 10-20 seconds later I get this..

System.NullReferenceException: Object reference not set to an instance of an object.
at _CodeSmith.sprocs_cst.GenerateProcTextHTML(DatabaseSchema database)
at _CodeSmith.sprocs_cst.Go()
at _CodeSmith.sprocs_cst.__RenderMethod1(TextWriter writer, Control control)
at CodeSmith.Engine.DelegateControl.Render(TextWriter writer)
at CodeSmith.Engine.Control.RenderChildren(TextWriter writer)
at CodeSmith.Engine.CodeTemplate.Render(TextWriter writer)
at CodeSmith.Engine.CodeTemplate.RenderToFile(String path, Boolean overwrite)
at _CodeSmith.master_cst.Go()
at _CodeSmith.master_cst.__RenderMethod1(TextWriter writer, Control control)
at CodeSmith.Engine.DelegateControl.Render(TextWriter writer)
at CodeSmith.Engine.Control.RenderChildren(TextWriter writer)
at CodeSmith.Engine.CodeTemplate.Render(TextWriter writer)
at CodeSmith.Engine.CodeTemplate.RenderToString()
at CodeSmith.Gui.CodeTemplateGenerator.b(Object , EventArgs )


I am sure I am missing the obvious... Anyone can help ?

Thanks in advance...

Fred

Fred,

I had the same error - the problem is that sproc_text.cst does'nt find "AylarSolutions.Highlight.dll" which is referenced as an assembly in the top of the template file. The error does show up as a NullReferenceException, because StoredProceduresTextTemplate returns <undefined>, but the code tries to access

Does anyone have an updated Compiled Help template?
It does not seem to work.
Or if someone can explain how to edit it myself. I attempted to, but it seems to complain because there is a mixture of VB and C#...
I think it is expecting C# when it is processing the VB portions. This was after I edited it, so I could be wrong.
I tried to edit the master.cst file that comes with Codesmith, to add the portion that deals with the Help File.

The master.cst that comes in the Compiled help example above gives a null ref exception looking for index.html

Thanks
Brian

This looks great, thanks for the superb contribution.

 

I don't suppose anyone has ported this to work with CodeSmith 3.2 yet?

Wow, this is really neat. Great tool. Just two comments:

1) If a db has no views or stored procedures the detail section (View Details/Stored Procedure Details) shows "The page cannot be displayed".

2) Bild.bat assumes you have version 3.0 of codesmith. This is very minor and really easy to fix, of course. But maybe the path could be picked up from some environment variable.

Again, great tool.

It does work for 3.2 with a minor modification. Open build.bat and change the path to 3.2 instead of 3.0 and it should work just fine. At least for me it did.

I've just downloaded codesmith and i've find a bug with this template, i think.

I haven't yet time to fix it by myself (first i should read some documentation indeed) so i expose the problem:

 

I have a ' char in some of my fileds name and it cause a crash in running build.bat (i'm using Codesmith 3.1.6)

here is the dump:
C:\Program Files\CodeSmith\v3.0\SampleTemplates\DBDocumenter>build
CodeSmith DBDocumenter Templates v3.0
Author:  Jason Alexander (jason@ngallery.org), Eric J. Smith
Website: http://www.ngallery.org/dbdocumenter/
-------------------------------------------------------------
Beginning documentation...
System.Data.SqlClient.SqlException: Line 10: Incorrect syntax near 'EM'.
Unclosed quotation mark before the character string ') p'.
   at System.Data.SqlClient.SqlCommand.ExecuteReader(CommandBehavior cmdBehavior
, RunBehavior runBehavior, Boolean returnStream)
   at System.Data.SqlClient.SqlCommand.ExecuteReader(CommandBehavior behavior)
   at System.Data.SqlClient.SqlCommand.System.Data.IDbCommand.ExecuteReader(Comm
andBehavior behavior)
   at System.Data.Common.DbDataAdapter.FillFromCommand(Object data, Int32 startR
ecord, Int32 maxRecords, String srcTable, IDbCommand command, CommandBehavior be
havior)
   at System.Data.Common.DbDataAdapter.Fill(DataSet dataSet, Int32 startRecord,
Int32 maxRecords, String srcTable, IDbCommand command, CommandBehavior behavior)

   at System.Data.Common.DbDataAdapter.Fill(DataSet dataSet)
   at a.a(String )
   at SchemaExplorer.SqlSchemaProvider.a(String , String , String , String , Str
ing , String , String )
   at SchemaExplorer.SqlSchemaProvider.GetExtendedProperties(String connectionSt
ring, SchemaObjectBase schemaObject)
   at SchemaExplorer.SchemaObjectBase.get_ExtendedProperties()
   at _CodeSmith.TableDetailTemplate.__RenderMethod1(TextWriter writer, Control
control)
   at CodeSmith.Engine.DelegateControl.Render(TextWriter writer)
   at CodeSmith.Engine.Control.RenderChildren(TextWriter writer)
   at CodeSmith.Engine.CodeTemplate.Render(TextWriter writer)
   at CodeSmith.Engine.CodeTemplate.RenderToFile(String path, Boolean overwrite)

   at _CodeSmith.TablesTemplate.Render(TextWriter writer)
   at CodeSmith.Engine.CodeTemplate.RenderToFile(String path, Boolean overwrite)

   at _CodeSmith.master_cst.Render(TextWriter writer)
   at CodeSmithConsole.EntryPoint.a(String[] )
Done.

i've checked if i have some results anyway and i found that at least some tables where compiled, so i checked the last that i supposed rised the error and i found the problem (i suppose)

the table has some fields containing the ' char ie "Quantita' EM/EF", i hope this helps fixing the problem, keep up with this nice template

Hi, I have tried to visit http://www.ngallery.org/dbdocumenter/ but I have got only this message :( Service Unavailable. Is there any problems?

Hey,
I use last DBDocumenter which is included in CodeSmith 4.0 and I have one problem.

Is there any possibility to set output codepage for rendered html documents?

Because I have MS_Description in codepage Win1250 or in Utf-8 and in the html file is "?" mark instead of our national language letter.

Thanks,
KMax