PowerShell Scripting to Replicate Salesforce Data to MySQL

The CData Cmdlets for Salesforce offer live access to Salesforce 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 and the CData Cmdlets for MySQL in PowerShell to replicate Salesforce data to a MySQL database.

Getting Started

---

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

There are several authentication methods available for connecting to Salesforce: OAuth, Login (or basic), and SSO. The Login method requires you to have the username, password, and security token of the user.

OAuth Authentication (default)

The default authentication mechanism (and the one preferred by Salesforce) is OAuth. To use OAuth with CData's embedded OAuth application, leave the connection properties blank. If you have configured your own custom OAuth application with Salesforce (see the Help documentation for more information), set OAuthClientId, OAuthClientSecret, and CallbackURL to the properties for you application. Set InitiateOAuth to the desired OAuth flow ("GETANDREFRESH" will have the connector manage the entire OAuth flow).

Login (or Basic) Authentication

If you do not wish do not wish to use OAuth authentication, you can use Login (or basic) authentication. Set AuthScheme to Basic, and set the User, Password, and SecurityToken properties. You can configure your security token in Salesforce.

SSO (single sign-on) Authentication

SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and SSOExchangeURL connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the Help documentation for more information.

Multi-Factor Authentication (MFA)

If your Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies to both OAuth and Login authentication flows.

Collecting Salesforce Data

1. Install the module:

   Install-Module SalesforceCmdlets

2. Connect to Salesforce:

    $salesforce = Connect-Salesforce -InitiateOAuth $InitiateOAuth -MFACode $MFACode
    

3. Retrieve the data from a specific resource:

    $data = Select-Salesforce -Connection $salesforce -Table "Account"
    

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

    $data = Invoke-Salesforce -Connection $salesforce -Query 'SELECT * FROM Account WHERE Name = @Name' -Params @{'@Name'='GenePoint'}
    

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 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, 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 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 to a MySQL database. This gives you freedom to work with Salesforce 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 and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

   Select-Salesforce -Connection $salesforce -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 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-Salesforce 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')}