How to connect to REST Data with Squirrel SQL client

The CData JDBC Driver for REST enables you to execute queries to REST data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for REST data and execute queries.

Add the JDBC Driver for REST

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for REST.
4. In the Example URL box, enter jdbc:rest:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.rest.RESTDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData REST Source.
   • Driver: Select the CData JDBC Driver for REST.
   • URL: Enter jdbc:rest:
   👁 The alias definition, containing the connection parameters. (Salesforce is shown.)
   
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required connection properties.

   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.

   Below is a typical connection string:

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

   👁 Connection properties automatically detected by Squirrel SQL. (Salesforce is shown.)
   
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query REST Data

After the metadata has loaded, a new tab for the REST data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

👁 Column metadata for a table. (Salesforce is shown.)

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT [people].[personal.age] AS age, [people].[personal.gender] AS gender, [people].[personal.name.first] AS first_name, [people].[personal.name.last] AS last_name, [vehicles].[model], FROM [people] JOIN [vehicles] ON [people].[_id] = [vehicles].[people_id]