docs(macros): document that bind parameter nullability is not compile-checked#4345
Open
jeremie0342 wants to merge 1 commit into
Open
docs(macros): document that bind parameter nullability is not compile-checked#4345jeremie0342 wants to merge 1 commit into
jeremie0342 wants to merge 1 commit into
Conversation
…-checked Restructures the "Nullability: Bind Parameters" section of the query! macro documentation to state upfront that the nullability of bind parameters is not verified at compile time, why (SQLx does not parse SQL), and give the concrete example from transact-rs#2642. The previous phrasing understated the limitation and hid it behind guidance about WHERE clauses, which is now demoted to a sub-section. Closes transact-rs#2642
This file contains hidden or 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
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.
What
Restructures the
## Nullability: Bind Parameterssection in thequery!macro documentation (src/macros/mod.rs).Why
Users regularly report the same confusion (e.g. #2642): they write
sqlx::query!("INSERT INTO foo (data) VALUES (\$1)", None::<String>)against aNOT NULLcolumn, expecting a compile-time error, and are surprised when the code compiles but fails at runtime.The existing section technically covered this (
Option::None will be bound as NULL, so ... be sure your query can support it), but the phrasing understated the limitation and hid it behind guidance aboutWHEREclauses.What changed
WHEREclause /NULLcomparisons is preserved as a sub-section (### Bind parameters in WHERE clauses).Scope
src/macros/mod.rscargo doc -p sqlx --no-depsproduces no new warnings in the edited rangeCloses #2642