ETL IBM Cloud Object Storage in Oracle Data Integrator

Leverage existing skills by using the JDBC standard to connect to IBM Cloud Object Storage: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for IBM Cloud Object Storage connects real-time IBM Cloud Object Storage data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with IBM Cloud Object Storage just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the IBM Cloud Object Storage APIs in real time instead of working with flat files.

This article walks through a JDBC-based ETL -- IBM Cloud Object Storage to Oracle. After reverse engineering a data model of IBM Cloud Object Storage entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR and .lic file, located in the installation folder, into the ODI appropriate directory:

• UNIX/Linux without Agent: ~/.odi/oracledi/userlib
• UNIX/Linux with Agent: $ODI_HOME/odi/agent/lib
• Windows without Agent: %APPDATA%\Roaming\odi\oracledi\userlib
• Windows with Agent: %APPDATA%\Roaming\odi\agent\lib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of IBM Cloud Object Storage data. After reverse engineering, you can query real-time IBM Cloud Object Storage data and create mappings based on IBM Cloud Object Storage tables.

1. In ODI, connect to your repository and click New -> Model and Topology Objects.
2. On the Model screen of the resulting dialog, enter the following information:
   • Name: Enter IBMCloudObjectStorage.
   • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
   • Logical Schema: Enter IBMCloudObjectStorage.
   • Context: Select Global.
3. On the Data Server screen of the resulting dialog, enter the following information:
   • Name: Enter IBMCloudObjectStorage.
   • Driver List: Select Oracle JDBC Driver.
   • Driver: Enter cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver
   • URL: Enter the JDBC URL containing the connection string.

     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.

     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.

     Below is a typical connection string:

     jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
4. On the Physical Schema screen, enter the following information:
   • Name: Select from the Drop Down menu.
   • Database (Catalog): Enter CData.
   • Owner (Schema): If you select a Schema for IBM Cloud Object Storage, enter the Schema selected, otherwise enter IBMCloudObjectStorage.
   • Database (Work Catalog): Enter CData.
   • Owner (Work Schema): If you select a Schema for IBM Cloud Object Storage, enter the Schema selected, otherwise enter IBMCloudObjectStorage.
5. In the opened model click Reverse Engineer to retrieve the metadata for IBM Cloud Object Storage tables.

Edit and Save IBM Cloud Object Storage Data

After reverse engineering you can now work with IBM Cloud Object Storage data in ODI. To view IBM Cloud Object Storage data, expand the Models accordion in the Designer navigator, right-click a table, and click View data.

Create an ETL Project

Follow the steps below to create an ETL from IBM Cloud Object Storage. You will load Objects entities into the sample data warehouse included in the ODI Getting Started VM.

1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

   Alternatively you can use SQLPlus. From a command prompt enter the following:

   sqlplus / as sysdba
2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the Objects table in IBM Cloud Object Storage: CREATE TABLE ODI_DEMO.TRG_OBJECTS (ETAG NUMBER(20,0),Key VARCHAR2(255));
3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
4. Click Reverse Engineer. The TRG_OBJECTS table is added to the model.
5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
6. Drag the TRG_OBJECTS table from the Sales Administration model onto the mapping.
7. Drag the Objects table from the IBM Cloud Object Storage model onto the mapping.
8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
9. Open the Physical tab of the Mapping Editor and click OBJECTS_AP in TARGET_GROUP.
10. In the OBJECTS_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load IBM Cloud Object Storage data into Oracle.