Commit graph

300 commits

Author SHA1 Message Date
Sean Corfield
79236b45e5 Improve plan/reduce documentation
Also rolls H2 version back so examples work properly. 1.4.200 doesn't 
like one of the data types the examples use.
2020-03-08 17:05:13 -07:00
Sean Corfield
db993e0d30 Release 1.0.395 2020-03-02 13:49:11 -08:00
Sean Corfield
85da329bde Prepare for 1.0.next release
Should be 1.0.395
2020-03-02 13:48:19 -08:00
Sean Corfield
3d10e9bdd9 Add mention of next.jdbc.date-time to PostgreSQL Tips & Tricks 2020-03-01 10:14:28 -08:00
Sean Corfield
051bc9bd9c Fixes #95 by adding notes about/links to next.jdbc.date-time 2020-03-01 10:11:18 -08:00
Sean Corfield
11f03de1f5 Add Tips & Tricks to doc index 2020-02-28 13:26:40 -08:00
Sean Corfield
4d7940a5d3 Reorganize Tips & Tricks after #94 2020-02-28 13:23:06 -08:00
Valtteri Harmainen
32a6b30035 Add docs for working with postgres json and jsonb 2020-02-28 22:53:22 +02:00
Sean Corfield
4ab0ecd7df Prep for 1.0.384 release 2020-02-28 11:04:11 -08:00
Sean Corfield
eb722b502e Fixes #93 by improving documentation about datafiable-row 2020-02-28 10:54:28 -08:00
Sean Corfield
81743f1484 Address #92 by repeating transaction/connection note 2020-02-26 11:56:08 -08:00
Sean Corfield
126ac58c34 Fixes #88 by calling 1-arity keyword
Also supports calling `:qualifier-fn` on an empty table name.
2020-02-26 11:48:42 -08:00
Sean Corfield
8083689821 Note PG returns entire row 2020-02-20 07:21:17 -08:00
Sean Corfield
789bf1fae6 Added streaming options for PostgreSQL to Tips & Tricks 2020-02-12 12:43:57 -08:00
Sean Corfield
9f7a3f5906 Apply #85 to the migration guide too 2020-01-17 10:44:59 -08:00
bpringe
7357a913a2
Correct "suffices" to "suffixes" 2020-01-17 10:23:46 -08:00
Sean Corfield
f66a68d294 Prep for 1.0.13 release 2019-12-29 16:14:32 -08:00
Sean Corfield
79d2772e14 Attempt to clarify when prepared statements are created 2019-12-25 21:16:24 -08:00
Sean Corfield
a2ba8ff780 Fixes #82 and adds next.jdbc.prepare/statement 2019-12-20 15:45:22 -08:00
Sean Corfield
bcde88e1ee Prep for 1.0.12 2019-12-11 16:46:42 -08:00
Sean Corfield
6497641896 Fixes #78 by documenting the workaround
Getting Started's notes about HikariCP now link to the issue on that 
repo.
2019-12-11 14:45:54 -08:00
Sean Corfield
986c37c457 Prep for 1.0.11 release 2019-12-07 09:21:18 -08:00
Sean Corfield
c7e2e61bb6 Make "notes" consistent in formatting 2019-11-26 11:12:37 -08:00
Sean Corfield
fec1166e5c Test on JDK11; document updated Derby versions
1.15.x.y requires JDK9+ and requires two dependencies.

