jdbcDriver

Get all JDBC drivers

Securityapi_key
Request
query Parameters
is_built_in
boolean

Get only drivers that are built in to the engine when this is true and only user uploaded drivers when this is false

page_number
integer <int64>
Default: 1

The page number for which to get JDBC drivers. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

403

Forbidden access

get/jdbc-drivers
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create Jdbc Driver

Securityapi_key
Request
Request Body schema: application/json
required

The jdbc driver details.

driverName
required
string <= 255 characters

The name of the driver.

driverClassName
required
string <= 255 characters

The name of the class to use.

description
string <= 1024 characters

A description of the driver.

fileReferenceId
string

The file references ID of the uploaded zip file

driverSupportId
integer <int64>

The ID of the Driver Support plugin to use for this JDBC Driver.

Responses
201

Success

403

Forbidden access

409

Conflict

post/jdbc-drivers
Request samples
application/json
{
  • "driverName": "HANA driver",
  • "driverClassName": "com.sap.db.jdbc.Driver",
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}
Response samples
application/json
{
  • "driverName": "HANA driver",
  • "driverClassName": "com.sap.db.jdbc.Driver",
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Get JDBC driver by ID

Securityapi_key
Request
path Parameters
jdbcDriverId
required
integer <int32>

The ID of the JDBC driver to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/jdbc-drivers/{jdbcDriverId}
Response samples
application/json
{
  • "driverName": "HANA driver",
  • "driverClassName": "com.sap.db.jdbc.Driver",
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Update jdbc driver

Securityapi_key
Request
path Parameters
jdbcDriverId
required
integer <int32>

The ID of the JDBC driver to update

Request Body schema: application/json
required

The jdbc driver details.

driverName
required
string <= 255 characters

The name of the driver.

driverClassName
required
string <= 255 characters

The name of the class to use.

description
string <= 1024 characters

A description of the driver.

fileReferenceId
string

The file references ID of the uploaded zip file

driverSupportId
integer <int64>

The ID of the Driver Support plugin to use for this JDBC Driver.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

put/jdbc-drivers/{jdbcDriverId}
Request samples
application/json
{
  • "driverName": "HANA driver",
  • "driverClassName": "com.sap.db.jdbc.Driver",
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}
Response samples
application/json
{
  • "driverName": "HANA driver",
  • "driverClassName": "com.sap.db.jdbc.Driver",
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Delete JDBC driver by ID

Securityapi_key
Request
path Parameters
jdbcDriverId
required
integer <int32>

The ID of the JDBC driver to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/jdbc-drivers/{jdbcDriverId}
➔ Next to license