Red Gate forums: SQL Doc 1

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

frisky — Fri, 02 Mar 2012 11:54:54 GMT

chrisk5 wrote:

With some further testing, I have found that using Database Encryption e.g. TDE will prevent SQL Doc from being able to open the objects. If this is the case, try turning off the encryption.

To the point. The reason lies in this. After turning off the encryption, everything started to work fine. I have I have cell phone spy software SQL Doc 1.3.0.596.

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

chriskelly — Mon, 20 Sep 2010 13:39:35 GMT

Have you been able to document your database using SQL Doc 2, as you mentioned you would try in your previous post?

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

karen — Wed, 15 Sep 2010 20:05:47 GMT

The database is not encrypted, so I don't know why it will not document. However, one of our DBAs has SQL Doc 2, so I will just have him document databases when my old version has issues. (It might be time to get them to buy me an upgrade too!)

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

karen — Thu, 09 Sep 2010 18:16:44 GMT

I am checking with our DBAs to find out if it is encrypted.

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

chriskelly — Thu, 02 Sep 2010 10:58:05 GMT

With some further testing, I have found that using Database Encryption e.g. TDE will prevent SQL Doc from being able to open the objects. If this is the case, try turning off the encryption.

If however, I am wrong can you send to support@red-gate.com some material so that I run some further tests. A script so that I can create your schema would be ideal (no need to send any data). A copy of the Documentation that you have generated would also be useful for comparison. Please mark in the subject header as being for my attention.

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

karen — Wed, 01 Sep 2010 22:24:00 GMT

I am DBO on the particular database I am trying to document, it is SQL 2008 (not 2008 R2). And the tree won't expand to show the tables, views, procedures.

When I document anyway, choosing the box that implis the entire database, it returns one page, that says "�You have not chosen to document any objects in this database"

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

karen — Wed, 01 Sep 2010 21:59:30 GMT

Will the cumulative patch work for this old SQL Doc too? It wasn't clear in the other forum.

RE: Does SQL Doc 1.3 work against SQL Server 10.0?

chriskelly — Wed, 01 Sep 2010 17:11:27 GMT

I have just run this on my test system (SQL Doc v1.3.0.596 & SQL Server v10.0.2531) and it works absolutely fine. There is only a problem with running SQL Doc against SQL Server 2008 R2 for which there is a cumulative patch in the SQL Doc v2 forum.

Does SQL Doc 1.3 work against SQL Server 10.0?

karen — Tue, 31 Aug 2010 16:42:30 GMT

I'm trying to document a database, and when I select the checkbox, it doesn't expand. When I run the doc, it just gives me an overview of the database itself, but doesn't document tables, views, etc. I am dbo in the database.

I have SQL Doc 1.3.0.596 and the database is SQL-Server 10.0.2531

Change help file and compile

indupriyav — Mon, 12 Oct 2009 12:14:04 GMT

We have to change content in the .html helpfiles.

I extracted the Help.chm using the HTML Help Workshop(hhw.exe) with the File-decompile option.

After changing 1 or 2 html files for testing ,I tried to compile but it asked for a hhp file. So I created .hhp file using New-Project and added the .hhc,.hhk & .htm files to be incuded .(When I decompiled the Help.chm it extracted .html,.hhc,.hhk files)

When I compile this new .hhp to Help.chm, its size is 571 KB. But the original Help.chm is 879 KB.

Also If I decompile the original Help.chm it says �575 files extracted�. But the new Help.chm when decompiled says �570 files extracted�.

Please let me know if you have any inputs on this.

RE: Database schema documentation

David Atkinson — Mon, 09 Feb 2009 15:58:10 GMT

fatherjack wrote:

Hi,
I'm afraid I dont have any examples - David/Red-Gate, can you come up with some sample output? Maybe from AdventureWorks?
Jonathan

What I'd suggest for Maciej is to download SQL Doc and try it out. SQL Doc supports MSWord, HTML and CHM outputs. The tool is fully functional for 14 days.

Maciej, we'd love to get your feedback on the tool.

Kind regards,

David

RE: Database schema documentation

fatherjack — Mon, 09 Feb 2009 15:44:36 GMT

Hi,

For my purposes I have used MS Word and PDF for distributing/sharing database object definitions. They seem to be the easiest way to generate a technical document, MSWord with its 'clickable' table of contents is great. PDF is obviously a format that everyone can read regardless of installed software.

For Disaster Recovery/Business Continuity I create and store database scripts in SQL file format on our network. These obviously could change database objects if executed so I only distribute these between DBAs as necessary.

I'm afraid I dont have any examples - David/Red-Gate, can you come up with some sample output? Maybe from AdventureWorks?

HTH

Jonathan

RE: Database schema documentation

David Atkinson — Mon, 09 Feb 2009 12:38:52 GMT

Hi,
Thanks for the questions. I'll do my best to answer them, but I think it would be more interesting if others joined the discussion.

1. No. Comments are only preserved in the database for textual objects, which include Stored Procedures, Functions and Views.

2. SQL Server's MS_Description extended property is SQL-Server-only as far as I'm aware.

3. You're essentially looking for an easy tool/method to annotate your schema elements with documentation and then publish this as a document. SQL Doc will allow you to add descriptions to objects. Have you tried this? If this isn't where you would want this functionality to be, where would you prefer it?

4. Hopefully some SQL Doc users will be able to answer this one for you!

Kind regards,

David Atkinson
Red Gate Software

Database schema documentation

dzieciou — Mon, 09 Feb 2009 10:10:36 GMT

The ISO-standard SQL specifies double dash, --, as a single line comment identifier. Example:

SELECT * FROM Inventory WHERE category = 2 -- Category 2 is electronics

Additionally, the database system may allow for C-style /* ... */ multi-line comments, as well.

1. Just to check: Are this comments preserved in database when executing CREATE TABLE, ALTER TABLE commands ?

2. Some databases (MSSQL) allows to annotate schema elements (tables, columns) with additional documentation, which is then stored in the database. Is it part of the SQL standard? What other databases allows for that?

3. I've seen many databases schemas with external documentation, generated with different documentation tools. I'm particularly interested in tools that support a designer to annotate particular schema elements and generate external documentation (PDF, HTML, DOC ?). What are the most popular tools for schema documentation? (any survey on that?)

4. What are the most popular formats for documentation output? Any examples, I can browse to see how they are formated, structured?

Thanks,
Maciej

RE: How to Print SQL Doc as Data Dictionary

Charles Brown — Thu, 18 Dec 2008 15:02:24 GMT

SQL Doc 2.0 has just been released and includes support for fully printable Word .doc output, which can also be easily converted to pdf preserving all formatting and linkage.

Please see http://www.red-gate.com/messageboard/viewtopic.php?t=8150 for the full announcement.