luciano/honeysql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Address #332 by improving :cross-join docs

Browse source
This commit is contained in:
Sean Corfield 2021-07-17 14:49:18 -07:00
parent 679a0309db
commit 1836c7bcf1
2 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -1,5 +1,8 @@
# Changes # Changes
* 2.0.next (gold) in progress
* Address #332 by improving `:cross-join` documentation.
* 2.0.0-rc4 (for testing; 2021-07-17) * 2.0.0-rc4 (for testing; 2021-07-17)
* Fix #338 by adding `ONLY` to `:fetch`. * Fix #338 by adding `ONLY` to `:fetch`.
* Fix #337 by switching to `clojure.test` even for ClojureScript. * Fix #337 by switching to `clojure.test` even for ClojureScript.

19
doc/clause-reference.md
View file

@ -592,9 +592,24 @@ user=> (sql/format {:select [:t.ref :pp.code]
## cross-join ## cross-join
`:cross-join` accepts a single sequence argument that lists `:cross-join` accepts a single sequence argument that lists
one or more SQL entities. Each entity can either be a one or more SQL expressions. Each expression can either be a
simple table name (keyword or symbol) or a pair of a simple table name (keyword or symbol) or a pair of a
table name and an alias. table expression and an alias.
```clojure
user=> (sql/format {:select [:foo.id [:x.id :x_id] :x.value]
:cross-join [[[:lateral
[:jsonb_to_recordset :foo.json_value]]
[[:raw "x(id text, value jsonb)"]]]]
:from [:foo]})
["SELECT foo.id, x.id AS x_id, x.value FROM foo CROSS JOIN LATERAL JSONB_TO_RECORDSET(foo.json_value) x(id text, value jsonb)"]
```
Here, `:cross-join` has a one expression as its argument, which is a
table expression and an alias. The table expression is `[:lateral ..]`
and the alias expression is double-nested so that it is read as a
function call: an invocation of `:raw`.
> Note: the actual formatting of a `:cross-join` clause is currently identical to the formatting of a `:select` clause. > Note: the actual formatting of a `:cross-join` clause is currently identical to the formatting of a `:select` clause.