Database Help Framework
for Microsoft SQL Server
Tables
| Table | Description |
|---|---|
| doc.formats | This application table contains Excel table formats of the database help framework objects. |
| doc.handlers | This application table contains Excel event handlers of the database help framework objects. |
| doc.help | This user table contains database help. |
| doc.help_sections | This application table contains help sections. |
| doc.history | This user table contains database change history. |
| doc.history_sections | This application table contains database change history sections. |
| doc.objects | This application table contains the configuration of saving changes. |
| doc.translations | This application table contains translations of the database help framework objects. |
| doc.workbooks | This application table contains workbook configuration for SaveToDB Application Workbooks wizard. |
doc.formats
This application table contains Excel table formats of the database help framework objects.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | int | Identity | |
| TABLE_SCHEMA | nvarchar(20) | xls.formats.TABLE_SCHEMA | ||
| TABLE_NAME | nvarchar(128) | xls.formats.TABLE_NAME | ||
| TABLE_EXCEL_FORMAT_XML | xml | ✓ | xls.formats.TABLE_EXCEL_FORMAT_XML |
This table is a copy of the xls.formats table of the SaveToDB Framework to avoid external dependency.
See Configuring Table Formats.
doc.handlers
This application table contains Excel event handlers of the database help framework objects.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | int | Identity | |
| TABLE_SCHEMA | nvarchar(20) | ✓ | xls.handlers.TABLE_SCHEMA | |
| TABLE_NAME | nvarchar(128) | xls.handlers.TABLE_NAME | ||
| COLUMN_NAME | nvarchar(128) | ✓ | xls.handlers.COLUMN_NAME | |
| EVENT_NAME | varchar(25) | ✓ | xls.handlers.EVENT_NAME | |
| HANDLER_SCHEMA | nvarchar(20) | ✓ | xls.handlers.HANDLER_SCHEMA | |
| HANDLER_NAME | nvarchar(128) | ✓ | xls.handlers.HANDLER_NAME | |
| HANDLER_TYPE | varchar(25) | ✓ | xls.handlers.HANDLER_TYPE | |
| HANDLER_CODE | nvarchar(max) | ✓ | xls.handlers.HANDLER_CODE | |
| TARGET_WORKSHEET | nvarchar(128) | ✓ | xls.handlers.TARGET_WORKSHEET | |
| MENU_ORDER | int | ✓ | xls.handlers.MENU_ORDER | |
| EDIT_PARAMETERS | bit | ✓ | xls.handlers.EDIT_PARAMETERS |
This table is a copy of the xls.handlers table of the SaveToDB Framework to avoid external dependency.
See Configuring Event Handlers.
doc.help
This user table contains database help.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | int | Identity | |
| SECTION_ID | tinyint | doc.help_sections.ID
Help section: 1 - Objects 2 - Schemas 3 - Roles 4 - Diagrams 5 - Pages 6 - Properties | ||
| TABLE_SCHEMA | nvarchar(20) | Object schema or special keywords: Roles, Schemas | ||
| TABLE_NAME | nvarchar(128) | Object name | ||
| COLUMN_NAME | nvarchar(255) | ✓ | Column or parameter name.
The field must contain NULL for help rows of database objects. | |
| LANGUAGE_NAME | char(2) | Two characters of the description language code like 'en' or 'fr'. | ||
| VERSION | nvarchar(50) | ✓ | Database object version for informational purposes.
The field is not used for columns and parameters. | |
| DESCRIPTION | nvarchar(1024) | ✓ | Database object, column or parameter description. | |
| COMMENT | nvarchar(max) | ✓ | Database object complete description.
The field is not used for columns and parameters. |
The table contains help topics for different areas like objects, schemas, roles, etc.
These areas have different SECTION_ID values.
The application includes several views from different areas.
These views have specific edit procedures configured in the doc.objects table.
The table has a unique index that includes fields: SECTION_ID, TABLE_SCHEMA, TABLE_NAME, COLUMN_NAME, and LANGUAGE_NAME.
doc.help_sections
This application table contains help sections.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | tinyint | Application-defined values (see below).
Do not change the values. | |
| SECTION | nvarchar(50) | Section of the doc.help table. |
Values:
| ID | SECTION |
|---|---|
| 1 | Objects |
| 2 | Schemas |
| 3 | Roles |
| 4 | Diagrams |
| 5 | Pages |
| 6 | Properties |
The application assigns and uses the sections programmatically.
doc.history
This user table contains database change history.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | int | Identity | |
| TABLE_SCHEMA | nvarchar(20) | Related database schema | ||
| LANGUAGE_NAME | char(2) | Two characters of the description language code like 'en' or 'fr'. | ||
| VERSION | nvarchar(50) | Version of changes | ||
| SECTION_ID | tinyint | doc.history_sections.ID
Section of changes: 1 - Version Title 2 - Announcements 3 - New Features 4 - Improvements 5 - Bug Fixes | ||
| SORT_ORDER | tinyint | ✓ | Sort order of the topic inside the section | |
| DESCRIPTION | nvarchar(1024) | ✓ | Header line | |
| COMMENT | nvarchar(max) | ✓ | Change description |
Use the doc.view_history view to edit data.
doc.history_sections
This application table contains database change history sections.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | tinyint | Application defined values:
1 - Version title 2 - Announcements formatted as paragraphs Other sections formatted as lists | |
| SECTION | nvarchar(50) | Name of the section of changes.
Use the doc.translations table to translate names. |
Values:
| ID | SECTION |
|---|---|
| 1 | Version Title |
| 2 | Announcements |
| 3 | New Features |
| 4 | Improvements |
| 5 | Bug Fixes |
Use the doc.translations table to translate section names.
doc.objects
This application table contains the configuration of saving changes.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | int | Identity | |
| TABLE_SCHEMA | nvarchar(20) | xls.objects.TABLE_SCHEMA | ||
| TABLE_NAME | nvarchar(128) | xls.objects.TABLE_NAME | ||
| TABLE_TYPE | nvarchar(128) | xls.objects.TABLE_TYPE | ||
| TABLE_CODE | nvarchar(max) | ✓ | xls.objects.TABLE_CODE | |
| INSERT_OBJECT | nvarchar(max) | ✓ | xls.objects.INSERT_OBJECT | |
| UPDATE_OBJECT | nvarchar(max) | ✓ | xls.objects.UPDATE_OBJECT | |
| DELETE_OBJECT | nvarchar(max) | ✓ | xls.objects.DELETE_OBJECT |
This table is a copy of the xls.objects table of the SaveToDB Framework to avoid external dependency.
doc.translations
This application table contains translations of the database help framework objects.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | int | Identity | |
| TABLE_SCHEMA | nvarchar(20) | ✓ | xls.translations.TABLE_SCHEMA | |
| TABLE_NAME | nvarchar(128) | ✓ | xls.translations.TABLE_NAME | |
| COLUMN_NAME | nvarchar(128) | ✓ | xls.translations.COLUMN_NAME | |
| LANGUAGE_NAME | char(2) | ✓ | xls.translations.LANGUAGE_NAME | |
| TRANSLATED_NAME | nvarchar(128) | ✓ | xls.translations.TRANSLATED_NAME | |
| TRANSLATED_DESC | nvarchar(1024) | ✓ | xls.translations.TRANSLATED_DESC | |
| TRANSLATED_COMMENT | nvarchar(2000) | ✓ | xls.translations.TRANSLATED_COMMENT |
This table is a copy of the xls.translations table of the SaveToDB Framework to avoid external dependency.
You may edit the translation and add new translations for the required languages.
You may use the doc.usp_translations procedure to edit translation for multiple languages in a pivot table.
See Configuring Data Translation.
doc.workbooks
This application table contains workbook configuration for SaveToDB Application Workbooks wizard.
| Column | DataType | Null | Comment | |
|---|---|---|---|---|
| ✓ | ID | int | Identity | |
| NAME | nvarchar(128) | Workbook name | ||
| TEMPLATE | nvarchar(255) | ✓ | Template workbook path or URL.
The template workbook is not necessary. The add-in can create a workbook using the definition only. However, you may supply the workbook to have special features. You may use Wizards, Developer Wizard, Prepare Workbook for Distribution to remove sensitive data and passwords from the workbook. | |
| DEFINITION | nvarchar(max) | Workbook definition.
Use the Help, Workbook Information, Workbook Definition menu item to get the definition of any opened workbook. |
The SaveToDB add-in allows generating workbooks using the Application Workbooks wizard.
The add-in loads the workbook configuration from this table.
This is an application table.
If you need to generate other application workbooks, use the xls.workbooks table.
See also Configuring Application Workbooks.