Contents Diagrams Roles Schemas Tables Views Procedures Functions

Database Help Framework
for Microsoft SQL Server

Views

ViewDescription
doc.view_diagramsThis view is an Excel form for editing diagram help.
doc.view_historyThis view is an Excel form for editing database history.
doc.view_objectsThis view is an Excel form for editing database object help.
doc.view_online_help_handlersThis view selects the handler configuration for the Actions menu.
doc.view_orphan_rowsThis view is an Excel form for editing orphan rows.
doc.view_pagesThis view is an Excel form for editing page help.
doc.view_propertiesThis view is an Excel form for editing HTML page properties.
doc.view_query_listThis view selects framework objects for the SaveToDB Connection Wizard and SaveToDB Query List.
doc.view_routine_columnsThis view is an Excel form for editing routine column help.
doc.view_routine_parametersThis view is an Excel form for editing routine parameter help.
doc.view_table_columnsThis view is an Excel form for editing table column help.
doc.view_view_columnsThis view is an Excel form for editing view column help.

doc.view_diagrams

This view is an Excel form for editing diagram help.

Source tables: doc.help

ColumnDataTypeComment
IDintdoc.help.ID
DIAGRAM_SCHEMAnvarchar(20)Related database schema

doc.help.TABLE_SCHEMA
DIAGRAM_NAMEnvarchar(128)Diagram name

doc.help.TABLE_NAME

Use names like Diagram 01, Diagram 02, etc.
DIAGRAM_URLnvarchar(255)Diagram image URL

doc.help.COLUMN_NAME

Note that the field has max length 255 characters.
LANGUAGE_NAMEchar(2)Two characters of the description language code like 'en' or 'fr'
VERSIONnvarchar(50)Diagram version for informational purposes
TITLEnvarchar(1024)Diagram title

doc.help.DESCRIPTION
COMMENTnvarchar(max)Diagram complete description

doc.help.COMMENT

To add a new diagram, add or copy the row.

Note that DIAGRAM_SCHEMA, DIAGRAM_NAME, DIAGRAM_URL, and LANGUAGE_NAME must be unique within the table.

doc.view_history

This view is an Excel form for editing database history.

Source tables: doc.history

ColumnDataTypeComment
IDintdoc.history.ID
EXCEL_SORT_ORDERbigintUse this column to sort rows in Microsoft Excel.

Save the changes in the table to update the field.
SECTION_SORT_ORDERtinyintThis field has a numeric value of SECTION_ID.

You may use it for sorting data or conditional formatting.
TABLE_SCHEMAnvarchar(20)Related database schema

doc.history.TABLE_SCHEMA
SECTION_IDtinyintdoc.history.SECTION_ID
LANGUAGE_NAMEchar(2)doc.history.LANGUAGE_NAME
VERSIONnvarchar(50)doc.history.VERSION
SORT_ORDERtinyintdoc.history.SORT_ORDER within a section
DESCRIPTIONnvarchar(1024)doc.history.DESCRIPTION
COMMENTnvarchar(max)doc.history.COMMENT

The value is not used with version titles.

To add a new record, add or copy the row.

doc.view_objects

This view is an Excel form for editing database object help.

Source tables: doc.help

ColumnDataTypeComment
SORT_ORDERbigintThis is an auto-generated column used to sort rows in Microsoft Excel
SECTION_IDintdoc.sections.id

1 - database objects
2 - schemas
3 - roles
6 - database properties
TABLE_SCHEMAnvarchar(128)Object schema or pseudo-schema:

database - database properties
roles - database roles
schemas - database schemas
TABLE_NAMEnvarchar(128)Object, role, schema, or property name

The database properties includes:

stylesheet_href - URL of the stylesheet
head - any value in the COMMENT column to include into the HTML head section
title - document title
TYPEnvarchar(4000)INFORMATION_SCHEMA.TABLES.TABLE_TYPE,
INFORMATION_SCHEMA.ROUTINES.ROUTINE_TYPE
LANGUAGE_NAMEvarchar(2)doc.help.LANGUAGE_NAME
VERSIONnvarchar(50)doc.help.VERSION
DESCRIPTIONnvarchar(1024)doc.help.DESCRIPTION
COMMENTnvarchar(max)doc.help.COMMENT
HAS_COMMENTSint1 - has comments
0 - has no comments

The view selects all database objects and related properties.

You cannot add new rows. You may delete rows to delete help topics.

Use the doc.view_orphan_rows view to edit object names after name changes in a database.

doc.view_online_help_handlers

This view selects the handler configuration for the Actions menu.

Source tables: doc.help

