500625f0ec
* WIP * WIP - make test_model_definition tests pass * WIP - make test_model_methods pass * WIP - make whole test suit at least run - failing 49/443 tests * WIP fix part of the getting pydantic tests as types of fields are now kept in core schema and not on fieldsinfo * WIP fix validation in update by creating individual fields validators, failing 36/443 * WIP fix __pydantic_extra__ in intializing model, fix test related to pydantic config checks, failing 32/442 * WIP - fix enum schema in model_json_schema, failing 31/442 * WIP - fix copying through model, fix setting pydantic fields on through, fix default config and inheriting from it, failing 26/442 * WIP fix tests checking pydantic schema, fix excluding parent fields, failing 21/442 * WIP some missed files * WIP - fix validators inheritance and fix validators in generated pydantic, failing 17/442 * WIP - fix through models setting - only on reverse side of relation, but always on reverse side, failing 15/442 * WIP - fix through models setting - only on reverse side of relation, but always on reverse side, failing 15/442 * WIP - working on proper populating __dict__ for relations for new schema dumping, some work on openapi docs, failing 13/442 * WIP - remove property fields as pydantic has now computed_field on its own, failing 9/442 * WIP - fixes in docs, failing 8/442 * WIP - fix tests for largebinary schema, wrapped bytes fields fail in pydantic, will be fixed in pydantic-core, remaining is circural schema for related models, failing 6/442 * WIP - fix to pk only models in schemas * Getting test suites to pass (#1249) * wip, fixing tests * iteration, fixing some more tests * iteration, fixing some more tests * adhere to comments * adhere to comments * remove unnecessary dict call, re-add getattribute for testing * todo for reverse relationship * adhere to comments, remove prints * solve circular refs * all tests pass 🎉 * remove 3.7 from tests * add lint and type check jobs * reforat with ruff, fix jobs * rename jobs * fix imports * fix evaluate in py3.8 * partially fix coverage * fix coverage, add more tests * fix test ids * fix test ids * fix lint, fix docs, make docs fully working scripts, add test docs job * fix pyproject * pin py ver in test docs * change dir in test docs * fix pydantic warning hack * rm poetry call in test_docs * switch to pathlib in test docs * remove coverage req test docs * fix type check tests, fix part of types * fix/skip next part of types * fix next part of types * fix next part of types * fix coverage * fix coverage * fix type (bit dirty 🤷) * fix some code smells * change pre-commit * tweak workflows * remove no root from tests * switch to full python path by passing sys.executable * some small refactor in new base model, one sample test, change makefile * small refactors to reduce complexity of methods * temp add tests for prs against pydantic_v2 * remove all references to __fields__ * remove all references to construct, deprecate the method and update model_construct to be in line with pydantic * deprecate dict and add model_dump, todo switch to model_dict in calls * fix tests * change to union * change to union * change to model_dump and model_dump_json from dict and json deprecated methods, deprecate them in ormar too * finish switching dict() -> model_dump() * finish switching json() -> model_dump_json() * remove fully pydantic_only * switch to extra for payment card, change missed json calls * fix coverage - no more warnings internal * fix coverage - no more warnings internal - part 2 * split model_construct into own and pydantic parts * split determine pydantic field type * change to new field validators * fix benchmarks, add codspeed instead of pytest-benchmark, add action and gh workflow * restore pytest-benchmark * remove codspeed * pin pydantic version, restore codspeed * change on push to pydantic_v2 to trigger first one * Use lifespan function instead of event (#1259) * check return types * fix imports order, set warnings=False on json that passes the dict, fix unnecessary loop in one of the test * remove references to model's meta as it's now ormar config, rename related methods too * filter out pydantic serializer warnings * remove choices leftovers * remove leftovers after property_fields, keep only enough to exclude them in initialization * add migration guide * fix meta references * downgrade databases for now * Change line numbers in documentation (#1265) * proofread and fix the docs, part 1 * proofread and fix the docs for models * proofread and fix the docs for fields * proofread and fix the docs for relations * proofread and fix rest of the docs, add release notes for 0.20 * create tables in new docs src * cleanup old deps, uncomment docs publish on tag * fix import reorder --------- Co-authored-by: TouwaStar <30479449+TouwaStar@users.noreply.github.com> Co-authored-by: Goran Mekić <meka@tilda.center>
127 lines
3.6 KiB
Markdown
127 lines
3.6 KiB
Markdown
# Update data in database
|
|
|
|
Following methods and functions allow updating existing data in the database.
|
|
|
|
* `update(each: bool = False, **kwargs) -> int`
|
|
* `update_or_create(**kwargs) -> Model`
|
|
* `bulk_update(objects: List[Model], columns: List[str] = None) -> None`
|
|
|
|
|
|
* `Model`
|
|
* `Model.update()` method
|
|
* `Model.upsert()` method
|
|
* `Model.save_related()` method
|
|
|
|
|
|
* `QuerysetProxy`
|
|
* `QuerysetProxy.update_or_create(**kwargs)` method
|
|
|
|
## update
|
|
|
|
`update(each: bool = False, **kwargs) -> int`
|
|
|
|
QuerySet level update is used to update multiple records with the same value at once.
|
|
|
|
You either have to filter the QuerySet first or provide a `each=True` flag to update
|
|
whole table.
|
|
|
|
If you do not provide this flag or a filter a `QueryDefinitionError` will be raised.
|
|
|
|
Return number of rows updated.
|
|
|
|
```Python hl_lines="42-44"
|
|
--8<-- "../docs_src/queries/docs002.py"
|
|
```
|
|
|
|
!!!warning
|
|
Queryset needs to be filtered before updating to prevent accidental overwrite.
|
|
|
|
To update whole database table `each=True` needs to be provided as a safety switch
|
|
|
|
## update_or_create
|
|
|
|
`update_or_create(**kwargs) -> Model`
|
|
|
|
Updates the model, or in case there is no match in database creates a new one.
|
|
|
|
```Python hl_lines="40-48"
|
|
--8<-- "../docs_src/queries/docs003.py"
|
|
```
|
|
|
|
!!!note
|
|
Note that if you want to create a new object you either have to pass pk column
|
|
value or pk column has to be set as autoincrement
|
|
|
|
## bulk_update
|
|
|
|
`bulk_update(objects: List["Model"], columns: List[str] = None) -> None`
|
|
|
|
Allows to update multiple instance at once.
|
|
|
|
All `Models` passed need to have primary key column populated.
|
|
|
|
You can also select which fields to update by passing `columns` list as a list of string
|
|
names.
|
|
|
|
```python hl_lines="8"
|
|
# continuing the example from bulk_create
|
|
# update objects
|
|
for todo in todoes:
|
|
todo.completed = False
|
|
|
|
# perform update of all objects at once
|
|
# objects need to have pk column set, otherwise exception is raised
|
|
await ToDo.objects.bulk_update(todoes)
|
|
|
|
completed = await ToDo.objects.filter(completed=False).all()
|
|
assert len(completed) == 3
|
|
```
|
|
|
|
## Model methods
|
|
|
|
Each model instance have a set of methods to `save`, `update` or `load` itself.
|
|
|
|
###update
|
|
|
|
You can update models by updating your model attributes (fields) and calling `update()` method.
|
|
|
|
If you try to update a model without a primary key set a `ModelPersistenceError` exception will be thrown.
|
|
|
|
|
|
!!!tip
|
|
Read more about `update()` method in [models-update](../models/methods.md#update)
|
|
|
|
###upsert
|
|
|
|
It's a proxy to either `save()` or `update(**kwargs)` methods of a Model.
|
|
If the pk is set the `update()` method will be called.
|
|
|
|
!!!tip
|
|
Read more about `upsert()` method in [models-upsert][models-upsert]
|
|
|
|
###save_related
|
|
|
|
Method goes through all relations of the `Model` on which the method is called,
|
|
and calls `upsert()` method on each model that is **not** saved.
|
|
|
|
!!!tip
|
|
Read more about `save_related()` method in [models-save-related][models-save-related]
|
|
|
|
## QuerysetProxy methods
|
|
|
|
When access directly the related `ManyToMany` field as well as `ReverseForeignKey` returns the list of related models.
|
|
|
|
But at the same time it exposes subset of QuerySet API, so you can filter, create, select related etc related models directly from parent model.
|
|
|
|
### update_or_create
|
|
|
|
Works exactly the same as [update_or_create](./#update_or_create) function above but allows you to update or create related objects
|
|
from other side of the relation.
|
|
|
|
!!!tip
|
|
To read more about `QuerysetProxy` visit [querysetproxy][querysetproxy] section
|
|
|
|
[querysetproxy]: ../relations/queryset-proxy.md
|
|
[models-upsert]: ../models/methods.md#upsert
|
|
[models-save-related]: ../models/methods.md#save_related
|