update readme, bump version
This commit is contained in:
46
README.md
46
README.md
@ -264,6 +264,52 @@ await news.posts.clear()
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Since version >=0.3.4 Ormar supports also queryset level delete and update statements
|
||||||
|
```python
|
||||||
|
import databases
|
||||||
|
import ormar
|
||||||
|
import sqlalchemy
|
||||||
|
|
||||||
|
database = databases.Database("sqlite:///db.sqlite")
|
||||||
|
metadata = sqlalchemy.MetaData()
|
||||||
|
|
||||||
|
class Book(ormar.Model):
|
||||||
|
class Meta:
|
||||||
|
tablename = "books"
|
||||||
|
metadata = metadata
|
||||||
|
database = database
|
||||||
|
|
||||||
|
id: ormar.Integer(primary_key=True)
|
||||||
|
title: ormar.String(max_length=200)
|
||||||
|
author: ormar.String(max_length=100)
|
||||||
|
genre: ormar.String(max_length=100, default='Fiction', choices=['Fiction', 'Adventure', 'Historic', 'Fantasy'])
|
||||||
|
|
||||||
|
await Book.objects.create(title='Tom Sawyer', author="Twain, Mark", genre='Adventure')
|
||||||
|
await Book.objects.create(title='War and Peace', author="Tolstoy, Leo", genre='Fiction')
|
||||||
|
await Book.objects.create(title='Anna Karenina', author="Tolstoy, Leo", genre='Fiction')
|
||||||
|
await Book.objects.create(title='Harry Potter', author="Rowling, J.K.", genre='Fantasy')
|
||||||
|
await Book.objects.create(title='Lord of the Rings', author="Tolkien, J.R.", genre='Fantasy')
|
||||||
|
|
||||||
|
# update accepts kwargs that are used to update queryset model
|
||||||
|
# all other arguments are ignored (argument names not in own model table)
|
||||||
|
await Book.objects.filter(author="Tolstoy, Leo").update(author="Lenin, Vladimir") # update all Tolstoy's books
|
||||||
|
all_books = await Book.objects.filter(author="Lenin, Vladimir").all()
|
||||||
|
assert len(all_books) == 2
|
||||||
|
|
||||||
|
# delete accepts kwargs that will be used in filter
|
||||||
|
# acting in same way as queryset.filter(**kwargs).delete()
|
||||||
|
await Book.objects.delete(genre='Fantasy') # delete all fantasy books
|
||||||
|
all_books = await Book.objects.all()
|
||||||
|
assert len(all_books) == 3
|
||||||
|
|
||||||
|
# queryset needs to be filtered before deleting to prevent accidental overwrite
|
||||||
|
# to update whole database table each=True needs to be provided as a safety switch
|
||||||
|
await Book.objects.update(each=True, genre='Fiction')
|
||||||
|
all_books = await Book.objects.filter(genre='Fiction').all()
|
||||||
|
assert len(all_books) == 3
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Data types
|
## Data types
|
||||||
|
|
||||||
The following keyword arguments are supported on all field types.
|
The following keyword arguments are supported on all field types.
|
||||||
|
|||||||
@ -26,7 +26,7 @@ class UndefinedType: # pragma no cover
|
|||||||
|
|
||||||
Undefined = UndefinedType()
|
Undefined = UndefinedType()
|
||||||
|
|
||||||
__version__ = "0.3.3"
|
__version__ = "0.3.4"
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"Integer",
|
"Integer",
|
||||||
"BigInteger",
|
"BigInteger",
|
||||||
|
|||||||
@ -28,7 +28,9 @@ class ModelTableProxy:
|
|||||||
@classmethod
|
@classmethod
|
||||||
def extract_db_own_fields(cls) -> set:
|
def extract_db_own_fields(cls) -> set:
|
||||||
related_names = cls._extract_related_names()
|
related_names = cls._extract_related_names()
|
||||||
self_fields = {name for name in cls.Meta.model_fields.keys() if name not in related_names}
|
self_fields = {
|
||||||
|
name for name in cls.Meta.model_fields.keys() if name not in related_names
|
||||||
|
}
|
||||||
return self_fields
|
return self_fields
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
@ -57,9 +59,9 @@ class ModelTableProxy:
|
|||||||
related_names = set()
|
related_names = set()
|
||||||
for name, field in cls.Meta.model_fields.items():
|
for name, field in cls.Meta.model_fields.items():
|
||||||
if (
|
if (
|
||||||
inspect.isclass(field)
|
inspect.isclass(field)
|
||||||
and issubclass(field, ForeignKeyField)
|
and issubclass(field, ForeignKeyField)
|
||||||
and not field.virtual
|
and not field.virtual
|
||||||
):
|
):
|
||||||
related_names.add(name)
|
related_names.add(name)
|
||||||
return related_names
|
return related_names
|
||||||
@ -71,9 +73,9 @@ class ModelTableProxy:
|
|||||||
related_names = set()
|
related_names = set()
|
||||||
for name, field in cls.Meta.model_fields.items():
|
for name, field in cls.Meta.model_fields.items():
|
||||||
if (
|
if (
|
||||||
inspect.isclass(field)
|
inspect.isclass(field)
|
||||||
and issubclass(field, ForeignKeyField)
|
and issubclass(field, ForeignKeyField)
|
||||||
and field.nullable
|
and field.nullable
|
||||||
):
|
):
|
||||||
related_names.add(name)
|
related_names.add(name)
|
||||||
return related_names
|
return related_names
|
||||||
@ -101,7 +103,7 @@ class ModelTableProxy:
|
|||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def resolve_relation_field(
|
def resolve_relation_field(
|
||||||
item: Union["Model", Type["Model"]], related: Union["Model", Type["Model"]]
|
item: Union["Model", Type["Model"]], related: Union["Model", Type["Model"]]
|
||||||
) -> Type[Field]:
|
) -> Type[Field]:
|
||||||
name = ModelTableProxy.resolve_relation_name(item, related)
|
name = ModelTableProxy.resolve_relation_name(item, related)
|
||||||
to_field = item.Meta.model_fields.get(name)
|
to_field = item.Meta.model_fields.get(name)
|
||||||
@ -127,12 +129,12 @@ class ModelTableProxy:
|
|||||||
for field in one.Meta.model_fields.keys():
|
for field in one.Meta.model_fields.keys():
|
||||||
current_field = getattr(one, field)
|
current_field = getattr(one, field)
|
||||||
if isinstance(current_field, list) and not isinstance(
|
if isinstance(current_field, list) and not isinstance(
|
||||||
current_field, ormar.Model
|
current_field, ormar.Model
|
||||||
):
|
):
|
||||||
setattr(other, field, current_field + getattr(other, field))
|
setattr(other, field, current_field + getattr(other, field))
|
||||||
elif (
|
elif (
|
||||||
isinstance(current_field, ormar.Model)
|
isinstance(current_field, ormar.Model)
|
||||||
and current_field.pk == getattr(other, field).pk
|
and current_field.pk == getattr(other, field).pk
|
||||||
):
|
):
|
||||||
setattr(
|
setattr(
|
||||||
other,
|
other,
|
||||||
|
|||||||
@ -16,13 +16,13 @@ if TYPE_CHECKING: # pragma no cover
|
|||||||
|
|
||||||
class QuerySet:
|
class QuerySet:
|
||||||
def __init__( # noqa CFQ002
|
def __init__( # noqa CFQ002
|
||||||
self,
|
self,
|
||||||
model_cls: Type["Model"] = None,
|
model_cls: Type["Model"] = None,
|
||||||
filter_clauses: List = None,
|
filter_clauses: List = None,
|
||||||
exclude_clauses: List = None,
|
exclude_clauses: List = None,
|
||||||
select_related: List = None,
|
select_related: List = None,
|
||||||
limit_count: int = None,
|
limit_count: int = None,
|
||||||
offset: int = None,
|
offset: int = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
self.model_cls = model_cls
|
self.model_cls = model_cls
|
||||||
self.filter_clauses = [] if filter_clauses is None else filter_clauses
|
self.filter_clauses = [] if filter_clauses is None else filter_clauses
|
||||||
@ -53,7 +53,7 @@ class QuerySet:
|
|||||||
pkname = self.model_cls.Meta.pkname
|
pkname = self.model_cls.Meta.pkname
|
||||||
pk = self.model_cls.Meta.model_fields[pkname]
|
pk = self.model_cls.Meta.model_fields[pkname]
|
||||||
if new_kwargs.get(pkname, ormar.Undefined) is None and (
|
if new_kwargs.get(pkname, ormar.Undefined) is None and (
|
||||||
pk.nullable or pk.autoincrement
|
pk.nullable or pk.autoincrement
|
||||||
):
|
):
|
||||||
del new_kwargs[pkname]
|
del new_kwargs[pkname]
|
||||||
return new_kwargs
|
return new_kwargs
|
||||||
@ -140,20 +140,23 @@ class QuerySet:
|
|||||||
self_fields = self.model_cls.extract_db_own_fields()
|
self_fields = self.model_cls.extract_db_own_fields()
|
||||||
updates = {k: v for k, v in kwargs.items() if k in self_fields}
|
updates = {k: v for k, v in kwargs.items() if k in self_fields}
|
||||||
if not each and not self.filter_clauses:
|
if not each and not self.filter_clauses:
|
||||||
raise QueryDefinitionError('You cannot update without filtering the queryset first. '
|
raise QueryDefinitionError(
|
||||||
'If you want to update all rows use update(each=True, **kwargs)')
|
"You cannot update without filtering the queryset first. "
|
||||||
|
"If you want to update all rows use update(each=True, **kwargs)"
|
||||||
|
)
|
||||||
expr = FilterQuery(filter_clauses=self.filter_clauses).apply(
|
expr = FilterQuery(filter_clauses=self.filter_clauses).apply(
|
||||||
self.table.update().values(**updates)
|
self.table.update().values(**updates)
|
||||||
)
|
)
|
||||||
# print(expr.compile(compile_kwargs={"literal_binds": True}))
|
|
||||||
return await self.database.execute(expr)
|
return await self.database.execute(expr)
|
||||||
|
|
||||||
async def delete(self, each: bool = False, **kwargs: Any) -> int:
|
async def delete(self, each: bool = False, **kwargs: Any) -> int:
|
||||||
if kwargs:
|
if kwargs:
|
||||||
return await self.filter(**kwargs).delete()
|
return await self.filter(**kwargs).delete()
|
||||||
if not each and not self.filter_clauses:
|
if not each and not self.filter_clauses:
|
||||||
raise QueryDefinitionError('You cannot delete without filtering the queryset first. '
|
raise QueryDefinitionError(
|
||||||
'If you want to delete all rows use delete(each=True)')
|
"You cannot delete without filtering the queryset first. "
|
||||||
|
"If you want to delete all rows use delete(each=True)"
|
||||||
|
)
|
||||||
expr = FilterQuery(filter_clauses=self.filter_clauses).apply(
|
expr = FilterQuery(filter_clauses=self.filter_clauses).apply(
|
||||||
self.table.delete()
|
self.table.delete()
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user