PowerShell Scripting to Replicate Salesforce Data Cloud Data to MySQL

The CData Cmdlets for Salesforce Data Cloud offer live access to Salesforce Data Cloud data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Salesforce Data Cloud and the CData Cmdlets for MySQL in PowerShell to replicate Salesforce Data Cloud data to a MySQL database.

After obtaining the needed connection properties, accessing Salesforce Data Cloud data in PowerShell and preparing for replication consists of four basic steps.

Salesforce Data Cloud supports authentication via the OAuth standard.

OAuth

Set 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:

• : GETANDREFRESH. You can use to avoid repeating the OAuth exchange and manually setting the .
• (custom applications only): The Client ID assigned when you registered your custom OAuth application.
• (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 so that they persist across connections.

For other OAuth methods, including Web Applications and Headless Machines, refer to the Help documentation.

Collecting Salesforce Data Cloud Data

1. Install the module:

   Install-Module SalesforceDataCloudCmdlets

2. Connect to Salesforce Data Cloud:

    $salesforcedatacloud = Connect-SalesforceDataCloud -InitiateOAuth $InitiateOAuth
    

3. Retrieve the data from a specific resource:

    $data = Select-SalesforceDataCloud -Connection $salesforcedatacloud -Table "Account"
    

   You can also use the Invoke-SalesforceDataCloud cmdlet to execute pure SQL-92 statements:

    $data = Invoke-SalesforceDataCloud -Connection $salesforcedatacloud -Query 'SELECT * FROM Account WHERE EmployeeCount = @EmployeeCount' -Params @{'@EmployeeCount'='250'}
    

4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
    

Inserting Salesforce Data Cloud Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

1. Install the module:

   Install-Module MySQLCmdlets

2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
    

3. Loop through the Salesforce Data Cloud data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Salesforce Data Cloud resource (Account) and to exist in the database.

    $data | % {
    $row = $_
    $values = @()
    $columns | % {
    $col = $_
    $values += $row.$($col)
    }
    Add-MySQL -Connection $mysql -Table "Account" -Columns $columns -Values $values
    }
    

You have now replicated your Salesforce Data Cloud data to a MySQL database. This gives you freedom to work with Salesforce Data Cloud data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

• Once you have connected to Salesforce Data Cloud and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

   Select-SalesforceDataCloud -Connection $salesforcedatacloud -Table "Account" | % {
   $row = $_
   $values = @()
   $columns | % {
   $col = $_
   $values += $row.$($col)
   }
   Add-MySQL -Connection $mysql -Table "Account" -Columns $columns -Values $values
   }
   

• If you wish to replicate the Salesforce Data Cloud data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-SalesforceDataCloud cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

   $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}