This section describes how to connect with the JDBC DriverManager or APIDataSource interfaces.

Connecting with the DriverManager

When connecting with the DriverManager class, the CData JDBC Driver for API follows the JDBC convention: First, load the API driver class. Then, make a connection.

Load the Driver

The following step is optional per the JDBC 4.0 specification.

Class.forName("cdata.jdbc.api.APIDriver");

Establish a Connection

Provide the connection string with the getConnection method of the static DriverManager class. Start the connection string with "jdbc:api:". A typical connection string is the following:

Connection conn = DriverManager.getConnection("jdbc:api:Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>");

Alternatively, you can prepare the connection options using a Properties object. Pass the Properties object to the DriverManager.

Properties prop = new Properties();
prop.setProperty("Property1","Value1");
prop.setProperty("Property2","Value2");
Connection conn = DriverManager.getConnection("jdbc:api:,");
  

Connecting with the APIDataSource Class

You can use the APIDataSource class to create pooled connections, as shown in the following example. See Connection Pooling for more information.

The following example instantiates a pooled Connection object:

APIDataSource ds = new APIDataSource("jdbc:api:UseConnectionPooling=true;Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>"); 
Connection conn = ds.getConnection();