JDBC driver properties - Precisely Data Integrity Suite

Data Integrity Suite
Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2026

Configure JDBC driver properties to define driver behavior, including display names, class names, database asset paths, sample queries, and field enclosures for custom JDBC drivers.

Driver Property Description Examples
driver.display.name Specifies the name of the driver that displays in the UI. This is a mandatory property. driver.display.name=My Awesome Driver
driver.class.name Specifies the fully qualified driver class name. This is a mandatory property. driver.class.name=com.example.jdbc.Driver
driver.assetpath.database.exists Defines whether the database must be part of the cataloging or not.

Default value: true.

If value is set to true, then the database will be a part of the cataloging. And if value is set to false then the database will not be part of cataloging.

 driver.assetpath.database.exists=true
driver.sample.query It is recommended to use this property with the value as a placeholder SELECT query, formatted as shown in the examples. This sample query serves as a template, outlining the query structure using the allowed placeholders. The application will then replace the placeholders with actual values to generate the final query for execution.

Allowed placeholders,

%fields%: Specifies a placeholder for columns to be selected.

%limit%: Specifies a placeholder for the number of records to query. Ensure to add the keyword and syntax to limit the number of rows as per the database that you are using (e.g., TOP, LIMIT, FETCH FIRST, ROWNUM, etc.).

%database%: Specifies a placeholder for the database name used in the query. Add any necessary special characters (e.g., double-quotes, square brackets) around this placeholder as required by your database.

%schema%: Specifies a placeholder for the schema name used in the query. Add any necessary special characters (e.g., double-quotes, square brackets) around this placeholder as required by your database.

%table%: Specifies a placeholder for the table or dataset to be queried. Add any necessary special characters (e.g., double-quotes, square brackets) around this placeholder as required by your database.
Note: Ensure that the delimiter used to separate the database, schema, and table placeholders are specific to the database that you are using.
 For MSSQL and Azure Synapse Analytics: Select TOP %limit% %fields% From [%database%].[%schema%].[%table%]

For Oracle: Select %fields% From "%schema%"."%table%" WHERE ROWNUM <= %limit%

For PostgreSQL, refer to this documentation.

For IBM DB2, refer to this documentation.

For AWS Redshift, refer to this documentation.

driver.sample.fields.enclosure.opening

driver.sample.fields.enclosure.closing

 The property, driver.sample.fields.enclosure.opening : Specifies the character that should appear at the start of each field or column in the query, as per the requirement of the database.

The property, driver.sample.fields.enclosure.closing : Specifies the character that should appear at the end of each field or column in the query, as per the requirement of the database.

Note:
  • These properties allow you to define the characters that enclose all fields or columns selected by you during sample generation. This allows you to adjust how fields are enclosed when executing the query specified in driver.sample.query
  • These properties are now also required for running the Data Quality Pipeline, in addition to sample generation.
  • Additionally, these fields are now mandatory to define and must be specified based on the datasource.
  • By configuring this property, you can specify the characters used for marking or enclosing fields, such as double quotes or square brackets. This ensures that the generated queries align with the requirements of the database.
 If your query appears as: SELECT name, age, address FROM db.schema.users;

The below properties are set by you driver.sample.fields.enclosure.opening = [ driver.sample.fields.enclosure.closing = ]

Then the same query would be transformed into: SELECT [name], [age], [address] FROM db.schema.users;

When defining the property for a datasource, for example,

For PostgreSql: driver.sample.fields.enclosure.opening = " driver.sample.fields.enclosure.closing = "

Then the query would be transformed into: SELECT "name", "age", "address" FROM db.schema.users;

For MySQL: driver.sample.fields.enclosure.opening = driver.sample.fields.enclosure.closing = '

Then the query would be transformed into: SELECT 'name', 'age', 'address' FROM db.schema.users;

driver.view.enable

This boolean property enables users to specify whether or not they want to catalog views.

By setting this property to true, the system will catalog the views.

If set to false, cataloging of views will be skipped.

 
driver.assetpath.schema.exists

Determines whether the schema should be included in the cataloging process.

By default, the value is set to true, the schema will be included in the catalog.

If the value is set to false, the schema will be excluded from the catalog.

driver.assetpath.schema.exists=true
driver.spark.overrides.filename Define the Spark data type property. This will be replaced with the matching SQL data type when you update the code. driver.spark.overrides.filename=spark_overrides.json
This file should be placed in the same directory as the driver.properties bundle. You can utilize the defaults provided in the files or modify them according to your requirements.
{
  "sparkType": "String",
  "dbType": "varchar(8000)"
},
{
  "sparkType": "binary",
  "dbType": "varbinary(8000)"
}
driver.url.custom.params The property is used to define the custom parameters that you want to append to the JDBC URL. For Azure Synapse Analytics: connectionType=Synapse;
Note: When setting up Azure Synapse Analytics, you also need to define these properties:

driver.dialect.classname=com.precisely.runtime.spark.operators.jdbc.dialect.SynapseSQLServerDialect

driver.dialect.delegate.classname=org.apache.spark.sql.jdbc.MsSqlServerDialect