From 22384b9daa7053c8a30ad93a74202be3205bf134 Mon Sep 17 00:00:00 2001 From: Sean Corfield Date: Sat, 13 Feb 2021 21:40:32 -0800 Subject: [PATCH] Fix links --- doc/clause-reference.md | 2 +- doc/cljdoc.edn | 1 + doc/getting-started.md | 15 +++++++++------ doc/postgresql.md | 4 ++++ 4 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 doc/postgresql.md diff --git a/doc/clause-reference.md b/doc/clause-reference.md index 29bad85..8b3cc38 100644 --- a/doc/clause-reference.md +++ b/doc/clause-reference.md @@ -114,7 +114,7 @@ the column name from the SQL keywords). Various function-like expressions can be specified, as shown in the example above, but allow things like `CHECK` for a 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 diff --git a/doc/cljdoc.edn b/doc/cljdoc.edn index 0326f74..643c7a6 100644 --- a/doc/cljdoc.edn +++ b/doc/cljdoc.edn @@ -5,5 +5,6 @@ ["SQL Clause Reference" {:file "doc/clause-reference.md"}] ["SQL Operator Reference" {:file "doc/operator-reference.md"}] ["SQL 'Special Syntax'" {:file "doc/special-syntax.md"}] + ["PostgreSQL Support" {:file "doc/postgresql.md"}] ["Extending HoneySQL" {:file "doc/extending-honeysql.md"}]] ["Differences from 1.x" {:file "doc/difference-from-1-x.md"}]]} diff --git a/doc/getting-started.md b/doc/getting-started.md index a4f155d..8655f02 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -110,7 +110,7 @@ Some "functions" are considered to be operators. In general, Operators can be strictly binary or variadic (most are strictly binary). 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: @@ -191,8 +191,8 @@ generally variadic and threadable: There is a helper function for every single clause that HoneySQL supports out of the box. In addition, there are helpers for `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), -examples of the latter appear in the [docs/clause-reference.md](Clause Reference)) +parts of the SQL DSL (examples of the former appear in the [README](README.md), +examples of the latter appear in the [Clause Reference](docs/clause-reference.md)) In addition to being variadic -- which often lets you omit one 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]"] ``` +Out of the box, as part of the extended ANSI SQL support, +HoneySQL supports quite a few [PostgreSQL extensions](docs/postgresql.md) + ## Format Options 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 [docs/clause-reference.md](Clause Reference). The full list 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 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 -[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 between 1.0 and 2.0](docs/differences-from-1-x.md) should help. diff --git a/doc/postgresql.md b/doc/postgresql.md new file mode 100644 index 0000000..e509f07 --- /dev/null +++ b/doc/postgresql.md @@ -0,0 +1,4 @@ +# PostgreSQL Support + +This section will document the PostgreSQL-specific +features that HoneySQL supports out of the box.