ColumnDataTypeComment
TABLE_SCHEMAnvarchar(20)doc.help.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)doc.help.TABLE_NAME
COLUMN_NAMEnvarchar(128)NULL
EVENT_NAMEvarchar(7)Actions
HANDLER_SCHEMAnvarchar(20)doc.help.TABLE_SCHEMA
HANDLER_NAMEnvarchar(172)Online Database Help - <schema>.<name>
HANDLER_TYPEvarchar(13)HTTP or MENUSEPARATOR
HANDLER_CODEnvarchar(4000)Online help hyperlink
TARGET_WORKSHEETnvarchar(30)NULL
MENU_ORDERintHandler order in the context menu (90, 91)
EDIT_PARAMETERSbitNULL

The view adds items to the Actions menu to open the online help.

The underlying object must have help topics and the object schema must have the online_help_url value.

doc.view_orphan_rows

This view is an Excel form for editing orphan rows.

Source tables: doc.help

ColumnDataTypeComment
IDintdoc.help.ID
SECTION_IDtinyintdoc.help.SECTION_ID
TABLE_SCHEMAnvarchar(20)doc.help.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)doc.help.TABLE_NAME
COLUMN_NAMEnvarchar(255)doc.help.COLUMN_NAME
LANGUAGE_NAMEchar(2)doc.help.LANGUAGE_NAME
VERSIONnvarchar(50)doc.help.VERSION
DESCRIPTIONnvarchar(1024)doc.help.DESCRIPTION
COMMENTnvarchar(max)doc.help.COMMENT

Use this view to change object names after name changes in a database.

You may delete rows to delete help topics.

doc.view_pages

This view is an Excel form for editing page help.

Source tables: doc.help

ColumnDataTypeComment
SORT_ORDERbigintThis is an auto-generated column used to sort rows in Microsoft Excel
TABLE_SCHEMAnvarchar(128)Related database schema
TABLE_NAMEvarchar(12)Page name. See the description below.
LANGUAGE_NAMEvarchar(2)Two characters of the description language code like 'en' or 'fr'
VERSIONnvarchar(50)Page version for informational purposes.
DESCRIPTIONnvarchar(1024)Page title.

The field has name DESCRIPTION to be consistent with other tables.
COMMENTnvarchar(max)Page content

The view selects the predefined pages included into the generated documentation for every database schema:

- introduction
- diagrams
- roles
- schemas
- tables
- views
- procedures
- functions
- conclusion

You may omit the description shown as a header h3.

doc.view_properties

This view is an Excel form for editing HTML page properties.

Source tables: doc.help

ColumnDataTypeComment
SORT_ORDERbigintThis is an auto-generated column used to sort rows in Microsoft Excel
SECTION_IDintdoc.help.SECTION_ID
TABLE_SCHEMAnvarchar(128)doc.help.TABLE_SCHEMA
TABLE_NAMEvarchar(15)doc.help.TABLE_NAME
LANGUAGE_NAMEvarchar(2)doc.help.LANGUAGE_NAME
COMMENTnvarchar(max)doc.help.COMMENT

Use this view to customize the generated HTML help.

doc.view_query_list

This view selects framework objects for the SaveToDB Connection Wizard and SaveToDB Query List.

Source tables: doc.objects

ColumnDataTypeComment
TABLE_SCHEMAnvarchar(128)doc.objects.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)doc.objects.TABLE_NAME
TABLE_TYPEvarchar(10)INFORMATION_SCHEMA.TABLES.TABLE_TYPE
TABLE_CODEnvarchar(max)Not used
INSERT_PROCEDUREnvarchar(max)doc.objects.INSERT_OBJECT
UPDATE_PROCEDUREnvarchar(max)doc.objects.UPDATE_OBJECT
DELETE_PROCEDUREnvarchar(max)doc.objects.DELETE_OBJECT
PROCEDURE_TYPEvarchar(9)Information column, not used:
TABLE - the add-in saves data into the specified table
PROCEDURE - the add-in saves data using the specified procedures

See also Configuring Query Lists.

doc.view_routine_columns

This view is an Excel form for editing routine column help.

Source tables: doc.help

ColumnDataTypeComment
SORT_ORDERbigintThis is an auto-generated column used to sort rows in Microsoft Excel
TABLE_SCHEMAnvarchar(128)INFORMATION_SCHEMA.ROUTINE_COLUMNS.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)INFORMATION_SCHEMA.ROUTINE_COLUMNS.TABLE_NAME
ORDINAL_POSITIONintINFORMATION_SCHEMA.ROUTINE_COLUMNS.ORDINAL_POSITION
COLUMN_NAMEnvarchar(128)INFORMATION_SCHEMA.ROUTINE_COLUMNS.PARAMETER_NAME
DATA_TYPEnvarchar(191)INFORMATION_SCHEMA.ROUTINE_COLUMNS.DATA_TYPE
LANGUAGE_NAMEvarchar(2)Two characters of the description language code like 'en' or 'fr'
DESCRIPTIONnvarchar(1024)doc.help.DESCRIPTION
HAS_COMMENTSbit1 - has comments
0 - has no comments

