aws/aws-secretsmanager-jdbc

JDBC URL config example is unclear

eoliphan opened this issue · 1 comments

Describe the bug
The Usage Example indicates that setting the db url to this driver's scheme (jdbc-secretsmanager) will result in it being 'intercepted' by the driver.

This (to me at least) indicates that the driver will replace the 'jdbc-secretsmanager:...' url with the one in the AWS Secret. When in fact this config only results in the 'jdbc-secretsmanager"' bing replaced with 'jdbc:' (presumably to allow you to only manage the un/pw in AWS Secrets Manager?)

Expected behavior
Usage example should document that the rest of the url is passed as is if 'jdbc-secretsmanager:' scheme is used, and that if you wish to pull all the connection info from the secret, that the secret id should be used as the url as well.

Also, the examples in the AWS Docs do make this clear

jbct commented

Hi @eoliphan, thank you for the feedback. We will look into making this more clear.