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 →Connect to IBM Cloud Object Storage Data in Aqua Data Studio
Access IBM Cloud Object Storage data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.
The CData JDBC Driver for IBM Cloud Object Storage integrates IBM Cloud Object Storage data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to IBM Cloud Object Storage data through the connection manager and execute queries.
Create a JDBC Data Source
You can use the connection manager to define connection properties and save them in a new JDBC data source. The IBM Cloud Object Storage data source can then be accessed from Aqua Data Studio tools.
- In Aqua Data Studio, select Register Server from the Servers menu.
- In the Register Server form, select the 'Generic - JDBC' connection.
- Enter the following JDBC connection properties:
- Name: Enter a name for the data source; for example, IBM Cloud Object Storage.
- Driver Location: Click the Browse button and select the cdata.jdbc.ibmcloudobjectstorage.jar file, located in the lib subfolder of the installation directory.
- Driver: Enter the Driver's class name, cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver.
URL: Enter the JDBC URL, which starts with jdbc:ibmcloudobjectstorage: and is followed by a semicolon-separated list of 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:
- 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.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the IBM Cloud Object Storage JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.ibmcloudobjectstorage.jar
Fill in the connection properties and copy the connection string to the clipboard.
A typical JDBC URL is below:
jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
Query IBM Cloud Object Storage Data
You can now query the tables exposed.
