Driver 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 in handling AWS RDS cluster tracking (see aws cluster tracking) | String |
| Reader Url | readerUrl | Used in handling AWS RDS cluster tracking (see aws cluster tracking) | String |
| Webstite Url | websiteUrl | Used as a reference, not required | String |
| Notes | notes | Optional text field for notes on the driver | String |
| JDBC Class | jdbcClass | Required: provided by jdbc driver vendor | 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 field. Used to provide automatic download of jdbc jar file from maven central. Text should match a pattern: "groupId:artifactId:version" e.g. for mysql: mysql:mysql-connector-java:5.1.49. Jar file will be downloaded on driver creation and during update if not exists. | 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 |
Reader and Writer variables
Please read AWS Cluster Tracking for more detailed information.
Key is the variable to be used in reader and write URL's for substitution, which should be used based on the information extracted from the AWS configuration
| Key | Description |
|---|---|
| ${listener} | For SQL Server, this will represent the listener URL, which points to the IP that tracks between the primary writer node during a failover. Empty for non-SQL Server cluster types |
| ${writeEndpoint} | For Aurora clusters, this will point to the primary endpoint hostname, which uses DNS to fail between primary nodes. |
| ${readerEndpoint} | For Aurora clusters, this will point to the reader endpoint hostname, which uses DNS over time to spray load across reader nodes. For a single node reader setup, this is appropriate, but in multi-node reader configurations, this can result in uneven distribution. |
| ${writer} | For any cluster type, this will point to the actual active writer. If more than one writer is detected, then multiple nodes will be created, one with each writer. |
| ${writers} | Like with writer, but will fill in all writer hostnames in a comma separated list. Useful for URL types that allow multiple hosts to be included in a single URL |
| ${reader} | Generates one node per reader, including a node for the writer, for the purpose of reading. The read weight of readers will be set to 10, but the read weight of the writer will be set to 1. |
| ${readers} | Generate one reader node, with all readers in a comma seperated list. The writer(s) will be first in the list. |
| ${replica} | Include all the readers as distinct servers, not including writer nodes |
| ${replicas} | Include all the readers in one URL, not including writer nodes |