Installing a JDBC driver

Uploaded JDBC drivers are loaded and executed inside the Masking Engine's JVM under the engine's service account. A malicious or tampered driver can therefore run arbitrary code on the engine host. Before uploading a driver, ensure the following:

Source: Obtain the driver only from a trusted source. Drivers distributed directly by Perforce (for example, the CDATA connectors) are packaged by us. All other drivers should be downloaded from the database vendor's official website—not from third-party mirrors, forums, or archive sites.
Integrity: Where the vendor publishes a checksum or signature (SHA-256, GPG signature, etc.), verify the downloaded file against it before uploading.
Version: If Perforce documentation or Support recommends a specific driver version for compatibility, use that exact version from the vendor.
Least privilege: Only accounts that genuinely need to install drivers should have permission to do so. See Users and Roles for guidance on limiting this privilege.

Install JDBC driver zip on masking engine

Select POST /file-uploads
Click "Choose File" and select desired JDBC driver zip

The response will look similar to the following with a return status of 200:

{
    "fileReferenceId": "delphix-file://upload/f_xxxx/sampleJdbcDriver.zip"}

You can also install a JDBC driver via the UI.

Create JDBC driver without driver support

Select POST /jdbc-drivers
Format the request body as follows:

{
    "driverName": "HANA driver",
    "driverClassName": "com.sap.db.jdbc.Driver",
    "fileReferenceId": "delphix-file://upload/f_xxxx/sampleJdbcDriver.zip",
}

The response will look similar to the following with a return status of 200:

{
    "jdbcDriverId": 8,
    "driverName": "HANA driver",
    "driverClassName": "com.sap.db.jdbc.Driver",
    "version": "2.4",
    "uploadedBy": "admin",
    "uploadDate": "2021-04-27T20:34:47.748+00:00",
    "checksum": "a5b7cf1323b71398e68fd583cd4f40ef8a5f4212ae94b63e95c904ed226d4c7b",
    "builtIn": false,
    "loggerInstalled": true,
}

Create JDBC driver with driver support

To create a JDBC driver with driver support, follow the same process, but add driverSupportId to the request body. This is used to specify the ID of the driver support plugin to associate with the JDBC driver.

If the JDBC driver's referenced driver support plugin tasks are enabled on any existing masking job, validation on update is done in order to prevent changing the driver support plugin to another one unless it implements all enabled tasks. If the other driver support does not implement all enabled tasks, the update will fail.