1.14.x.y runs on JDKs up to 11.
2019-11-16 00:12:13 -08:00
Sean Corfield
ce3530233f Fix Tips & Tricks link 2019-11-14 19:22:43 -08:00
Sean Corfield
05a6d8a47f Prep for 1.0.10 release 2019-11-14 19:08:50 -08:00
Sean Corfield
d561a7108e Fixes #75 by adding java.sql.Statement support 2019-11-14 16:15:52 -08:00
Sean Corfield
5e52d30927 Improve docs for column name conflicts 2019-11-13 10:04:52 -08:00
Sean Corfield
6450bfa0f2 Clarify :result-type/:concurrency interaction
Also further clarify MS SQL Server behavior.
2019-11-13 09:52:32 -08:00
Sean Corfield
e81f382ef8 Add MS SQL Server to Tips & Tricks 2019-11-13 09:37:21 -08:00
Sean Corfield
ce00025c3d Doc cleanup 2019-11-10 14:24:39 -08:00
Sean Corfield
f864cd67cd Make option handling more obvious; show :builder-fn 2019-11-10 13:47:08 -08:00
Sean Corfield
e2058fb6ae Further caveat on unqualified column names 2019-11-08 11:16:17 -08:00
Sean Corfield
bb3048f8f8 More documentation improvements 2019-11-08 11:12:17 -08:00
Sean Corfield
be416fee81 Add simplicity caveat to friendly SQL functions
Also provide more detail about alternatives.
2019-11-08 10:42:18 -08:00
Sean Corfield
b5048cca85 Improve migration docs
`next.jdbc.connection` namespace docstring now mentions `dbtypes` and 
`->pool`. **Primary API** in the migration doc now explicitly recommends 
using a datasource for piecemeal migration.
2019-11-08 10:20:28 -08:00
Sean Corfield
dd70625e8f Clarify behavior when no rows match a query 2019-11-01 09:34:14 -07:00
Sean Corfield
ea0f1868b3 More documentation for #70
Adds CLOB & BLOB SQL Types to Tips & Tricks section with example of 
`ReadableColumn` extension and reference to helper/column reader in 
`next.jdbc.result-set`.
2019-10-17 18:02:37 -07:00
Lauri Oherd
5f1d081af9
fix link
fix link to all-the-options.md file
2019-10-17 16:18:21 +03:00
Sean Corfield
61083eba69 Address #70 by adding/documenting CLOB column reader example 2019-10-14 11:13:36 -07:00
Sean Corfield
bde9c2d074 Prep for 1.0.9 release 2019-10-11 11:35:46 -07:00
Sean Corfield
8c75e3a546 Addresses #69 by expanding docs for execute-one!
Updates include adding notes on `execute!`, `execute-one!`, and `plan` 
in the README, as well as expanding the docstrings for those functions.
2019-10-11 11:26:41 -07:00
Sean Corfield
222449c9a9 Fixes #68 by clarifying docs around :next.jdbc/update-count 2019-10-01 10:53:23 -07:00
Sean Corfield
0e4c6b8d6f Prep for 1.0.8 2019-09-27 19:59:20 -07:00
Sean Corfield
6c42d7ce67 Fixes #66 by adding support for :jdbcUrl in db-spec hash map 2019-09-27 13:06:45 -07:00
Sean Corfield
0f0f6fbe92 Add "latest versions" caveat 2019-09-27 13:06:05 -07:00
Sean Corfield
d17222e031 Fixes #65 by adding HugSQL docs 2019-09-27 12:20:02 -07:00
Sean Corfield
8cb05f4495 Fix #63 by adding caveats to qualified column name docs 2019-09-14 18:13:39 -07:00
Sean Corfield
e03de7828a Document PR #64
Add to change log, Getting Started, and ns docstring for 
`next.jdbc.specs`. Also note docs in GitHub are for **master** now.
2019-09-14 13:32:34 -07:00
Sean Corfield
3dfc6ffba2 Prep for 1.0.7 release 2019-09-09 16:29:49 -07:00
Sean Corfield
2c51c549d6 Fixes #60 by documenting/testing simpler :schema format 2019-09-09 16:22:25 -07:00
Sean Corfield
e173e397d2 Note the jdbc: prefix difference 2019-09-06 02:01:47 -07:00
Sean Corfield
7d936bec46 Note HikariCP needs :username 2019-09-06 01:50:20 -07:00
Sean Corfield
eed988896c Merge branch 'master' of github.com:seancorfield/next-jdbc 2019-09-06 01:43:47 -07:00
Sean Corfield
aa955ead80 Fix formatting; add link to seql 2019-09-06 01:43:25 -07:00
Sean Corfield
a0b4618083 Doc updates for PostgreSQL = ANY(?) trick 2019-09-04 19:19:32 -07:00
Sean Corfield
f1b8fea9bb Prep for 1.0.6 release 2019-08-24 12:05:45 -07:00
Sean Corfield
2a5e87cf22 Improve result set builder adapter docs 2019-08-24 09:14:02 -07:00
Sean Corfield
f95467a34c Improve docs for insert-multi! / execute-batch!
Call out the caveats more clearly. Note that Oracle doesn't support the 
`insert-multi!` syntax(!).
2019-08-22 13:09:07 -07:00
Sean Corfield
9a76e4c25a Add as-arrays-adapter 2019-08-21 14:47:55 -07:00
Sean Corfield
fed305dd2b Add and document as-maps-adapter 2019-08-21 14:19:32 -07:00
Sean Corfield
0049b007e5 Fixes #54 by adding new section to Getting Started 2019-08-21 13:30:33 -07:00
Sean Corfield
87e44ae6a6 Fixes #52 by using US-locale lower-case function 2019-08-08 17:01:23 -07:00
Sean Corfield
f4b8ff5cdb Prep for 1.0.5 release 2019-08-05 18:30:24 -07:00
Sean Corfield
22b7e6df61 Reword username/user caveat for HikariCP 2019-07-26 12:39:52 -07:00
Sean Corfield
7bab6718bc HikariCP/jTDS caveats 2019-07-26 12:07:36 -07:00
Sean Corfield
87acc3d3cb Add caveat about HikariCP username 2019-07-25 11:43:35 -07:00
Sean Corfield
cd67997561 Prep for 1.0.4 2019-07-24 22:53:07 -07:00
Sean Corfield
5424353f2d Clarify position on default options
I.e., write your own wrapper if you want to globally override options.
2019-07-24 22:49:24 -07:00
Sean Corfield
9372ce11cd Fix #50 by testing against (embedded) PostgreSQL
This is the first database that returns lowercase columns in results so 
there are a lot of conditionals in the tests now. It also returns entire 
rows on inserts instead of just the generated key.
2019-07-24 17:32:58 -07:00
Sean Corfield
097cdf7d28 Improve connection pooling docs 2019-07-24 15:45:16 -07:00
Sean Corfield
9e8477bd4b Prep for 1.0.3 release 2019-07-23 19:02:55 -07:00
Sean Corfield
eda2c4c270 Bug fix examples for SettableParameter and ReadableColumn 2019-07-22 16:41:41 -07:00
Sean Corfield
c246c5db6f Clarify SettableParameter and ReadableColumn usage 2019-07-22 15:47:50 -07:00
Sean Corfield
1b8e4b8c9c Merge branch 'master' of github.com:seancorfield/next-jdbc 2019-07-22 15:12:19 -07:00
Sean Corfield
5c21d17dec Add example of extending SettableParameter 2019-07-22 15:12:14 -07:00
Sean Corfield
4f147bdcb9 More documentation tweaks
Mostly about `execute-batch!`.
2019-07-20 19:26:06 -07:00
Sean Corfield
8c98f60a30 Misc doc improvements 2019-07-20 16:55:20 -07:00
Sean Corfield
c9a9310449 Update test deps 2019-07-19 12:33:45 -07:00
Sean Corfield
05d9b06ddc Note Connection Pooling stuff is coming in 1.0.3 2019-07-18 12:25:09 -07:00
Sean Corfield
b3f462e90b Fixes #48 by documenting connection/->pool 2019-07-18 12:12:09 -07:00
Sean Corfield
5cadd9248b Improve migration docs for with-transaction 2019-07-16 12:36:19 -07:00
Sean Corfield
8e4ef3033c Note :none as possible value for :host 2019-07-15 13:51:23 -07:00
Sean Corfield
7306e5ed3a Prep for 1.0.2 release 2019-07-15 13:45:00 -07:00
Sean Corfield
44dba4f29c Fixes #46 by allowing :host :none
Also adds `:dbname-separator` and `:host-prefix` for fine-grained 
control over the JDBC URL format.
2019-07-11 15:43:49 -07:00
Sean Corfield
e361f875c1 Add sections to make Getting Started easier to navigate 2019-07-11 15:11:26 -07:00
Sean Corfield
79d6f5ef29 Improve documentation around :dbtype
Expose `next.jdbc.connection/dbtypes` which is a table of all known 
`:dbtype` values and their driver class names, ports, etc.
2019-07-10 11:54:13 -07:00
Sean Corfield
29d46439e6 Fixes #40 by adding next.jdbc.prepare/execute-batch! 2019-07-09 16:00:10 -07:00
Sean Corfield
7184ef996c Fixes #41; Addresses #40; Expand prepared statement documentation
* Combine adjacent `with-open` calls.
* Show how `set-parameters` is used.
* Add a section on batched parameters, with their caveats, and how to 
use them.
2019-07-08 20:48:56 -07:00
Sean Corfield
67f39638a0 Updated insert-multi! doc page to match docstring 2019-07-08 17:22:53 -07:00
Sean Corfield
89af17ef31 Prep for 1.0.1 release 2019-07-03 20:30:29 -07:00
Sean Corfield
1fe7e92df2 Fixes #34 by adding save point tests
And updating the Transactions documentation to show save point examples.
2019-07-02 18:36:00 -07:00
Sean Corfield
1cec0a2643 Fixes #37; Fixes #36
* Fix `with-transaction` spec and how it invokes `transact` when no 
options map is provided.
* Adds type hint to `with-transaction`.
* Document manual rollback of transactions.
2019-07-02 16:45:48 -07:00
Sean Corfield
85eba1bb2f Fixes #35 by documenting the DB-specific insert multi options 2019-06-28 19:18:26 -07:00
Sean Corfield
9280b9ab47 Correct code reference 2019-06-12 22:03:26 -07:00
Sean Corfield
5448d49d74 Prep for 1.0.0 gold release 2019-06-12 21:49:09 -07:00
Sean Corfield
a09612cebe Some doc clarifications 2019-06-08 18:11:16 -07:00
Sean Corfield
22a3f2bb5f Fix #26 by adding datafiable-result-set
This makes handling metadata result sets much easier.
2019-06-08 15:09:42 -07:00
Sean Corfield
88fcaa5869 Add example of custom naming via result set builder 2019-06-06 09:48:00 -07:00
Sean Corfield
8405193209 Improve migration docs 2019-06-04 18:39:18 -07:00
Sean Corfield
3b5bfc6d17 Prep for 1.0.0-rc1 release 2019-06-04 18:03:44 -07:00
Sean Corfield
b64fbf35ff Fix #30 by adding modified builders
Adds `:label-fn` and `:qualifier-fn` options, and `as-modified-*` 
builder variants.
2019-06-04 18:01:19 -07:00
Sean Corfield
c833287270
Merge pull request #28 from jameslintaylor/master
Correct documentation for `transact` and `with-transaction`
2019-06-03 09:37:02 -06:00
Sooheon Kim
cbcd419672
Tiny typo in docs 2019-06-02 21:20:14 -07:00
jet
df1c38c03f Correct documentation for transact and with-transaction
Previously both functions were documented as taking a `Connectable`
object. This amends the documentation as well as the fn signature to
take a `Transactable` object.
2019-06-02 12:07:01 -04:00
Sean Corfield
a43c2876d3 Attempt to clarify differences in option handling 2019-05-25 21:14:29 -07:00
Sean Corfield
d4e5ed6ee4 Correct :as-arrays? migration note 2019-05-25 19:19:19 -07:00
Sean Corfield
6a9df0f4aa Fix #22 by adding next.jdbc.optional
Includes four `as*maps` builders that omit `NULL` columns completely 
from the returned row hash maps.
2019-05-25 19:16:30 -07:00
Sean Corfield
de0afef813 Prepare for Beta 1
Primarily a documentation update pass, since the code changes were 
already made.
2019-05-24 16:54:10 -07:00
Sean Corfield
a32c5b9e66 Address #16 by renaming reducible! to plan for Beta 1 2019-05-22 16:22:14 -07:00
Sean Corfield
146539528a Include spec support in Getting Started for #21 2019-05-21 22:17:35 -07:00
Sean Corfield
45f25d1912 Clean up and small doc improvements 2019-05-10 14:17:49 -07:00
Sean Corfield
ff94962e27 Fixes #18 by cleaning up connection properties better. 2019-05-04 23:59:48 -07:00
Sean Corfield
2d045b0c95 Alpha 12; fixes #17; improves docs 2019-04-26 22:46:42 -07:00
Sean Corfield
eb981d5726 Another pass over documentation and docstrings 2019-04-26 22:42:27 -07:00
Sean Corfield
ee2fcc47ab Fixes #17 by changing sql-string to sql-params 2019-04-26 10:34:26 -07:00
Sean Corfield
adc1abab8d Prep for 1.0.0-alpha11 release
cljdoc failed on alpha10 because `cljdoc.edn` had the wrong filename.
2019-04-24 16:05:03 -07:00
Sean Corfield
a216bfcb16 Prep for 1.0.0-alpha10 release 2019-04-24 15:57:20 -07:00
Sean Corfield
801061afa8 Document the datafy/nav/:schema stuff 2019-04-24 15:51:30 -07:00
Sean Corfield
cf75268087 Rename :gen-fn to :builder-fn 2019-04-24 14:22:35 -07:00
Sean Corfield
b5f0ef4daa Address #15 by documenting new option
The internal `:next.jdbc/sql-string` option is documented as passed into 
the builder functions.
2019-04-24 10:09:07 -07:00
Sean Corfield
13ad917864 Fix #15 by passing SQL string to builders
Adds internal `:next.jdbc/sql-string` option.
2019-04-24 10:07:52 -07:00
Sean Corfield
c43d7f1486 Switch internal links (now that cljdoc has fixed its bug) 2019-04-22 21:18:32 -07:00
Sean Corfield
2c018654d3 Alpha 9; fixes #14; improves protocol docstrings
* Move documentation from `ns` into `defprotocol` and the method 
declarations.
* Indicate which protocols may be extended via metadata 
(`SettableParameter` and `Sourceable`).
2019-04-22 17:41:31 -07:00
Sean Corfield
e091321696 Alpha 8; with correct Getting Started instructions! 2019-04-21 18:19:08 -07:00
Sean Corfield
afb62a2884 Fix artifact name in the docs! Doh! 2019-04-21 18:18:10 -07:00
Sean Corfield
f4eefbaeac Final doc cleanup prior to initial public announcement 2019-04-21 18:08:09 -07:00
Sean Corfield
f4573f5f95 Alpha 7; clean up deps
If this also fixes the cljdoc issues, I think we'll be ready for an 
announcement on Monday!
2019-04-21 17:37:22 -07:00
Sean Corfield
a0e5c6017a More doc file renaming for cljdoc
Filenames now match the names in the EDN file so that should make life 
simpler!
2019-04-21 17:25:01 -07:00
Sean Corfield
d05462895f Alpha 6; expand testing to multiple DB types
Now tests: Derby, H2 in-memory (as before), H2 on-disk, HSQLDB, and 
SQLite.
2019-04-21 17:12:43 -07:00
Sean Corfield
2badd9f835 Big docstring cleanup 2019-04-21 16:13:52 -07:00
Sean Corfield
8c51fc20e6 Rename doc files (to match URL versions); fix all doc links
It feels like it ought to be easier to link between docs and have them 
work on both GitHub and cljdoc!
2019-04-21 14:15:07 -07:00
Sean Corfield
03b09f6e03 Alpha 5; fixes #12 by adding :order-by option to for-query 2019-04-21 13:42:33 -07:00
Sean Corfield
cc0e33413d Add cljdoc badge; fix typo in EDN file 2019-04-21 13:12:21 -07:00
Sean Corfield
c2c798770a Alpha 4; fixes #11 by adding schema meta-quoting function 2019-04-21 13:00:03 -07:00
Sean Corfield
bdbf23a568 Document all (most!) of the differences from clojure.java.jdbc 2019-04-21 01:23:29 -07:00
Sean Corfield
6f637b4e36 Start documenting differences/migration more seriously 2019-04-21 00:48:16 -07:00
Sean Corfield
8564674653 Another attempt to satisfy cljdoc 2019-04-21 00:04:04 -07:00
Sean Corfield
cba8ee7230 Correct SCM for cljdoc 2019-04-20 23:49:26 -07:00
Sean Corfield
c229fa28e0 Document all the options for the library! 2019-04-20 23:34:36 -07:00
Sean Corfield
ea7d42741b Note SettableParameter can be extended via metadata 2019-04-20 23:34:19 -07:00
Sean Corfield
2f03b73e2c Document transaction handling 2019-04-20 22:51:16 -07:00
Sean Corfield
d688e639d0 Document prepared statement handling 2019-04-20 22:28:21 -07:00
Sean Corfield
2ab35132a7 Document Result Set Builders
And sketch out the remaining documentation outline.
2019-04-20 22:00:40 -07:00
Sean Corfield
954ef5ad47 Add cljdoc config 2019-04-20 17:55:31 -07:00
Sean Corfield
4640da228a Document next.jdbc.sql namespace 2019-04-20 17:55:16 -07:00
Sean Corfield
3102e9a074 Fix typo in Getting Started 2019-04-20 17:53:59 -07:00
Sean Corfield
684521ab1e Initial Getting Started documentation 2019-04-20 16:03:32 -07:00
Sean Corfield
6e08557d92 Add docstrings to everything 2019-03-31 23:17:12 -07:00
Sean Corfield
a8c1c37cfd Baseline project setup 2019-01-07 20:38:58 -08:00