dbTalk Databases Forums  

Database documentation

comp.databases.berkeley-db comp.databases.berkeley-db


Discuss Database documentation in the comp.databases.berkeley-db forum.



Reply
 
Thread Tools Display Modes
  #1  
Old   
Maciej Gawinecki
 
Posts: n/a

Default Database documentation - 02-09-2009 , 03:56 AM






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


Reply With Quote
Reply




Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off



Powered by vBulletin Version 3.5.3
Copyright ©2000 - 2012, Jelsoft Enterprises Ltd.