Enable the CData JDBC Driver for IBM Cloud Object Storage in KNIME

Use standard data access components in KNIME to create charts and reports with IBM Cloud Object Storage data.

One of the strengths of the CData JDBC Driver for IBM Cloud Object Storage is its cross-platform support, enabling integration with major BI tools. Follow the procedure below to access IBM Cloud Object Storage data in KNIME and to create a chart from IBM Cloud Object Storage data using the report designer.

Define a New JDBC Connection to IBM Cloud Object Storage Data

  1. If you have not already done so, install the Report Designer extension: Click File -> Install KNIME Extensions, and filter on "Report".
  2. In a new workflow, click File -> Preferences and expand the KNIME -> Database Driver nodes to add cdata.jdbc.ibmcloudobjectstorage.jar. The driver JAR is located in the lib subfolder of the installation directory.
  3. In the Node Repository view, expand the Database node and drag a Database Reader onto the workflow editor.
  4. Double-click the Database Reader and set the following properties:

    • Database Driver: In the menu, select the CData JDBC driver.
    • Database URL: Enter the connection properties. The JDBC URL begins 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:

      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.

      A typical JDBC URL is below. jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;

    • User Name: The username used to authenticate.
    • Password: The password used to authenticate.
    • SQL Statement: Enter an SQL query in the SQL Statement box or double-click a table. This article uses the query below to create a chart: SELECT Key, Etag FROM Objects WHERE Bucket = 'someBucket'
  5. Test the connection by clicking Fetch Metadata.

  6. Connect the Database Reader to a Data to Report node to supply the dataset to a range of data visualization controls. Click Execute and then click Edit Report at the top of the workflow to open the report designer perspective.
  7. You can now generate reports based on live data. To create a chart, drag the chart control from the palette to the report designer. In the resulting wizard, you can use the filtering and aggregation controls available in KNIME.
 
 
ダウンロード