Connect to Carbone Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Carbone into your processes in RapidMiner. This article uses the CData JDBC Driver for Carbone to transfer Carbone data to a process in RapidMiner.

Connect to Carbone in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Carbone:

1. Add a new database driver for Carbone: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   
   jdbc:api:
   

4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   
   cdata.jdbc.api.APIDriver
   

   
6. Create a new Carbone connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Carbone driver you configured previously.
9. Enter your connection string in the Host box.

   Start by setting the Profile connection property to the location of the Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

   Carbone API Profile Settings

   Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

   1. Log in to your Carbone account at https://account.carbone.io
   2. Copy the API key shown on the account home page

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Carbone API key (Bearer token).
   • CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Carbone JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   
   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   A typical connection string is below:

   
   Profile=C:\profiles\Carbone.apip;AuthScheme=APIKey;APIKey=your_api_key;
   

10. Enter your username and password if necessary.

You can now use your Carbone connection with the various RapidMiner operators in your process. To retrieve Carbone data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Carbone data.