The CData JDBC Driver for Smartsheet models the Smartsheet data as an easy-to-use SQL database.

Tables

The data model of the driver is dynamic. This means that, when you connect using the driver, any changes you make in the Smartsheet UI, such as adding a new table, adding new columns, or changing a column's data type, are automatically included in the schema of the driver.

However, some tables and views, such as workspaces and folders, are static. These are defined in schema files, which are simple, text-based configuration files. The names of the static tables and views are prefixed with Info_.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including managing Smartsheet objects and attachments, searching data, and retrieving OAuth credentials.

API Restrictions

The driver uses the Smartsheet API to process supported filters. The driver processes other filters client-side within the driver.

Hierarchy Navigation

Hierarchy Navigation refers to recursively exploring the Smartsheet hierarchy (tree) of objects through the API by doing the following for each workspace (unless the RootFolderId pseudocolumn is used).

• Fetching object metadata for objects located in the workspace's root.
• Fetching object metadata for objects located in the folders of the workspace's root.
• Fetching object metadata for objects located in the subfolders of those folders.
• Fetching object metadata for objects for all subfolders, until reaching folders that have no more folder objects.

For the following entities:

• Info_Objects
• Info_Folders
• Info_Templates

the driver navigates the hierarchy, with two exceptions:

• Filtering by FolderId (or ParentFolderId, for Info_Folders) fetches only the direct children of the specified folder(s), without recursing into any subfolders.
• For Info_Folders specifically, filtering by Id retrieves the specified folder(s) directly through the Smartsheet API, without navigating the hierarchy at all.

Navigating the hierarchy is very costly in terms of performance because the driver has to make many API calls.