How to create Salesforce Data Cloud federated tables in MySQL



Use the SQL Gateway and the ODBC Driver to set up federated tables for Salesforce Data Cloud data in MySQL .

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

Connect to Salesforce Data Cloud 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.

Salesforce Data Cloud supports authentication via the OAuth standard.

OAuth

Set AuthScheme to OAuth.

Desktop Applications

CData provides an embedded OAuth application that simplifies authentication at the desktop.

You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Salesforce Data Cloud console. For further information, see Creating a Custom OAuth App in the Help documentation.

Before you connect, set these properties:

  • InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthClientId (custom applications only): The Client ID assigned when you registered your custom OAuth application.
  • OAuthClientSecret (custom applications only): The Client Secret assigned when you registered your custom OAuth application.

When you connect, the driver opens Salesforce Data Cloud's OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

  • Extracts the access token from the callback URL.
  • Obtains a new access token when the old one expires.
  • Saves OAuth values in OAuthSettingsLocation so that they persist across connections.
  • For other OAuth methods, including Web Applications and Headless Machines, refer to the Help documentation.

    Configure the SQL Gateway

    See the SQL Gateway Overview to set up connectivity to Salesforce Data Cloud 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.

    Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

    Create a FEDERATED Server and Tables for Salesforce Data Cloud 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 Salesforce Data Cloud. 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 fedSalesforceDataCloud
    FOREIGN DATA WRAPPER mysql
    OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData SalesforceDataCloud 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 (Account). Refer to the following template for the statement to create a FEDERATED table:

    CREATE TABLE fed_account (
      ...,
      [account id]  TYPE(LEN),
      [account name]  TYPE(LEN),
      ...,
    )
    ENGINE=FEDERATED
    DEFAULT CHARSET=latin1
    CONNECTION='fedSalesforceDataCloud/account';
    

    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 Salesforce Data Cloud 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 Salesforce Data Cloud. Refer to the following example:

    SELECT 
      fed_account.[account id], 
      local_table.custom_field 
    FROM 
      local_table 
    JOIN 
      fed_account 
    ON 
      local_table.foreign_[account id] = fed_account.[account id];
    

Ready to get started?

Download a free trial of the Salesforce Data Cloud ODBC Driver to get started:

 Download Now

Learn more:

Salesforce Data Cloud Icon Salesforce Data Cloud ODBC Driver

The Salesforce Data Cloud ODBC Driver is a powerful tool that allows you to connect with live data from Salesforce Data Cloud, directly from any applications that support ODBC connectivity.

Access Salesforce Data Cloud data like you would a database - read, write, and update Salesforce Data Cloud 0, etc. through a standard ODBC Driver interface.