What are the challenges you face when working across database platforms? Take the survey
Options

Suggestion for enhancement

rcroederrcroeder Posts: 9
edited November 7, 2009 3:38PM in SQL Doc Previous Versions
The product works nice, however it could be enhanced. The program could point to a second database that contain the structure of the database being document, in such a format similar to syscolumns but with additional fields to handled notes regarding the field and tables. When SQL Doc runs it will update the SQL database by adding new fields, and marking fields that are deprecated. The output from SQL Doc would include the “Extra” data. A simple query could be added to see new tables and fields that need to be updated and fields that have been deprecated.
rc roeder

Comments

  • Options
    Brian DonahueBrian Donahue Posts: 6,590 Bronze 1
    Hello Bob,

    Thanks for the suggestion, but it sounds like the sort of thing you can already do with SQL Compare:
    http://www.red-gate.com/products/SQL_Co ... dex_v2.htm
  • Options
    Brian,

    Not really, the SQL DOC is a method to provide documentation table. What I am suggesting is to tie that documentation to a database just for database documentation where the database can be further documented. If you look at the output from SQL Doc it gives you the structure of each table, but detail information regarding the usage or meaning of each field is missing.

    As an example for table __ApplicationGroupToGroupAreaSite I may want to add additional documentation

    [ApplicationGroupToGroupAreaSiteID] [int]
    [ApplicationGroupID] [int]
    [ApplicationGroupAreaID] [int]
    [ApplicationLicenseSubTypeID] [int]
    [ApplicationLicenseTypeID] [int]
    [SiteTypeID] [int] What type of site is being displayed see table _applicationSiteType
    [DisplayOrder] [int]
    [StatusID] [int]
    [AgencyID] [int] Current agency being rendered
    [AppRefGUID] [uniqueidentifier]
    [Side] [int] Determines the side of the form to draw the element, 0=left 1=right
    rc roeder
  • Options
    Brian DonahueBrian Donahue Posts: 6,590 Bronze 1
    Hello Bob,

    SQL Doc has the ability to add a "description" to a table column. Click the "Description" button next to the column and type in a description. This will add a SQL Server Extended Property to the column, which will persist in the database and can even be viewed outside of SQL Doc via SQL Server's fn_listextendedproperties function.
Sign In or Register to comment.