We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →How to create Smartsheet federated tables in MySQL
Use the SQL Gateway and the ODBC Driver to set up federated tables for Smartsheet data in MySQL .
You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Smartsheet data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Smartsheet: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Smartsheet data just as you would local MySQL tables.
About Smartsheet Data Integration
CData provides the easiest way to access and integrate live data from Smartsheet. Customers use CData connectivity to:
- Read and write attachments, columns, comments and discussions.
- View the data in individuals cells, report on cell history, and more.
- Perform Smartsheet-specific actions like deleting or downloading attachments, creating, copying, deleting, or moving sheets, and moving or copying rows to another sheet.
Users frequently integrate Smartsheet with analytics tools such as Tableau, Crystal Reports, and Excel. Others leverage our tools to replicate Smartsheet data to databases or data warehouses.
Getting Started
Connect to Smartsheet Data
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.
Configure the SQL Gateway
See the SQL Gateway Overview to set up connectivity to Smartsheet data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.
Create a FEDERATED Server and Tables for Smartsheet Data
After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:
Create a FEDERATED Server
The following statement will create a FEDERATED server based on the ODBC Driver for Smartsheet. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.
CREATE SERVER fedSmartsheet FOREIGN DATA WRAPPER mysql OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData Smartsheet Sys');
Create a FEDERATED Table
To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Sheet_Event_Plan_Budget). Refer to the following template for the statement to create a FEDERATED table:
CREATE TABLE fed_sheet_event_plan_budget ( ..., taskname TYPE(LEN), progress TYPE(LEN), ..., ) ENGINE=FEDERATED DEFAULT CHARSET=latin1 CONNECTION='fedSmartsheet/sheet_event_plan_budget';
NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.
Execute Queries
You can now execute queries to the Smartsheet FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Smartsheet. Refer to the following example:
SELECT fed_sheet_event_plan_budget.taskname, local_table.custom_field FROM local_table JOIN fed_sheet_event_plan_budget ON local_table.foreign_taskname = fed_sheet_event_plan_budget.taskname;