How to create Webflow federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Webflow data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Webflow: 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 Webflow data just as you would local MySQL tables.

Connect to Webflow 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.

Authentication

Webflow uses OAuth 2.0 authentication to ensure secure access to sites, CMS collections, e-commerce data, and other resources. This authentication method allows you to securely connect to your Webflow workspace and manage resources with proper authorization.

OAuth 2.0 Setup and Configuration

Step 1: Create a Webflow OAuth Application

To set up OAuth authentication:

1. Visit the Webflow Developer Portal
2. Navigate to "Apps & Integrations" in your Webflow account
3. Click "Register an App" to create a new OAuth application
4. Configure the application name, description, and redirect URI (CallbackURL)
5. Copy the Client ID and Client Secret for use in your connection

Required Connection Properties

• AuthScheme: Set this to OAuth (required)
• OAuthClientId: Client ID from your Webflow OAuth application (required)
• OAuthClientSecret: Client secret from your Webflow OAuth application (required)
• CallbackURL: Redirect URI specified in your OAuth application (required)
• InitiateOAuth: Set to GETANDREFRESH for automatic token management (recommended)

Required OAuth Scopes

The Webflow API Profile requires the following OAuth scopes:

• sites:read - Read access to site information and configuration
• pages:read - Read access to site pages
• cms:read - Read access to CMS collections and items
• forms:read - Read access to forms and form submissions
• assets:read - Read access to media assets and folders
• ecommerce:read - Read access to products, orders, and inventory
• authorized_user:read - Read access to the authorized user

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Webflow 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 Webflow 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 Webflow. 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 fedAPI
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData API 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 (Sites). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_sites (
  ...,
    TYPE(LEN),
    TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedAPI/sites';

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 Webflow 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 Webflow. Refer to the following example:

SELECT 
  fed_sites., 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_sites 
ON 
  local_table.foreign_ = fed_sites.;