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 →Analyze IBM Cloud Object Storage Data in R
Create data visualizations and use high-performance statistical functions to analyze IBM Cloud Object Storage data in Microsoft R Open.
Access IBM Cloud Object Storage data with pure R script and standard SQL. You can use the CData ODBC Driver for IBM Cloud Object Storage and the RODBC package to work with remote IBM Cloud Object Storage data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to IBM Cloud Object Storage data and visualize IBM Cloud Object Storage data in R.
Install R
You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).
Connect to IBM Cloud Object Storage as an ODBC Data Source
Information for connecting to IBM Cloud Object Storage follows, along with different instructions for configuring a DSN in Windows and Linux environments.
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.
When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
Windows
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.
Linux
If you are installing the CData ODBC Driver for IBM Cloud Object Storage in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.
/etc/odbc.ini
[CData IBMCloudObjectStorage Source]
Driver = CData ODBC Driver for IBM Cloud Object Storage
Description = My Description
ApiKey = myApiKey
CloudObjectStorageCRN = MyInstanceCRN
Region = myRegion
OAuthClientId = MyOAuthClientId
OAuthClientSecret = myOAuthClientSecret
For specific information on using these configuration files, please refer to the help documentation (installed and found online).
Load the RODBC Package
To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.
After installing the RODBC package, the following line loads the package:
library(RODBC)
Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.
library(checkpoint)
checkpoint("2016-01-01")
Connect to IBM Cloud Object Storage Data as an ODBC Data Source
You can connect to a DSN in R with the following line:
conn <- odbcConnect("CData IBMCloudObjectStorage Source")
Schema Discovery
The driver models IBM Cloud Object Storage APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:
sqlTables(conn)
Execute SQL Queries
Use the sqlQuery function to execute any SQL query supported by the IBM Cloud Object Storage API.
objects <- sqlQuery(conn, "SELECT Key, Etag FROM Objects WHERE Bucket = 'someBucket'", believeNRows=FALSE, rows_at_time=1)
You can view the results in a data viewer window with the following command:
View(objects)
Plot IBM Cloud Object Storage Data
You can now analyze IBM Cloud Object Storage data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:
par(las=2,ps=10,mar=c(5,15,4,2))
barplot(objects$Etag, main="IBM Cloud Object Storage Objects", names.arg = objects$Key, horiz=TRUE)
