Cmdlets for IBM Cloud Data Engine

Build 24.0.9060

Getting Started

Connecting to IBM Cloud Data Engine

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

  • Select-IBMCloudSQLQuery
  • Add-IBMCloudSQLQuery
  • Update-IBMCloudSQLQuery
  • Remove-IBMCloudSQLQuery

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-IBMCloudSQLQuery 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.

IBM Cloud Data Engine Version Support

The cmdlet leverages the IBM Cloud Data Engine API to enable bidirectional access to IBM Cloud.

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