Cmdlets for OData

Build 20.0.7587

Getting Started

Connecting to OData

Establishing a Connection shows how to authenticate to OData 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 OData provides a familiar way to interact with OData from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with OData 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-OData cmdlet. You can then pass the ODataConnection object returned to other cmdlets for accessing data:

  • Select-OData
  • Add-OData
  • Update-OData
  • Remove-OData

Executing SQL from PowerShell

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

Data Replication with Cmdlets

You can use the Sync-OData cmdlet to cache data and automatically maintain the cache.

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.

OData Version Support

The cmdlet is a standard OData consumer that can read and write to OData 2.0, 3.0, and 4.0 services. The major authentication schemes are supported, including HTTP Basic, Digest, and NTLM, as well as SSL/TLS. The cmdlet also facilitates connecting to data sources that use the OAuth authentication standard.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587