How to pipe IBM Cloud Object Storage Data to CSV in PowerShell

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

Creating a Connection to Your IBM Cloud Object Storage Data

Register a New Instance of Cloud Object Storage

If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

1. Log in to your IBM Cloud account.
2. Navigate to the

Connecting using OAuth Authentication

There are certain connection properties you need to set before you can connect. You can obtain these as follows:

API Key

To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

1. Log in to your IBM Cloud account.
2. Navigate to the Platform API Keys page.
3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

Cloud Object Storage CRN

If you have multiple accounts, specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

• Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
• Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

Connecting to Data

You can now set the following to connect to data:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• ApiKey: Set this to your API key which was noted during setup.
• CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

When you connect, the connector completes the OAuth process.

1. Extracts the access token and authenticates requests.
2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

$conn = Connect-IBMCloudObjectStorage -ApiKey "$ApiKey" -CloudObjectStorageCRN "$CloudObjectStorageCRN" -Region "$Region" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret"

Selecting Data

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

Select-IBMCloudObjectStorage -Connection $conn -Table Objects | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myObjectsData.csv -NoTypeInformation

You will notice that we piped the results from Select-IBMCloudObjectStorage 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.