The database driver used to cache data.

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined by the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note: you must add the CacheDriver JAR file to the classpath. For Linux systems and macOS, you need to create a config.ini file on the installation path of the driver (site-packages/cdata). The config.ini file has the following format (the driver and the path of the JDBC driver):

[salesforce.cpython-38-x86_64-linux-gnu.so]
CLASSPATH = /home/usrname/Downloads/lib/cdata.jdbc.postgresql.jar

Examples

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

Java DB is the Oracle distribution of Derby. The Derby JDBC driver's JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. After adding derby.jar to the classpath, you can cache to a Java DB database as follows:

jdbc:highrise:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;

To cache to an in-memory database, use a JDBC URL like the following:

jdbc:highrise:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:highrise:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;

MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:highrise:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;
  

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:highrise:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:highrise:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;

NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:highrise:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;