luciano/next-jdbc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add note to with-options docstring about usage in Getting Started section

Browse source
This commit is contained in:
Sean Corfield 2020-09-20 12:17:21 -07:00
parent ef96e04cb6
commit 0142b25dc6
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/next/jdbc.clj
View file

@ -286,7 +286,13 @@
(defn with-options (defn with-options
"Given a connectable/transactable object and a set of (default) options "Given a connectable/transactable object and a set of (default) options
that should be used on all operations on that object, return a new that should be used on all operations on that object, return a new
wrapper object that can be used in its place." wrapper object that can be used in its place.
Bear in mind that `get-datasource`, `get-connection`, and `with-transaction`
return plain Java objects, so if you call any of those on this wrapped
object, you'll need to re-wrap the Java object `with-options` again. See
the Datasources, Connections & Transactions section of Getting Started for
more details, and some examples of use with these functions."
[connectable opts] [connectable opts]
(opts/->DefaultOptions connectable opts)) (opts/->DefaultOptions connectable opts))