Access Live IBM Cloud Object Storage Data in Coginiti Pro

Coginiti Pro is a single tool for all your SQL data and analytics needs, designed specifically for data engineers, analysts, and data scientists. When paired with the CData JDBC Driver for IBM Cloud Object Storage, Coginiti Pro can access and query live IBM Cloud Object Storage data. This article describes how to connect to and query IBM Cloud Object Storage data from Coginiti Pro.

With built-in optimized data processing, the CData JDBC Driver for IBM Cloud Object Storage offers unmatched performance for interacting with live IBM Cloud Object Storage data. When you issue complex SQL queries to IBM Cloud Object Storage, the driver pushes supported SQL operations, like filters and aggregations, directly to IBM Cloud Object Storage and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze IBM Cloud Object Storage data using native data types.

Gather Connection Properties and Build a Connection String

Download the CData JDBC Driver for IBM Cloud Object Storage installer, unzip the package, and run the JAR file to install the driver. Then gather the required connection properties.

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.

NOTE: To use the JDBC driver in Coginiti Pro, you may need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

For assistance constructing the JDBC URL, use the connection string designer built into the IBM Cloud Object Storage JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.ibmcloudobjectstorage.jar

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Fill in the connection properties (including the RTK) and copy the connection string to the clipboard.

Create a JDBC Data Source for IBM Cloud Object Storage Data

1. Open Coginiti Pro and in the File menu, select "Edit Drivers."
2. In the newly opened wizard, click "Add" and select "Generic." 👁 Adding a Generic JDBC Driver.
   

3. In the "JDBC Drivers" wizard, set the driver properties (below) and click "Create Driver."

   • Set JDBC Driver Name to a useful name, like CData JDBC Driver for IBM Cloud Object Storage.
   • Click "Add Files" to add the JAR file from the "lib" folder in the installation directory (e.g. cdata.jdbc.ibmcloudobjectstorage.jar)
   • Select the Class Name: cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver.
   👁 Creating a new Generic data source (Salesforce is shown).
   

Create a Connection using the CData JDBC Driver for IBM Cloud Object Storage

1. In the File menu, click "Edit Connections."
2. In the newly opened wizard, click "Add" and select "Generic." 👁 Adding a Generic JDBC Connection.
   
3. In the "Connections" wizard, set the connection properties.
   • Set Connection name to an identifying name.
   • Set Database JDBC driver to the Driver you configured earlier.
   • Set JDBC URL to the JDBC URL configured using the built-in connection string designer (e.g. jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
   👁 Creating a connection (Salesforce is shown).
   
4. Click "Test" to ensure the connection is configured properly. Click "Save."

Query IBM Cloud Object Storage Using SQL

1. Open the Connections tab by clicking on database icon: .
2. Click the plus sign () to add a new query tab.

3. Once the query console is open, write the SQL script you wish to execute and click "Run at Cursor".

   NOTE: You can use the explorer on the left to determine table/view names and column names.

   Using the explorer

   1. In the "Select connection" field, select the connection you wish to query.
   2. Expand your newly created connection, expand the "CData" catalog, and expand the IBM Cloud Object Storage catalog.
   3. Expand "Tables" or "Views" to find the entity you wish to query.
   4. Expand your selected entity to explore the fields (columns).
   👁 Querying data (Salesforce is shown).
   

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for IBM Cloud Object Storage and start working with your live IBM Cloud Object Storage data in Coginiti Pro. Reach out to our Support Team if you have any questions.