Comprehensive Guide to SaveToDB Framework

The SaveToDB Framework consists of tables, views, and stored procedures that configure the SaveToDB, DBEdit, DBGate, and ODataDB products.

You can easily install, update, and remove the SaveToDB Framework.

SaveToDB Frameworks 8 and 9 include the following tables and views:

SaveToDB Framework 10 adds these tables and views:

Additionally, SaveToDB Framework 10 includes pair views for each configuration table, such as xls.view_objects for xls.objects. These views select configuration data from the underlying tables for objects in schemas where the user has permissions.

Note: You can create SaveToDB Framework objects in your schemas without installing the entire framework. Simply copy an object declaration and adjust the schema to your own.

All products identify framework objects by field and parameter signatures, not by object names.

Below are the table structures:

xls.objects
ID
TABLE_SCHEMA
TABLE_NAME
TABLE_TYPE
TABLE_CODE
INSERT_OBJECT
UPDATE_OBJECT
DELETE_OBJECT

xls.handlers
ID
TABLE_SCHEMA
TABLE_NAME
COLUMN_NAME
EVENT_NAME
HANDLER_SCHEMA
HANDLER_NAME
HANDLER_TYPE
HANDLER_CODE
TARGET_WORKSHEET
MENU_ORDER
EDIT_PARAMETERS

xls.columns
ID
TABLE_SCHEMA
TABLE_NAME
COLUMN_NAME
ORDINAL_POSITION
IS_PRIMARY_KEY
IS_NULLABLE
IS_IDENTITY
IS_COMPUTED
COLUMN_DEFAULT
DATA_TYPE
CHARACTER_MAXIMUM_LENGTH
PRECISION
SCALE

xls.translations
ID
TABLE_SCHEMA
TABLE_NAME
COLUMN_NAME
LANGUAGE_NAME
TRANSLATED_NAME
TRANSLATED_DESC
TRANSLATED_COMMENT

xls.formats
ID
TABLE_SCHEMA
TABLE_NAME
TABLE_EXCEL_FORMAT_XML
APP

xls.workbooks
ID
NAME
TEMPLATE
DEFINITION
TABLE_SCHEMA

SaveToDB Frameworks are available on all supported database platforms.

Here’s a diagram of the available objects:

	MS SQL	SQL DW	MySQL	PgSQL	Oracle	Snowflake	SQLite
Schemas
xls	✓	✓	✓	✓	✓	✓	x
Roles
xls_developers	✓	✓	x	✓	✓	✓	x
xls_users	✓	✓	x	✓	✓	✓	x
xls_formats	✓	✓	x	✓	✓	✓	x
Tables
xls.columns	✓	✓	✓	✓	✓	✓	✓
xls.formats	✓	✓	✓	✓	✓	✓	✓
xls.handlers	✓	✓	✓	✓	✓	✓	✓
xls.objects	✓	✓	✓	✓	✓	✓	✓
xls.translations	✓	✓	✓	✓	✓	✓	✓
xls.workbooks	✓	✓	✓	✓	✓	✓	✓
Views
xls.queries	✓	✓	✓	✓	✓	✓	✓
xls.users	✓	✓	✓	✓	✓	x	x
Platform-Specific Procedures
xls.xl_actions_add_to_xls_users			✓
xls.xl_actions_add_to_xls_formats			✓
xls.xl_actions_add_to_xls_developers			✓
xls.xl_actions_remove_from_xls_users			✓
xls.xl_actions_remove_from_xls_formats			✓
xls.xl_actions_remove_from_xls_developers			✓
xls.xl_actions_set_role_permissions	✓	✓		✓
SaveToDB Framework Extension (a separate installation package)
Views
xls.view_columns	✓	✓	✓	✓	✓
xls.view_formats	✓	✓	✓	✓	✓
xls.view_handlers	✓	✓	✓	✓	✓
xls.view_objects	✓	✓	✓	✓	✓
xls.view_queries	✓	✓	✓	✓	✓
xls.view_translations	✓	✓	✓	✓	✓
xls.view_workbooks	✓	✓	✓	✓	✓
Platform-Specific Procedures
xls.xl_actions_set_extended_role_permissions	✓	✓		✓
xls.xl_actions_revoke_extended_role_permissions	✓	✓		✓

Note: In version 10.4, xl_actions_set_framework_10_mode has been renamed to xl_actions_set_extended_role_permissions, and xl_actions_set_framework_9_mode has been renamed to xl_actions_revoke_extended_role_permissions.

For detailed descriptions of framework objects, see:

Also, check out these additional topics: