Pipe IBM Cloud SQL Query Data to CSV in PowerShell

Ready to get started?

Download for a free trial:

Download Now

Learn more:

IBM Cloud SQL Query Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to IBM Cloud SQL Query. The Cmdlets allow users to easily query live data - just like working with SQL server.

Use standard PowerShell cmdlets to access IBM Cloud SQL Query tables.

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

Creating a Connection to Your IBM Cloud SQL Query Data

IBM Cloud SQL uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

$conn = Connect-IBMCloudSQLQuery  -Api Key "$Api Key" -Instance CRN "$Instance CRN" -Region "$Region" -Schema "$Schema" -OAuth Client Id "$OAuth Client Id" -OAuth Client Secret "$OAuth Client Secret"

Selecting Data

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

Select-IBMCloudSQLQuery -Connection $conn -Table Jobs | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myJobsData.csv -NoTypeInformation

You will notice that we piped the results from Select-IBMCloudSQLQuery 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-IBMCloudSQLQuery -Connection $conn -Table Jobs -Where "UserId = user@domain.com" | Remove-IBMCloudSQLQuery

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 IBM Cloud SQL Query, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyJobsUpdates.csv | %{
  $record = Select-IBMCloudSQLQuery -Connection $IBMCloudSQLQuery -Table Jobs -Where ("Id = `'"+$_.Id+"`'")
    Update-IBMCloudSQLQuery -Connection $ibmcloudsqlquery -Table Jobs -Columns ("Id","Status") -Values ($_.Id, $_.Status) -Where ("Id = `'"+$_.Id+"`'")
    Add-IBMCloudSQLQuery -Connection $ibmcloudsqlquery -Table Jobs -Columns ("Id","Status") -Values ($_.Id, $_.Status)

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!