📝 Update Primary Key notes for the SQL databases tutorial to avoid confusion #14120
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
Hi @FlaviusRaducu thank you for taking the time to submit the improvement. I think you're right in saying that section should be more explicit in why that type signature is required. I feel however you could reword the submission to make it read less "staccato" that is less of an edit and more like something that was always there. As an example, Copilot suggest re-wording the paragraph likes so: Declaring the type as int | None tells SQLModel that the column should be an INTEGER in the SQL database and that it can be NULL. However, in practice, the id column is always required and cannot be NULL—so why use int | None? The reason is that although the id is mandatory in the database, it's not provided by our code. Instead, it's automatically generated by the database itself. |
📝 Docs previewLast commit 237ce55 at: https://349bafed.fastapitiangolo.pages.dev Modified Pages |
tiangolo
changed the title
* Sync with #14217 * Sync with #14359 * Sync with #13786 * Sync with #14070 * Sync with #14120 * Sync with #14211 * Sync with #14405 * "to deploy" -> "deployen" The LLM used that translation a lot ithis convinced me that "deployen" it is the better word. "bereitstellen" (or "ausliefern") is still used for "to serve". --------- Co-authored-by: Motov Yurii <[email protected]> Co-authored-by: Yurii Motov <[email protected]>
4 participants
For developers unfamiliar with
SQLModel( might be just me though :) ) creating a nullable primary key can be quite confusing when reading this tutorial section.I believe, adding a bit more information resolves that initial confusion.
The extra comments have been taken from the official SQLModel docs.