This section describes how to create a JDBC data source for API data and execute queries.

Add the JDBC Driver for API

Complete the following steps to add the driver .jar file:

1. In the Drivers pane, click the plus icon to open the Add Driver wizard.
2. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for API.
3. In the Example URL box, enter jdbc:api:
4. In the Extra Class Path tab, click Add.
5. In the file explorer that opens, select the .jar file for the driver, located in the lib subfolder of the installation directory.
6. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.api.APIDriver.

Create the JDBC Data Source

Complete the following steps to select the API driver you created and build the JDBC URL to create the JDBC data source:

1. In the Aliases pane, click the plus icon.

2. In the Add Alias wizard that opens, provide values for the following fields:

   • Name: Enter a name for the alias; for example, CData API Source.
   • Driver: Select the driver definition you created.
   • URL: Enter jdbc:api:
   • User Name: If needed, enter a user name for authentication, which is added to the JDBC URL.
   • Password: If needed, enter a password for authentication, which is added to the JDBC URL.

3. If you want to define any additional properties, add them to the JDBC URL in a semicolon-separated list.

   The following is a typical connection string:
   

   jdbc:api:Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>

   See Establishing a Connection for a connection and authentication guide.

Or, follow these steps to add the properties in the Driver Properties dialog:

1. Select the Use Driver Properties check box.
2. In the Specify column, select the check boxes for the required connection properties and specify the corresponding values.
3. In the dialog that appears after you click OK, click Connect to test the connection.

Discover Schemas and Query API Data

To connect to the data source, right-click the alias on the Aliases pane and then click Connect. After the metadata has loaded, a new tab for the API data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data and metadata, select the table on the Objects tab. Access the table data on the Content tab.

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