Connect to Salesforce Data Cloud Data as a Linked Server



Use the SQL Gateway and the ODBC Driver to set up a linked server for Salesforce Data Cloud data.

You can use the SQL Gateway to configure a TDS (SQL Server) remoting service and set up a linked server for Salesforce Data Cloud data. After you have started the service, you can use the UI in SQL Server Management Studio or call stored procedures to create the linked server. You can then work with Salesforce Data Cloud data just as you would a linked SQL Server instance.

Connect to Salesforce Data Cloud as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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 TDS Remoting Service

    See the SQL Gateway Overview for a guide to configure a TDS remoting service in the SQL Gateway UI. The TDS remoting service is a daemon process that listens for TDS requests from clients.

    Create a Linked Server for Salesforce Data Cloud Data

    After you have configured and started the daemon, create the linked server and connect. You can use the UI in SQL Server Management Studio or call stored procedures.

    Create a Linked Server from the UI

    Follow the steps below to create a linked server from the Object Explorer.

    1. Open SQL Server Management Studio and connect to an instance of SQL Server.
    2. In the Object Explorer, expand the node for the SQL Server database. In the Server Objects node, right-click Linked Servers and click New Linked Server. The New Linked Server dialog is displayed.
    3. In the General section, click the Other Data Source option and enter the following information after naming the linked server:
      • Provider: Select "Microsoft ODBC Driver for SQL Server" or "Microsoft OLE DB Driver for SQL Server"
      • Data Source: Enter the host and port the TDS remoting service is running on, separated by a comma.

        Note that a value of "localhost" in this input refers to the machine where SQL Server is running so be careful when creating a linked server in Management Studio when not running on the same machine as SQL Server.

      • Catalog: Enter the CData system DSN, CData SalesforceDataCloud Sys.
    4. In the Security section, select the option to have the connection "made using this security context" and enter the username and password of a user you created in the Users tab of the SQL Gateway.

    Create a Linked Server Programmatically

    In addition to using the SQL Server Management Studio UI to create a linked server, you can use stored procedures. The following inputs are required:

    • server: The linked server name.
    • provider: Enter "MSOLEDBSQL", for the Microsoft OLE DB Driver for SQL Server.
    • datasrc: The host and port the service is running on, separated by a comma.

      Note that a value of "localhost" in the datasrc input refers to the machine where SQL Server is running, so be careful when creating a linked server in Management Studio when not running on the same machine as SQL Server.

    • catalog: Enter the system DSN configured for the service.
    • srvproduct: Enter the product name of the data source; this can be an arbitrary value, such as "CData SQL Gateway" or an empty string.
    Follow the steps below to create the linked server and configure authentication to the SQL Gateway:
    1. Call sp_addlinkedserver to create the linked server:

      EXEC sp_addlinkedserver @server='SalesforceDataCloud', @provider='MSOLEDBSQL', @datasrc='< MachineIPAddress >,1434', @catalog='CData SalesforceDataCloud Sys', @srvproduct=''; GO
    2. Call the sp_addlinkedsrvlogin stored procedure to allow SQL Server users to connect with the credentials of an authorized user of the service. Note that the credentials you use to connect to the service must specify a user you configured on the Users tab of the SQL Gateway.

      EXEC sp_addlinkedsrvlogin @rmtsrvname='SalesforceDataCloud', @rmtuser='admin', @rmtpassword='test', @useself='FALSE', @locallogin=NULL; GO

    Connect from SQL Server Management Studio

    SQL Server Management Studio uses the SQL Server Client OLE DB provider, which requires the ODBC driver to be used inprocess. You must enable the "Allow inprocess" option for the SQL Server Native Client Provider in Management Studio to query the linked server from SQL Server Management Studio. To do this, open the properties for the provider you are using under Server Objects -> Linked Servers -> Providers. Check the "Allow inprocess" option and save the changes.

    Execute Queries

    You can now execute queries to the Salesforce Data Cloud linked server from any tool that can connect to SQL Server. Set the table name accordingly:

    SELECT * FROM [linked server name].[CData SalesforceDataCloud Sys].[SalesforceDataCloud].[Account]

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.