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

Fixes #119 by improving docstrings

Browse source
This commit is contained in:
Sean Corfield 2020-06-07 09:39:04 -07:00
parent 6167440500
commit 35fc00d4b3
2 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -5,6 +5,7 @@ Only accretive/fixative changes will be made from now on.
Changes made on master since 1.0.462:
* Add tests for `"jtds"` database driver (against MS SQL Server), making it officially supported.
* Switch from OpenTable Embedded PostgreSQL to Zonky's version, so that testing can move forward from PostgreSQL 10.11 to 12.2.0.
* Address #119 by clarifying realization actions in the docstrings for `row-number`, `column-names`, and `metadata`.
* Add log4j2 as a test dependency so that I have better control over logging (which makes debugging easier!).
## Stable Builds

23
src/next/jdbc/result_set.clj
View file

@ -396,16 +396,23 @@
to realize a row by calling `datafiable-row` but still wants to call
these functions on the (realized) row."
(row-number [this]
"Return the current 1-based row number, if available.")
"Return the current 1-based row number, if available.
Should not cause any row realization.")
(column-names [this]
"Return a vector of the column names from the result set.")
"Return a vector of the column names from the result set.
Reifies the result builder, in order to construct column names,
but should not cause any row realization.")
(metadata [this]
"Return the raw `ResultSetMetaData` object from the result set.
If `next.jdbc.datafy` has been required, this will be fully-realized
as a Clojure data structure, otherwise this should not be allowed to
'leak' outside of the reducing function as it may depend on the
connection remaining open, in order to be valid."))
Should not cause any row realization.
If `next.jdbc.datafy` has been required, this metadata will be
fully-realized as a Clojure data structure, otherwise this should
not be allowed to 'leak' outside of the reducing function as it may
depend on the connection remaining open, in order to be valid."))
(defn- mapify-result-set
"Given a `ResultSet`, return an object that wraps the current row as a hash
@ -428,7 +435,7 @@
InspectableMapifiedResultSet
(row-number [this] (.getRow rs))
(column-names [this] (:cols @builder))
(metadata [this] (d/datafy (:rsmeta @builder)))
(metadata [this] (d/datafy (.getMetaData rs)))
clojure.lang.IPersistentMap
(assoc [this k v]
@ -510,7 +517,7 @@
;; that they can be thrown when the actual functions are called
(let [row (try (.getRow rs) (catch Throwable t t))
cols (try (:cols @builder) (catch Throwable t t))
meta (try (d/datafy (:rsmeta @builder)) (catch Throwable t t))]
meta (try (d/datafy (.getMetaData rs)) (catch Throwable t t))]
(with-meta
(row-builder @builder)
{`core-p/datafy