Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for HarperDB consists of three basic steps:

Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory.
Provide the driver class. For example:
```
cdata.jdbc.harperdb.HarperDBDriver
```
Provide the JDBC URL. For example:
```
jdbc:harperdb:Server=127.0.0.1;User=admin;Password=1234;Port=9925;

or

jdbc:cdata:harperdb:Server=127.0.0.1;User=admin;Password=1234;Port=9925;
```
The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:harperdb:" or "jdbc:cdata:harperdb:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to HarperDB

Set the Server connection property to the hostname or IP address of your HarperDB instance. Set UseSSL to secure connections with TLS/SSL.

Authenticating to HarperDB

The driver supports Basic authentication and token authentication. To authenticate, select the desired authentication method in the AuthScheme property, and set the necessary credentials described below.

Basic

Set AuthScheme to Basic. Set User and Password to a HarperDB user and password.

Token

Set AuthScheme to Token. The driver supports Token authentication through the following schemes:

Driver managed: Set User and Password to a HarperDB user and password. The driver handles obtaining and refreshing OperationToken and RefreshToken. Encrypted token credentials are stored at CredentialsLocation.
User managed: Directly specify OperationToken and RefreshToken. The driver does not attempt to refresh or reacquire token credentials after the supplied tokens expire. The supplied tokens are located at CredentialsLocation but do not persist across connections.

The driver also offers the following properties to govern token management in the Driver managed scheme:

OperationTokenTimeout: this governs how long the driver attempts to use a supplied OperationToken before refreshing it. It should match the setting for operation_token lifetimes in HarperDB. It defaults to the default operation_token lifetime for HarperDB.
RefreshTokenTimeout: this governs how long the driver attempts to use a supplied RefreshToken before refreshing it. It should match the setting for refresh_token lifetimes in HarperDB. It defaults to the default refresh_token lifetime for HarperDB.