The view selects all actual function output columns and input parameters.

You cannot add new rows. You may delete rows to delete help topics.

Use the doc.view_orphan_rows view to edit object names after name changes in a database.

doc.view_routine_parameters

This view is an Excel form for editing routine parameter help.

Source tables: doc.help

ColumnDataTypeComment
SORT_ORDERbigintThis is an auto-generated column used to sort rows in Microsoft Excel
ROUTINE_SCHEMAnvarchar(128)doc.help.TABLE_SCHEMA
ROUTINE_NAMEnvarchar(128)doc.help.TABLE_NAME
ORDINAL_POSITIONintINFORMATION_SCHEMA.PARAMETERS.ORDINAL_POSITION
PARAMETER_NAMEnvarchar(128)INFORMATION_SCHEMA.PARAMETERS.PARAMETER_NAME, doc.help.COLUMN_NAME
DATA_TYPEnvarchar(191)INFORMATION_SCHEMA.PARAMETERS.DATA_TYPE
PARAMETER_MODEnvarchar(10)INFORMATION_SCHEMA.PARAMETERS.PARAMETER_MODE
LANGUAGE_NAMEvarchar(2)Two characters of the description language code like 'en' or 'fr'
DESCRIPTIONnvarchar(1024)doc.help.DESCRIPTION
HAS_COMMENTSbit1 - has comments
0 - has no comments

The view selects all actual stored procedure parameters.

You cannot add new rows. You may delete rows to delete help topics.

Use the doc.view_orphan_rows view to edit object names after name changes in a database.

doc.view_table_columns

This view is an Excel form for editing table column help.

Source tables: doc.help

ColumnDataTypeComment
SORT_ORDERbigintThis is an auto-generated column used to sort rows in Microsoft Excel
TABLE_SCHEMAnvarchar(128)INFORMATION_SCHEMA.COLUMNS.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)INFORMATION_SCHEMA.COLUMNS.TABLE_NAME
ORDINAL_POSITIONintINFORMATION_SCHEMA.COLUMNS.ORDINAL_POSITION
COLUMN_NAMEnvarchar(128)INFORMATION_SCHEMA.COLUMNS.COLUMN_NAME
DATA_TYPEnvarchar(191)INFORMATION_SCHEMA.COLUMNS.DATA_TYPE
IS_PKintINFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE.COLUMN_NAME
IS_IDENTITYintsys.columns.is_identity
IS_NULLABLEintINFORMATION_SCHEMA.COLUMNS.IS_NULLABLE
REFERENTIAL_COLUMNnvarchar(386)INFORMATION_SCHEMA.KEY_COLUMN_USAGE.COLUMN_NAME
LANGUAGE_NAMEvarchar(2)Two characters of the description language code like 'en' or 'fr'
DESCRIPTIONnvarchar(1024)doc.help.DESCRIPTION
HAS_COMMENTSbit1 - has comments
0 - has no comments

The view selects all actual table columns.

You cannot add new rows. You may delete rows to delete help topics.

Use the doc.view_orphan_rows view to edit object names after name changes in a database.

doc.view_view_columns

This view is an Excel form for editing view column help.

Source tables: doc.help

ColumnDataTypeComment
SORT_ORDERbigintThis is an auto-generated column used to sort rows in Microsoft Excel
TABLE_SCHEMAnvarchar(128)INFORMATION_SCHEMA.COLUMNS.TABLE_SCHEMA
TABLE_NAMEnvarchar(128)INFORMATION_SCHEMA.COLUMNS.TABLE_NAME
ORDINAL_POSITIONintINFORMATION_SCHEMA.COLUMNS.ORDINAL_POSITION
COLUMN_NAMEnvarchar(128)INFORMATION_SCHEMA.COLUMNS.COLUMN_NAME
DATA_TYPEnvarchar(191)INFORMATION_SCHEMA.COLUMNS.DATA_TYPE
REFERENTIAL_COLUMNnvarchar(386)INFORMATION_SCHEMA.VIEW_COLUMN_USAGE
LANGUAGE_NAMEvarchar(2)Two characters of the description language code like 'en' or 'fr'
DESCRIPTIONnvarchar(1024)doc.help.DESCRIPTION
HAS_COMMENTSbit1 - has comments
0 - has no comments

The view selects all actual view columns.

You cannot add new rows. You may delete rows to delete help topics.

Use the doc.view_orphan_rows view to edit object names after name changes in a database.

Contents

This website is using cookies. By continuing to browse, you give us your consent to our use of cookies as explained in our Cookie Policy.