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

fix/improve limit, offset, fetch docs

Browse source
This commit is contained in:
Sean Corfield 2021-07-17 18:49:11 -07:00
parent 01c3a555ba
commit 13044d7394
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/clause-reference.md
View file

@ -750,12 +750,23 @@ user=> (sql/format {:select [:id :name]
user=> (sql/format {:select [:id :name] user=> (sql/format {:select [:id :name]
:from [:table] :from [:table]
:offset 20 :fetch 10}) :offset 20 :fetch 10})
["SELECT id, name FROM table OFFSET ? FETCH ? ONLY" 20 10] ["SELECT id, name FROM table OFFSET ? ROWS FETCH NEXT ? ROWS ONLY" 20 10]
``` ```
All three are available in all dialects for HoneySQL so it All three are available in all dialects for HoneySQL so it
is up to you to choose the correct pair for your database. is up to you to choose the correct pair for your database.
If you use `:offset` and `:limit` together, `OFFSET` will just have
the number of rows. If you use `:offset` and `:fetch` together,
`OFFSET` will have the number of rows and the `ROWS` keyword. If
you use `:offset` on its own, it will have just the number
of rows, unless you have the `:sqlserver` dialect selected,
it which case it will have the `ROWS` keywords as well.
_This seemed to be the least risky change in 2.0.0 RC 5 to avoid introducing a breaking change._
If the number of rows is one, `ROW` will be used instead of `ROWS`.
If `:fetch` is specified without `:offset`, `FIRST` will be used instead of `NEXT`.
## for ## for
The `:for` clause accepts either a single item -- the lock The `:for` clause accepts either a single item -- the lock