Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Validate IBM Cloud Object Storage Data with QuerySurge
Access and validate IBM Cloud Object Storage data in QuerySurge using the CData JDBC Driver.
QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for IBM Cloud Object Storage, QuerySurge can work with live IBM Cloud Object Storage data. This article walks through connecting to IBM Cloud Object Storage data from QuerySurge.
With built-in optimized data processing, the CData JDBC Driver 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). Its built-in dynamic metadata querying allows you to work with and analyze IBM Cloud Object Storage data using native data types.
Connecting to IBM Cloud Object Storage Data in QuerySurge
To connect to live IBM Cloud Object Storage data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.
Deploy the JDBC Driver
- Download the CData JDBC Driver for IBM Cloud Object Storage installer, unzip the package, and run the JAR file to install the driver.
- Once the driver is installed, stop the Agent Service.
- Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for IBM Cloud Object Storage\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
- Restart the Agent Service.
For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.
Configure a New Connection to IBM Cloud Object Storage
- Log into QuerySurge and navigate to the Admin view.
- Click Configuration -> Connections in the Administration Tree.
- Click Add to create a new connection.
- In the QuerySurge Connection Wizard, click Next.
- Name the connection (e.g. CData JDBC Connection to IBM Cloud Object Storage).
- Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
- Set the Driver Class to cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver and click Next.
Set the Connection URL using the necessary connection properties to authenticate with IBM Cloud Object Storage. Your Connection URL will look something like the following:
jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
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.
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.
- Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Objects LIMIT 1) and click Next.
- Click Test Connection to ensure the connection is configured properly and click Save to add the connection.
Once the connection is added, you can write SQL queries against your IBM Cloud Object Storage data in QuerySurge.
Compare IBM Cloud Object Storage Data Queries with a QueryPair
With the connection configured, you can follow the steps below to compare querying IBM Cloud Object Storage data with a QueryPair.
- Select "Design Library" from the Design Menu
- Click QueryPairs under QuerySurge Design
- Click "Create New QueryPair"
- Name the QueryPair and click Save
- In either the Source or Target panes, select the connection created above (select the same connection to query IBM Cloud Object Storage twice or another connection to perform a comparison)
- Write queries in the Editor for each pane, e.g. SELECT * FROM Objects
- Click the "Design-Time Run" tab to execute the queries
- When the query execution is finished, click "View Query Results" to see the IBM Cloud Object Storage data returned by the query
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 QuerySurge. Reach out to our Support Team if you have any questions.