Installing A JDBC Driver

Install JDBC Driver zip on Masking Engine¶

1. Select POST /file-uploads

2. 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"
}

Note

Note that 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.

Warning

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.