Skip to content

Commit b61c1ab

Browse files
authored
docs: add note about HikariCP's instantiation failure messages (#1080)
1 parent 56d152b commit b61c1ab

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/using-the-jdbc-driver/DataSource.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,15 @@ To use the AWS JDBC Driver with a connection pool, you must:
8282
ds.addDataSourceProperty("targetDataSourceProperties", targetDataSourceProps);
8383
```
8484

85-
> **:warning:Note:** HikariCP supports either DataSource-based configuration or DriverManager-based configuration by specifying the `dataSourceClassName` or the `jdbcUrl`. When using the `AwsWrapperDataSource` you must specify the `dataSourceClassName`, and the `HikariDataSource.setJdbcUrl` method should not be used. For more information see HikariCP's [documentation](https://github.com/brettwooldridge/HikariCP#gear-configuration-knobs-baby).
85+
> [!WARNING]\
86+
> HikariCP supports either DataSource-based configuration or DriverManager-based configuration by specifying the `dataSourceClassName` or the `jdbcUrl`. When using the `AwsWrapperDataSource` you must specify the `dataSourceClassName`, and the `HikariDataSource.setJdbcUrl` method should not be used. For more information see HikariCP's [documentation](https://github.com/brettwooldridge/HikariCP#gear-configuration-knobs-baby).
87+
88+
> [!NOTE]\
89+
> When using HikariCP with the wrapper, you may see log messages from HikariCP about unable to instantiate their `PropertyElf` class:
90+
>
91+
> `com.zaxxer.hikari.util.PropertyElf - Class "{wrapperLogLevel=ALL, defaultRowFetchSize=10000, wrapperPlugins=failover,efm2}" not found or could not instantiate it`
92+
>
93+
> The wrapper does not rely on Hikari's PropertyElf to set properties on the target DataSource object, so these messages can be ignored.
8694
8795
### Examples
8896
See [here](../../examples/AWSDriverExample/src/main/java/software/amazon/DatasourceExample.java) for a simple AWS Driver Datasource example.

0 commit comments

Comments
 (0)