Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to IBM Cloud Object Storage Data in NetBeans
Connect to IBM Cloud Object Storage data in NetBeans with the data source configuration wizard.
The CData JDBC Driver for IBM Cloud Object Storage integrates connectivity to live IBM Cloud Object Storage data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to IBM Cloud Object Storage data in NetBeans. You will create a connection and load IBM Cloud Object Storage data in the Table Editor.
Create a JDBC Data Source for IBM Cloud Object Storage in NetBeans
To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:
- Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.ibmcloudobjectstorage.jar file. The driver JAR is located in the lib subfolder of the installation directory.
- Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver from the menu.
- Name: Enter the name for the driver.
Define Connection Parameters
Follow the steps below to define required connection properties:
In the Service window, right-click the Database node and click New Connection.
In the New Connection Wizard, enter the following connection properties:
- Driver Name: In the menu, select the CData JDBC Driver for IBM Cloud Object Storage.
- User Name: Enter the username. This can also be defined in the JDBC URL.
- Password: Enter the password. This can also be defined in the JDBC URL.
JDBC URL: Specify the JDBC URL.
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 the following:
jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
Query IBM Cloud Object Storage Data
To connect to IBM Cloud Object Storage data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.
To load a table in the Data Views window, right-click the table and then click View Data..