Cmdlets for Salesforce

Build 24.0.9060

Getting Started

Connecting to Salesforce

Establishing a Connection shows how to authenticate to Salesforce and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for Salesforce provides a familiar way to interact with Salesforce from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with Salesforce using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-Salesforce cmdlet. You can then pass the SalesforceConnection object returned to other cmdlets for accessing data:

  • Select-Salesforce
  • Add-Salesforce
  • Update-Salesforce
  • Remove-Salesforce

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-Salesforce cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

Salesforce Version Support

The cmdlet requires the Web Services API. The Web Services API is supported natively by Salesforce Enterprise, Unlimited, and Developer editions. The Web Services API may be enabled on Professional Edition at an additional cost by contacting Salesforce. The cmdlet defaults to version 61.0 of the Salesforce API. Later or earlier versions can be specified in the APIVersion property.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060