More doc file renaming for cljdoc
Filenames now match the names in the EDN file so that should make life simpler!
This commit is contained in:
parent
e9e5f9f01f
commit
a0e5c6017a
8 changed files with 18 additions and 18 deletions
12
README.md
12
README.md
|
|
@ -8,7 +8,7 @@ The next generation of `clojure.java.jdbc`: a new low-level Clojure wrapper for
|
|||
|
||||
|
||||
* [Getting Started](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started)
|
||||
* [Migrating from `clojure.java.jdbc`](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/differences)
|
||||
* [Migrating from `clojure.java.jdbc`](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/migration-from-clojure-java-jdbc)
|
||||
* Feedback via [issues](https://github.com/seancorfield/next-jdbc/issues) or in the [`#sql` channel on the Clojurians Slack](https://clojurians.slack.com/messages/C1Q164V29/details/) or the [`#sql` stream on the Clojurians Zulip](https://clojurians.zulipchat.com/#narrow/stream/152063-sql).
|
||||
|
||||
## Motivation
|
||||
|
|
@ -62,12 +62,12 @@ In addition, convenience functions -- "syntactic sugar" -- are provided to inser
|
|||
## More Detailed Documentation
|
||||
|
||||
* [Getting Started](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started)
|
||||
* [Friendly SQL Functions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/friendly-sql-fns)
|
||||
* [Row and Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/rs-builders)
|
||||
* [Prepared Statements](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/prepared-stmt)
|
||||
* [Friendly SQL Functions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/friendly-sql-functions)
|
||||
* [Row and Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders)
|
||||
* [Prepared Statements](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/prepared-statements)
|
||||
* [Transactions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions)
|
||||
* [All The Options](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/options)
|
||||
* [Migration from `clojure.java.jdbc`](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/differences)
|
||||
* [All The Options](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/all-the-options)
|
||||
* [Migration from `clojure.java.jdbc`](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/migration-from-clojure-java-jdbc)
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -60,4 +60,4 @@ The `transact` function and `with-transaction` macro accept the following option
|
|||
* `:read-only` -- a `Boolean` that indicates whether the transaction should be read-only or not (the default),
|
||||
* `:rollback-only` -- a `Boolean` that indicates whether the transaction should commit on success (the default) or rollback.
|
||||
|
||||
[<: Transaction](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions) | [Migration from `clojure.java.jdbc` :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/differences)
|
||||
[<: Transaction](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions) | [Migration from `clojure.java.jdbc` :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/migration-from-clojure-java-jdbc)
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
{:cljdoc.doc/tree [["Readme" {:file "README.md"}]
|
||||
["Getting Started" {:file "doc/getting-started.md"}
|
||||
["Friendly SQL Functions" {:file "doc/friendly-sql-fns.md"}]
|
||||
["Result Set Builders" {:file "doc/rs-builders.md"}]
|
||||
["Prepared Statements" {:file "doc/prepared-stmt.md"}]
|
||||
["Friendly SQL Functions" {:file "doc/friendly-sql-functions.md"}]
|
||||
["Result Set Builders" {:file "doc/result-set-builders.md"}]
|
||||
["Prepared Statements" {:file "doc/prepared-statements.md"}]
|
||||
["Transactions" {:file "doc/transactions.md"}]]
|
||||
["All The Options" {:file "doc/options.md"}]
|
||||
["Migration from clojure.java.jdbc" {:file "doc/differences.md"}]]}
|
||||
["All The Options" {:file "doc/all-the-options.md"}]
|
||||
["Migration from clojure.java.jdbc" {:file "doc/migration-from-clojure-java-jdbc.md"}]]}
|
||||
|
|
|
|||
|
|
@ -152,4 +152,4 @@ These quoting functions can be provided to any of the friendly SQL functions abo
|
|||
|
||||
Note that the entity naming function is passed a string, the result of calling `name` on the keyword passed in. Also note that the default quoting functions do not handle schema-qualified names, such as `dbo.table_name` -- `sql-server` would produce `[dbo.table_name]` from that. Use the `schema` function to wrap the quoting function if you need that behavior, e.g,. `{:table-fn (schema sql-server)}` which would produce `[dbo].[table_name]`.
|
||||
|
||||
[<: Getting Started](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started) | [Row and Result Set Builders :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/rs-builders)
|
||||
[<: Getting Started](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started) | [Row and Result Set Builders :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders)
|
||||
|
|
@ -56,4 +56,4 @@ These are mostly drawn from Issue #5 although most of the bullets in that issue
|
|||
* `with-transaction` can take a `:rollback-only` option, but there is no way to change a transaction to rollback _dynamically_; throw an exception instead (all transactions roll back on an exception)
|
||||
* The extension points for setting parameters and reading columns are now `SettableParameter` and `ReadableColumn` protocols.
|
||||
|
||||
[<: All The Options](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/options)
|
||||
[<: All The Options](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/all-the-options)
|
||||
|
|
@ -30,4 +30,4 @@ This can be extended to any Clojure data type, to provide a customized way to ad
|
|||
|
||||
If you need more specialized parameter handling than the protocol can provide, then you can create prepared statements explicitly, instead of letting `next.jdbc` do it for you, and then calling your own variant of `set-parameters` to install those parameters.
|
||||
|
||||
[<: Row and Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/rs-builders) | [Transactions :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions)
|
||||
[<: Row and Result Set Builders](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/result-set-builders) | [Transactions :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/transactions)
|
||||
|
|
@ -50,4 +50,4 @@ Common extensions here could include converting `java.sql.Timestamp` to `java.ti
|
|||
|
||||
Note that the converse, converting Clojure values to database-specific types is handled by the `SettableParameters`, discussed in the next section (Prepared Statements).
|
||||
|
||||
[<: Friendly SQL Functions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/friendly-sql-functions) | [Prepared Statements :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/prepared-stmt)
|
||||
[<: Friendly SQL Functions](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/friendly-sql-functions) | [Prepared Statements :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/prepared-statements)
|
||||
|
|
@ -18,10 +18,10 @@ It is possible to tell `next.jdbc` to create connections that do not automatical
|
|||
|
||||
You can also provide an options map as the third element of the binding vector (or the third argument to the `transact` function). The following options are supported:
|
||||
|
||||
* `:isolation` -- the isolation level for this transaction (see [All The Options](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/options) for specifics),
|
||||
* `:isolation` -- the isolation level for this transaction (see [All The Options](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/all-the-options) for specifics),
|
||||
* `:read-only` -- set the transaction into read-only mode (if `true`),
|
||||
* `:rollback-only` -- set the transaction to always rollback, even on success (if `true`).
|
||||
|
||||
The latter can be particularly useful in tests, to run a series of SQL operations during a test and then roll them all back at the end.
|
||||
|
||||
[<: Prepared Statements](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/prepared-stmt) | [All The Options :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/options)
|
||||
[<: Prepared Statements](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/getting-started/prepared-statements) | [All The Options :>](https://cljdoc.org/d/seancorfield/next.jdbc/CURRENT/doc/all-the-options)
|
||||
|
|
|
|||
Loading…
Reference in a new issue