Ready to get started?

Download a free trial of the IBM Cloud Object Storage ODBC Driver to get started:

 Download Now

Learn more:

IBM Cloud Object Storage Icon IBM Cloud Object Storage ODBC Driver

The IBM Cloud Object Storage ODBC Driver is a powerful tool that allows you to connect with live data from IBM Cloud Object Storage, directly from any applications that support ODBC connectivity.

Access IBM Cloud Object Storage data like you would a database - read, write, and update IBM Cloud Object Storage IBMCloudObject, etc. through a standard ODBC Driver interface.

Build Charts with IBM Cloud Object Storage Data in Clear Analytics



Create dynamic charts and perform analytics based on IBM Cloud Object Storage data in Clear Analytics.

The CData ODBC Driver for IBM Cloud Object Storage enables access to live data from IBM Cloud Object Storage under the ODBC standard, allowing you work with IBM Cloud Object Storage data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to use Clear Analytics, a Microsoft Excel Add-In, to connect to IBM Cloud Object Storage as an ODBC source and create queries, tables, and charts (including PivotTables) based on IBM Cloud Object Storage data.

Connect to IBM Cloud Object Storage Data


Configure the ODBC Data Source Name

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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 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:

  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, 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.

  1. Extracts the access token and authenticates requests.
  2. 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.

Configure the Data Source in Clear Analytics

  1. Open Excel and navigate to the CLEAR ANALYTICS ribbon. Once there, open the Data Manager.
  2. Select Database as the data source.
  3. In the Set Connection section, click the option to create a new database.
  4. Select Microsoft ODBC Data Source as the data source and click OK.
  5. Select the DSN you already configured from the drop-down menu.
  6. Back on the Set Connection section, select Standard (ANSI ODBC) Query Builder as the SQL Builder Provider and click Next.
  7. Select the Schema/Owner and choose the domains (tables) that you wish to use in Clear Analytics.
  8. Prepare your data objects as needed by customizing the display names and descriptions of the tables and columns.
  9. For the vast majority of the CData ODBC Drivers, you will not set a key date for your domains.
  10. In the Domain Relations section, add any relational information between tables.
  11. In the Domain Tree section, create groups for your data and add the available items to the groups.
  12. Review the summary of your data and click Finish.

Create a Chart with IBM Cloud Object Storage Data

You are now ready to create a chart with IBM Cloud Object Storage data.

Create a New Query

  1. Click Repository in the CLEAR ANALYTICS ribbon.
  2. Create a new query.
  3. Select the columns you wish to retrieve.
  4. Set the aggregation type for your data (use the blank entry if you do not wish to aggregate the data).
  5. Set filters and formulas by dragging columns to the lower window.
  6. Name your query and click Save.

Build a Chart Based on a Query Report

With the query created, you are now ready to execute a report and display a chart.
  1. Click Report Explorer in the CLEAR ANALYTICS ribbon.
  2. In the Report Explorer pane, click the 'New Report' icon in the toolbar.
  3. Select the query you just created.
  4. Name the report and click 'Save and Execute'.
  5. Click the Results tab within the Report Explorer
  6. Expand your report and drag the chart to the Excel spreadsheet.
  7. In the resulting PivotChart window, drag the fields (columns) to the Filters, Legends, Axis (Categories), and Values windows.

With a new data source in Clear Analytics established and a chart created, you are ready to begin analysis of IBM Cloud Object Storage data. With the ODBC Driver for IBM Cloud Object Storage and Clear Analytics, you can perform self-service analytics in Excel with live data, directly from IBM Cloud Object Storage.