From c148d6ae8117d24bd1064569312dfc9aafe7657f Mon Sep 17 00:00:00 2001 From: Hannu Hartikainen Date: Mon, 9 Oct 2023 15:10:46 +0300 Subject: [PATCH] Mention HikariCP use of :username more prominently I've been using the wrong keyword in two separate projects now. Clarifying the keyword reference for my future self and maybe others too. --- doc/all-the-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/all-the-options.md b/doc/all-the-options.md index e1bea43..9a31c3c 100644 --- a/doc/all-the-options.md +++ b/doc/all-the-options.md @@ -16,7 +16,7 @@ Although `get-datasource` does not accept options, the "db spec" hash map passed * `:port` -- an optional integer that identifies the port on which the database is running; for common database types, `next.jdbc` knows the default so this should only be needed for non-standard setups or "exotic" database types; if `:none` is specified, `next.jdbc` will omit the port segment of the JDBC URL, * `:property-separator` -- an optional string that can be used to override the separators used in `next.jdbc.connection/jdbc-url` for the properties (after the initial JDBC URL portion); by default `?` and `&` are used to build JDBC URLs with properties; for SQL Server drivers (both MS and jTDS) `:property-separator ";"` is used, so this option should only be necessary when you are specifying "unusual" databases that `next.jdbc` does not already know about, * `:classname` -- an optional string that identifies the name of the JDBC driver class to be used for the connection; for common database types, `next.jdbc` knows the default so this should only be needed for "exotic" database types, -* `:user` -- an optional string that identifies the database username to be used when authenticating, +* `:user` -- an optional string that identifies the database username to be used when authenticating (NOTE: HikariCP needs `:username` instead – see below), * `:password` -- an optional string that identifies the database password to be used when authenticating. If you already have a JDBC URL, you can either specify that string _instead_ of a "db spec" hash map or, if you need additional properties passed to the JDBC driver, you can use a hash map containing `:jdbcUrl`, specifying the JDBC URL, and any properties you need as additional keys in the hash map.