Opened 4 hours ago
Last modified 2 hours ago
#35786 new Bug
AddField reference to Django's support for database defaults is outdated
| Reported by: | Václav Řehák | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 5.1 |
| Severity: | Normal | Keywords: | db_default |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The docs of AddField at https://docs.djangoproject.com/en/dev/ref/migration-operations/#addfield says
It does not affect the behavior of setting defaults in the database directly - Django never sets database defaults and always applies them in the Django ORM code.
I think this wording is confusing because since adding db_default Django ORM actually does set db defaults. The same sentence is present in AlterField docs.
Change History (2)
comment:1 by , 3 hours ago
comment:2 by , 2 hours ago
| Keywords: | db_default added |
|---|---|
| Summary: | Incorrect info about database defaults in migrations doc → AddField reference to Django's support for database defaults is outdated |
| Triage Stage: | Unreviewed → Accepted |
Nice catch!
Note:
See TracTickets
for help on using tickets.
Btw, there was already a comment about this 8 years ago, see https://code.djangoproject.com/ticket/26476#comment:3
"arguably, the documentation is not clear enough; what is meant is that Django never leaves defaults in the database."