Skip to content

Commit c424c7f

Browse files
committed
Add :doc annotation for :duct.module/sql
1 parent 3e2a10f commit c424c7f

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

src/integrant/annotations.edn

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,17 @@
33
{jdbc-url
44
{:arg jdbc-url
55
:env JDBC_DATABASE_URL
6-
:doc "The JDBC database URL"}}}}
6+
:doc "The JDBC database URL"}}
7+
:doc
8+
"A module that adds components for accessing SQL databases to the
9+
configuration. Takes no options.
10+
11+
In the `:repl` profile, migrations are run using the `:rebase` strategy
12+
(conflicts replace existing migrations), while in the `:main` profile the
13+
`:raise-error` strategy is used (conflicts throw exceptions).
14+
15+
At the REPL, two functions are added to the `user` namespace:
16+
- `db` - get a `DataSource` of the running system's database
17+
- `sql` - run a SQL statement on the system's database
18+
19+
A Duct `jdbc-url` variable is added to configure the JDBC database URL."}}

0 commit comments

Comments
 (0)