Skip to content

Drivers options:

This is list of options regarding Drivers, these options can be set from Configure → Drivers.

These options are saved inside drivers configuration file. The filename depends on the name of the driver → nameOfDriver.conf.

⚠️ Note: You can use SHIFT with mouse scroll to scroll horizontally!

Key Conf File field Description Possible values
Version driverVersion The Version ID of the driver, for reference only String
Example Url exampleUrl Used as a reference, not required String
Writer Url writerUrl Used to build a cluster writer URL from discovered nodes String
Reader Url readerUrl Used to build a cluster reader URL from discovered nodes String
Webstite Url websiteUrl Used as a reference, not required String
Notes notes Required: provided by jdbc driver vendor String
JDBC Class jdbcClass Optional text field for notes on the driver String
Data Source Class dataSourceClass Optional: used in some situations, provided by JDBC driver vendor String
XA Data Source Class xaDataSourceClass Optional: used in some situations when using XA transactions, provided by JDBC driver vendor String
Maven ID mavenId Optional: use if want to jdbc driver to be downloaded automatically by provided maven ID. Pattern for Maven ID: 'groupId:artifactId:version'. String
Driver Upload uploadedDrivers Upload your driver file(s) here. If a driver happens to be incompatible with our remote download scheme, this driver file can be left blank, as long as the driver is available on the server using the Heimdall Driver itself. This is a known issue with the AWS Redshift driver. String
Auto Update autoUpdate Automatic driver option update when Heimdall is updated String
Enable enabled Used to control if driver is enabled or disabled for use String
- file Name of the file that stored driver information String
Name name Name of the driver, used to identify it. String