Integrate REST Data in Pentaho Data Integration

The CData JDBC Driver for REST enables access to live data from data pipelines. Pentaho Data Integration is an Extraction, Transformation, and Loading (ETL) engine that data, cleanses the data, and stores data using a uniform format that is accessible.This article shows how to connect to REST data as a JDBC data source and build jobs and transformations based on REST data in Pentaho Data Integration.

Configure to REST Connectivity

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

After setting the and providing any authentication values, set to "XML" or "JSON" and set to more closely match the data representation to the structure of your data.

The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

• Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
• FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
• Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

Built-in Connection String Designer

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

java -jar cdata.jdbc.rest.jar

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

When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Below is a typical JDBC URL:

jdbc:rest:DataModel=Relational;URI=C:/people.xml;Format=XML;

Save your connection string for use in Pentaho Data Integration.

Connect to REST from Pentaho DI

Open Pentaho Data Integration and select "Database Connection" to configure a connection to the CData JDBC Driver for REST

1. Click "General"
2. Set Connection name (e.g. REST Connection)
3. Set Connection type to "Generic database"
4. Set Access to "Native (JDBC)"
5. Set Custom connection URL to your REST connection string (e.g.
   

   jdbc:rest:DataModel=Relational;URI=C:/people.xml;Format=XML;

6. Set Custom driver class name to "cdata.jdbc.rest.RESTDriver" 👁 Configuring the JDBC Driver connection.
   
7. Test the connection and click "OK" to save. 👁 Saving the connection.
   

Create a Data Pipeline for REST

Once the connection to REST is configured using the CData JDBC Driver, you are ready to create a new transformation or job.

1. Click "File" >> "New" >> "Transformation/job"
2. Drag a "Table input" object into the workflow panel and select your REST connection. 👁 Configuring the Table input object
   
3. Click "Get SQL select statement" and use the Database Explorer to view the available tables and views. 👁 Selecting data (QuickBooks Online is shown).
   
4. Select a table and optionally preview the data for verification. 👁 Previewing the data (QuickBooks Online is shown).
   

At this point, you can continue your transformation or jb by selecting a suitable destination and adding any transformations to modify, filter, or otherwise alter the data during replication.

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for REST and start working with your live REST data in Pentaho Data Integration today.