How to pipe Salesforce Data to CSV in PowerShell

The CData Cmdlets Module for Salesforce is a standard PowerShell module offering straightforward integration with Salesforce. Below, you will find examples of using our Salesforce Cmdlets with native PowerShell cmdlets.

Getting Started

---

Creating a Connection to Your Salesforce Data

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.

$conn = Connect-Salesforce -InitiateOAuth "$InitiateOAuth" -MFACode "$MFACode"

Selecting Data

Follow the steps below to retrieve data from the Account table and pipe the result into to a CSV file:

Select-Salesforce -Connection $conn -Table Account | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountData.csv -NoTypeInformation

You will notice that we piped the results from Select-Salesforce into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-Salesforce -Connection $conn -Table Account -Where "Name = GenePoint" | Remove-Salesforce

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Salesforce, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyAccountUpdates.csv | %{
 $record = Select-Salesforce -Connection $Salesforce -Table Account -Where ("Id = `'"+$_.Id+"`'")
 if($record){
 Update-Salesforce -Connection $salesforce -Table Account -Columns ("Industry","AnnualRevenue") -Values ($_.Industry, $_.AnnualRevenue) -Where ("Id = `'"+$_.Id+"`'")
 }else{
 Add-Salesforce -Connection $salesforce -Table Account -Columns ("Industry","AnnualRevenue") -Values ($_.Industry, $_.AnnualRevenue)
 }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!