Minor clarifications #29
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TehShrike
reviewed
Feb 24, 2023
| @@ -139,7 +139,7 @@ Every clause method returns a new immutable `q` query object. | |||
|
|
|||
| `expression` strings are inserted without being parameterized, but you can also pass in [tagged template strings](#tagged-template-strings) to do anything special. | |||
|
|
|||
| All `value`s are automatically parameterized. If a `value` is `NULL` it will be automatically compared with `IS`, and if it's an array it will be automatically compared with `IN()`: | |||
| If a `value` is `NULL` it will be automatically compared with `IS`, and if it's an array it will be automatically compared with `IN()`. Otherwise, it will be compared with `=`. | |||
There was a problem hiding this comment.
I think this is more what I meant
Suggested change
| If a `value` is `NULL` it will be automatically compared with `IS`, and if it's an array it will be automatically compared with `IN()`. Otherwise, it will be compared with `=`. | |
| All `value`s will be automatically escaped. If a `value` is `NULL` it will be automatically compared with `IS`, and if it's an array it will be automatically compared with `IN()`. Otherwise, it will be compared with `=`. |
TehShrike
reviewed
Feb 24, 2023
| @@ -156,7 +156,7 @@ whereInResult.sql // => whereInQuery | |||
| whereInResult.values // => [ [ 'fancy', 'boring' ] ] | |||
| ``` | |||
|
|
|||
| Put another way, calling `q.select('column1, column2')` is just as acceptable as calling `q.select('column1', 'column2')` and you should use whichever you prefer. | |||
| All `value`s are automatically parameterized. Put another way, calling `q.select('column1, column2')` is just as acceptable as calling `q.select('column1', 'column2')` and you should use whichever you prefer. | |||
There was a problem hiding this comment.
"parameterized" isn't terribly clear but I meant to be talking about the arguments I called value in the functions above, not the expression arguments I talked about in this paragraph for something like select.
TehShrike
reviewed
Feb 24, 2023
Comment on lines
+128
to
+133
| - `q.where(expression, [[comparator], value])` | ||
| - `q.orWhere(expression, [[comparator], value])` | ||
| - `q.whereLike(expression, value)` | ||
| - `q.orWhereLike(expression, value)` | ||
| - `q.having(expression, [comparator, [value]])` | ||
| - `q.orHaving(expression, [comparator, [value]])` | ||
| - `q.having(expression, [[comparator], value])` | ||
| - `q.orHaving(expression, [[comparator], value])` |
There was a problem hiding this comment.
oh yeah that is what I meant...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A few parts in the README looked incorrect/improvable.