Use Heredocs for multiline SQL #147
Merged
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
| @@ -658,6 +658,32 @@ when you need to retrieve a single record by some attributes. | |||
| # good | |||
| User.where.not(id: id) | |||
| ``` | |||
| * <a name="squished-heredocs"</a> | |||
There was a problem hiding this comment.
I believe you're missing a > from the link.
kurtzur
force-pushed
the
squished-heredocs
branch
2 times, most recently
from
fc8989d
to
d8d8463
Compare
|
+1 for this pull request. Readability greatly increases, and you can better follow the flow of the query. A couple weeks ago I had to write a long query, but kept it as a normal string, because I did not know about heredocs. |
kurtzur
force-pushed
the
squished-heredocs
branch
from
d8d8463
to
a4c7a31
Compare
|
👍 |
1 similar comment
|
👍 |
| SQL | ||
| ``` | ||
|
|
||
| `squish` removes the indentation and newline characters so that your server |
There was a problem hiding this comment.
Maybe this should be String#squish and be a link to the docs (which might outdated, though).
|
Looks good overall. I'd just suggest capitalising the commit message and making it a bit more specific, as it's pretty generic right now. |
kurtzur
force-pushed
the
squished-heredocs
branch
from
a4c7a31
to
b139a49
Compare
|
@bbatsov done |
|
Perfect! Thanks! |
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.
I didn't see anything in this guide covering the format of multiline SQL strings used with methods like
find_by_sqlorActiveRecord::Base.connection.execute. I know the preferred approach is to use ActiveRecord helpers, but as even the Rails guides themselves admit, this isn't always sufficient. As such, I decided to include the practice we currently follow at OneLogin.The content I added is pretty self-explanatory, but we use heredocs because they're recommended for multiline strings and enable SQL syntax highlighting in many tools. Because the indentations and line breaks are only meant for readers of the source, the heredoc is immediately followed by
squishto suppress any extra characters in server logs.