[12.x] Add support for query-level comments #57519
Closed
+95
−22
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.
This PR adds a new method to the database query builder class:
comment(), which enables a user-defined comment string to be appended to the end of a query.For example, executing
DB::from('users)->comment('Getting all users')->get();generates the following query:Why?
Too many times, while looking at running queries in a specific database instance, I wanted to have a quick way to know where a given query is being executed. I thought that a simple comment could allow for that little extra context on where it's running, much like code comments.
I honestly don't know if all other database engines strip away these comments, but the one I use the most (MySQL) seems to show this information when running
show full processlist.Docs
If this PR gets merged, I'll open a PR to update the docs.