We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Replicate IBM Cloud Object Storage Data from PowerShell
Write a quick PowerShell script to query IBM Cloud Object Storage data. Use connectivity to the live data to replicate IBM Cloud Object Storage data to SQL Server.
The CData ODBC Driver for IBM Cloud Object Storage enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real IBM Cloud Object Storage data with PowerShell.
You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating IBM Cloud Object Storage data to other databases. This article shows how to replicate IBM Cloud Object Storage data to SQL Server in 5 lines of code.
You can also write PowerShell code to download IBM Cloud Object Storage data. See the examples below.
Create an ODBC Data Source for IBM Cloud Object Storage
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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:
- Log in to your IBM Cloud account.
- Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.
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:
- Log in to your IBM Cloud account.
- Navigate to the Platform API Keys page.
- On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
- 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, you will need to 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.
- Extracts the access token and authenticates requests.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Connect to IBM Cloud Object Storage
The code below shows how to use the DSN to initialize the connection to IBM Cloud Object Storage data in PowerShell:
$conn = New-Object System.Data.Odbc.OdbcConnection
$conn.ConnectionString = "DSN=CData IBMCloudObjectStorage Source x64"
Back Up IBM Cloud Object Storage Data to SQL Server
After you enable caching, you can use the code below to replicate data to SQL Server.
Set the following connection properties to configure the caching database:
CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.
CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:
Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;
The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.
$conn.Open()
# Create and execute the SQL Query
$SQL = "CACHE DROP EXISTING SELECT * FROM " + $Objects
$cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn)
$count = $cmd.ExecuteNonQuery()
$conn.Close()
The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.
Other Operations
To retrieve IBM Cloud Object Storage data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples commands to IBM Cloud Object Storage through the .NET Framework Provider for ODBC:
Retrieve IBM Cloud Object Storage Data
$sql="SELECT Key, Etag from Objects"
$da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn)
$dt= New-Object System.Data.DataTable
$da.Fill($dt)
$dt.Rows | foreach {
$dt.Columns | foreach ($col in dt{
Write-Host $1[$_]
}
}