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

Fix links

Browse source
This commit is contained in:
Sean Corfield 2021-02-13 21:40:32 -08:00
parent 38da6f567b
commit 22384b9daa
4 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/clause-reference.md
View file

@ -114,7 +114,7 @@ the column name from the SQL keywords).
Various function-like expressions can be specified, as shown Various function-like expressions can be specified, as shown
in the example above, but allow things like `CHECK` for a in the example above, but allow things like `CHECK` for a
constraint, `FOREIGN KEY` (with a column name), `REFERENCES` constraint, `FOREIGN KEY` (with a column name), `REFERENCES`
(with a pair of column names). See [special-syntax.md#clause-descriptors](Clause Descriptors in Special Syntax) for more details. (with a pair of column names). See [Clause Descriptors in Special Syntax](special-syntax.md#clause-descriptors) for more details.
## create-view ## create-view

1
doc/cljdoc.edn
View file

@ -5,5 +5,6 @@
["SQL Clause Reference" {:file "doc/clause-reference.md"}] ["SQL Clause Reference" {:file "doc/clause-reference.md"}]
["SQL Operator Reference" {:file "doc/operator-reference.md"}] ["SQL Operator Reference" {:file "doc/operator-reference.md"}]
["SQL 'Special Syntax'" {:file "doc/special-syntax.md"}] ["SQL 'Special Syntax'" {:file "doc/special-syntax.md"}]
["PostgreSQL Support" {:file "doc/postgresql.md"}]
["Extending HoneySQL" {:file "doc/extending-honeysql.md"}]] ["Extending HoneySQL" {:file "doc/extending-honeysql.md"}]]
["Differences from 1.x" {:file "doc/difference-from-1-x.md"}]]} ["Differences from 1.x" {:file "doc/difference-from-1-x.md"}]]}

15
doc/getting-started.md
View file

@ -110,7 +110,7 @@ Some "functions" are considered to be operators. In general,
Operators can be strictly binary or variadic (most are strictly binary). Operators can be strictly binary or variadic (most are strictly binary).
Special syntax can have zero or more arguments and each form is Special syntax can have zero or more arguments and each form is
described in the [docs/special-syntax.md](Special Syntax) section. described in the [Special Syntax](docs/special-syntax.md) section.
Some examples: Some examples:
@ -191,8 +191,8 @@ generally variadic and threadable:
There is a helper function for every single clause that HoneySQL There is a helper function for every single clause that HoneySQL
supports out of the box. In addition, there are helpers for supports out of the box. In addition, there are helpers for
`composite` and `over` that make it easier to construct those `composite` and `over` that make it easier to construct those
parts of the SQL DSL (examples of the former appear in the [README.md](README), parts of the SQL DSL (examples of the former appear in the [README](README.md),
examples of the latter appear in the [docs/clause-reference.md](Clause Reference)) examples of the latter appear in the [Clause Reference](docs/clause-reference.md))
In addition to being variadic -- which often lets you omit one In addition to being variadic -- which often lets you omit one
level of `[`..`]` -- the helper functions merge clauses, which level of `[`..`]` -- the helper functions merge clauses, which
@ -277,6 +277,9 @@ specify a dialect in the `format` call, you can specify
;;=> ["SELECT [id] FROM [table]"] ;;=> ["SELECT [id] FROM [table]"]
``` ```
Out of the box, as part of the extended ANSI SQL support,
HoneySQL supports quite a few [PostgreSQL extensions](docs/postgresql.md)
## Format Options ## Format Options
In addition to the `:quoted` and `:dialect` options described above, In addition to the `:quoted` and `:dialect` options described above,
@ -300,11 +303,11 @@ was wrapped in `[:inline `..`]`:
The full list of supported SQL clauses is documented in the The full list of supported SQL clauses is documented in the
[docs/clause-reference.md](Clause Reference). The full list [docs/clause-reference.md](Clause Reference). The full list
of operators supported (as prefix-form "functions") is of operators supported (as prefix-form "functions") is
documented in the [docs/operator-reference.md](Operator Reference) documented in the [Operator Reference](docs/operator-reference.md)
section. The full list section. The full list
of "special syntax" functions is documented in the of "special syntax" functions is documented in the
[docs/special-syntax.md](Special Syntax) section. The best [Special Syntax](docs/special-syntax.md) section. The best
documentation for the helper functions is the documentation for the helper functions is the
[honey.sql.helpers](https://cljdoc.org/d/seancorfield/honeysql/CURRENT/api/honey.sql.helpers). [https://cljdoc.org/d/seancorfield/honeysql/CURRENT/api/honey.sql.helpers](honey.sql.helpers).
If you're migrating to HoneySQL 2.0, this [overview of differences If you're migrating to HoneySQL 2.0, this [overview of differences
between 1.0 and 2.0](docs/differences-from-1-x.md) should help. between 1.0 and 2.0](docs/differences-from-1-x.md) should help.

4
doc/postgresql.md Normal file
View file

@ -0,0 +1,4 @@
# PostgreSQL Support
This section will document the PostgreSQL-specific
features that HoneySQL supports out of the box.