在 ORM 框架中,所有模型相关的操作,比如添加/删除等,其实都是映射到数据库中一条数据的操作,因此模型操作也就是数据库表中数据的操作。
首先需要创建一个模型。添加模型到数据库中。
from django.db import models
# Create your models here.
class User(models.Model):
username = models.CharField(max_length=20)
password = models.CharField(max_length=100)
# 表一对一,用户表和用户信息表, 常用和不常用
class UserExtension(models.Model):
birthday = models.DateTimeField()
university = models.CharField(max_length=200)
user = models.OneToOneField("User", on_delete=models.CASCADE)
class Article(models.Model):
title = models.CharField(max_length=100)
content = models.TextField()
pub_time = models.DateTimeField(auto_now_add=True, null=True)
author = models.ForeignKey(
"User", on_delete=models.SET_DEFAULT, default=1, related_name="articles"
)
tags = models.ManyToManyField("Tag", related_name="articles")
class Tag(models.Model):
name = models.CharField(max_length=100)
class Comment(models.Model):
content = models.TextField()
origin_comment = models.ForeignKey("self", on_delete=models.CASCADE, null=True)
添加一个模型实例到数据库中
添加模型到数据库中,首先需要创建一个模型,创建模型的方式很简单,就跟创建普通的 Python 对象是一摸一样的。
在创建完模型之后,需要调用模型的 save 方法,这样 Django 会自动的将这个模型转换成sql 语句,然后存储到数据库中。
from django.shortcuts import HttpResponse
def add_user(request):
user = User(username="xiaoming", password="111111")
# 调用save()方法:是将模型对象的数据保存到数据库表中,即在数据库表中插入一条新的记录。
user.save()
return HttpResponse(f"用户 {user.username} 添加成功!")
执行访问以上视图函数 add_user
就会往User
这个表里面添加一条数据
二次添加或者更新数据,比如创建用户时没创建UserExtension
表里的数据
from django.shortcuts import HttpResponse
from django.utils import timezone
from .models import User, UserExtension
def add_user_extension(request):
# 获取已经存在的用户
try:
user = User.objects.get(username="xiaoming")
except User.DoesNotExist:
return HttpResponse("用户 xiaoming 不存在。")
# 准备要添加的扩展信息数据
birthday = "2024-08-01"
university = "Example University"
# 创建或更新 UserExtension 数据
user_extension, created = UserExtension.objects.get_or_create(
user=user,
defaults={'birthday': birthday, 'university': university}
)
if not created:
# UserExtension 已经存在,更新数据
user_extension.birthday = birthday
user_extension.university = university
user_extension.save()
return HttpResponse(f"用户 {user.username} 的扩展信息已更新。")
return HttpResponse(f"用户 {user.username} 的扩展信息已添加。")
get_or_create()
:尝试在数据库中获取一个匹配的对象。如果找到了对象,返回该对象和一个布尔值 False
,表示对象不是新创建的。
如果没有找到对象,创建一个新的对象并保存到数据库中,然后返回该对象和一个布尔值 True
,表示对象是新创建的。
user=user
:左边的 user
是 UserExtension
模型中的字段。右边的 user
是你在代码中获取或创建的 User
对象,这行代码的意思是在 UserExtension
表中查找 user
字段等于指定 User
对象的记录。
efaults={'birthday': birthday, 'university': university}
** **:
get_or_create
方法的一个参数,它用于在对象不存在时指定默认值。
defaults
: 这是一个字典,包含了一组键值对,用于在创建新对象时提供默认值。
'birthday': birthday
: 如果创建新对象,使用 birthday
变量的值作为 birthday
字段的默认值。
user_extension, created = ...
:这行代码将 get_or_create
方法的返回值解包为两个变量:
user_extension
: 这是获取到的或新创建的 UserExtension
对象。
created
: 这是一个布尔值,如果对象是新创建的,则为 True
,否则为 False
查找数据
查找数据都是通过模型下的 objects
对象来实现的。
查找所有数据
要查找 User
这个模型对应的表下的所有数据,使用.all()
将返回 模型下的所有数据。
users = User.objects.all()
数据过滤
在查找数据的时候,有时候需要对一些数据进行过滤。那么这时候需要调用 objects
的 filter
方法。
users = User.objects.filter(username="chixm")
for user in users:
print({user.username})
获取单个对象
objects.get
是 Django ORM 中用于从数据库中获取单个对象的方法。
它期望查询条件只返回一个对象,如果查询结果中没有对象或有多个对象,会抛出相应的异常。
用于获取符合条件的唯一对象,适用于查询结果唯一的情况。
user = User.objects.get(username="henry")
数据排序
在之前的例子中,数据都是无序的。如果你想在查找数据的时候使用某个字段来进行排序,那么可以使用 order_by 方法来实现。
users = User.objects.order_by("username")
以上代码在提取所有用户名数据的时候,将会使用 username
首字母从小到大进行排序。如果想要进行倒序排序,那么可以在 username
前面加一个负号。
users = User.objects.order_by("-username")
修改数据
在查找到数据后,便可以进行修改了。修改的方式非常简单,只需要将查找出来的对象的某个属性进行修改,然后再调用这个对象的 save 方法便可以进行修改。
def modify_user(request):
user = User.objects.get(id=1)
user.username = "ching"
user.save()
return HttpResponse("success!")
删除数据
在查找到数据后,便可以进行删除了。删除数据非常简单,只需要调用这个对象的 delete
方法即可。
def delete_user(request):
user = User.objects.get(id=2)
user.delete()
return HttpResponse("delete success!")
查询操作
查找是数据库操作中一个非常重要的技术。
查询一般就是使用 filter
、 exclude
以及 get
三个方法来实现。
我们可以在调用这些方法的时候传递不同的参数来实现查询需求。在 ORM 层面,这些查询条件都是使用 field + __ + condition
的方式来使用的。
查询条件
exact
使用精确的 =
进行查找。如果提供的是一个 None
,那么在 SQL 层面就是被解释为 NULL
。
article = Article.objects.get(id__exact=14)
article = Article.objects.get(id__exact=None)
以上的两个查找在翻译为 SQL 语句为如下:
select ... from article where id=14;
select ... from article where id IS NULL;
查询结果 .query
看到就可以看到底层执行的 SQL 语句,如上就是 article.query
iexact
使用 like
是忽略大小写进行查找。
article = Article.objects.filter(title__iexact='hello world')
那么以上的查询就等价于以下的 SQL 语句:
select ... from article where title like 'hello world';
注意上面这个 sql
语句,因为在 MySQL
中,没有一个叫做 ilike
的。所以 exact
和 iexact
的区别实际上就是 LIKE
和 =
的区别,在大部分 collation=utf8_general_ci 情况下都是一样的( collation 是
用来对字符串比较的)。
contains
大小写敏感,判断某个字段是否包含了某个数据。
articles = Article.objects.filter(title__contains='hello')
在翻译成 SQL 语句为如下:
select ... where title like binary '%hello%';
在使用 contains
的时候,翻译成的 sql
语句左右两边是有百分号的,意味着使用的是模糊查询。而 exact
翻译成 sql
语句左右两边是没有百分号的,意味着使用的是精确的查询。
icontains
大小写不敏感的匹配查询。
articles = Article.objects.filter(title__icontains='hello')
在翻译成 SQL 语句为如下:
select ... where title like '%hello%';
in
提取那些给定的 field 的值是否在给定的容器中。容器可以为 list 、 tuple 或者任何一个可以迭代的对象,包括 QuerySet 对象。(可以用一个列表、元组或其他可迭代对象里的值来筛选数据库中的记录)
articles = Article.objects.filter(id__in=[1,2,3])
以上代码在翻译成 SQL 语句为如下:
select ... where id in (1,3,4)
当然也可以传递一个 QuerySet
对象进去。
inner_qs = Article.objects.filter(title__contains='hello')
categories = Category.objects.filter(article__in=inner_qs)
以上代码的意思是获取那些文章标题包含 hello
的所有分类。
将翻译成以下 SQL 语句,示例代码如下:
select ...from category where article.id in (select id from article where title like '%hello%');
gt
某个 field
的值要大于给定的值。
articles = Article.objects.filter(id__gt=4)
以上代码的意思是将所有 id
大于4的文章全部都找出来。
将翻译成以下 SQL 语句:
select ... where id > 4;
gte
类似于 gt
,是大于等于。
lt
类似于 gt
是小于。
lte
类似于 lt
,是小于等于。
startswith
判断某个字段的值是否是以某个值开始的。大小写敏感。
articles = Article.objects.filter(title__startswith='hello')
以上代码的意思是提取所有标题以 hello
字符串开头的文章。
将翻译成以下 SQL 语句:
select ... where title like 'hello%'
istartswith
类似于 startswith
,但是大小写是不敏感的。
endswith
判断某个字段的值是否以某个值结束。大小写敏感。
articles = Article.objects.filter(title__endswith='world')
以上代码的意思是提取所有标题以 world
结尾的文章。
将翻译成以下 SQL 语句:
select ... where title like '%world';
iendswith
类似于 endswith
,只不过大小写不敏感。
range
判断某个 field
的值是否在给定的区间中。
from django.utils.timezone import make_aware
from datetime import datetime
start_date = make_aware(datetime(year=2024,month=1,day=1))
end_date = make_aware(datetime(year=2024,month=3,day=29,))
articles = Article.objects.filter(pub_date__range=(start_date,end_date))
以上代码的意思是提取所有发布时间在 2024/1/1 到 2024/3/29 之间的文章。
将翻译成以下的 SQL 语句:
select ... from article where pub_time between '2024-01-01' and '2024-03-29'
需要注意的是,以上提取数据,不会包含最后一个值。也就是不会包含 2024/3/29
的文章。
date
针对某些 date
或者 datetime
类型的字段。可以指定 date
的范围。并且这个时间过滤,还可以使用链式调用。
articles = Article.objects.filter(pub_date__date=date(2024,3,29))
以上代码的意思是查找时间为 2024/3/29
这一天发表的所有文章。
将翻译成以下的 sql 语句:
select ... WHERE DATE(CONVERT_TZ(`front_article`.`pub_date`, 'UTC', 'Asia/Shanghai')) = 2018-03-29
year
根据年份进行查找。
articles = Article.objects.filter(pub_date__year=2024)
articles = Article.objects.filter(pub_date__year__gte=2023)
以上的代码在翻译成 SQL 语句为如下:
select ... where pub_date between '2024-01-01' and '2024-12-31';
select ... where pub_date >= '2023-01-01';
month
同 year
,根据月份进行查找。
day
同 year
,根据日期进行查找。
week_day
Django 1.11 新增的查找方式。同 year
,根据星期几进行查找。1表示星期天,7表示星期六, 2-6 代表的是星期一到星期五。
time
根据时间进行查找。
articles = Article.objects.filter(pub_date__time=datetime.time(12,12,12));
以上的代码是获取每一天中12点12分12秒发表的所有文章。
更多的关于时间的过滤,可以参考 Django 官方文档:https://docs.djangoproject.com/zh-hans/5.0/ref/models/querysets/#range
isnull
根据值是否为空进行查找。
articles = Article.objects.filter(pub_date__isnull=False)
以上的代码的意思是获取所有发布日期不为空的文章。
将来翻译成 SQL 语句如下:
select ... where pub_date is not null;
regex和iregex
大小写敏感和大小写不敏感的正则表达式。
articles = Article.objects.filter(title__regex=r'^hello')
以上代码的意思是提取所有标题以 hello 字符串开头的文章。
将翻译成以下的 SQL 语句:
select ... where title regexp binary '^hello';
iregex
是大小写不敏感的。
根据关联的表进行查询
假如现在有两个 ORM
模型,一个是 Article
,一个是 Category
。
class Category(models.Model):
"""文章分类表"""
name = models.CharField(max_length=100)
class Article(models.Model):
"""文章表"""
title = models.CharField(max_length=100,null=True)
category = models.ForeignKey("Category",on_delete=models.CASCADE)
比如想要获取文章标题中包含"hello"的所有的分类。
categories = Category.object.filter(article__title__contains("hello"))
聚合函数
如果使用原生 SQL
,则可以使用聚合函数来提取数据。比如提取某个商品销售的数量,那么可以使用Count
,如果想要知道商品销售的平均价格,那么可以使用 Avg
。
在Django ORM中,聚合函数通过aggregate
方法来实现。Django提供了一组聚合函数,允许你在查询集中执行聚合计算,包括Count
、Avg
、Sum
、Max
、Min
等。
from django.db import models
class Author(models.Model):
"""作者模型"""
name = models.CharField(max_length=100)
age = models.IntegerField()
email = models.EmailField()
class Meta:
db_table = 'author'
class Publisher(models.Model):
"""出版社模型"""
name = models.CharField(max_length=300)
class Meta:
db_table = 'publisher'
class Book(models.Model):
"""图书模型"""
name = models.CharField(max_length=300)
pages = models.IntegerField()
price = models.FloatField()
rating = models.FloatField()
author = models.ForeignKey(Author,on_delete=models.CASCADE)
publisher = models.ForeignKey(Publisher, on_delete=models.CASCADE)
class Meta:
db_table = 'book'
class BookOrder(models.Model):
"""图书订单模型"""
book = models.ForeignKey("Book",on_delete=models.CASCADE)
price = models.FloatField()
class Meta:
db_table = 'book_order'
以下这些聚合函数的用法,都是基于以上的模型对象来实现的。
Avg
:求平均值
比如想要获取所有图书的价格平均值。
from django.db.models import Avg
result = Book.objects.aggregate(Avg('price'))
print(result)
以上的打印结果是:
{"price__avg":23.0}
其中 price__avg
的结构是根据 field__avg
规则构成的。如果想要修改默认的名字,那么可以将 Avg
赋值给一个关键字参数。
from django.db.models import Avg
result = Book.objects.aggregate(my_avg=Avg('price'))
print(result)
那么以上的结果打印为:
{"my_avg":23}
Count :获取指定的对象的个数
from django.db.models import Count
result = Book.objects.aggregate(book_num=Count('id'))
以上的 result
将返回 Book
表中总共有多少本图书。
Count
类中,还有另外一个参数叫做 distinct
,默认是等于 False
,如果是等于 True
,那么将去掉那些重复的值。
比如要获取作者表中所有的不重复的邮箱总共有多少个,那么可以通过以下代码来实现:
from djang.db.models import Count
result = Author.objects.aggregate(count=Count('email',distinct=True))
Max 和Min :获取指定对象的最大值和最小值
比如想要获取 Author
表中,最大的年龄和最小的年龄分别是多少。
from django.db.models import Max,Min
result = Author.objects.aggregate(Max('age'),Min('age'))
如果最大的年龄是88,最小的年龄是18。那么以上的result将为:
{"age__max":88,"age__min":18}
Sum :求指定对象的总和
比如要求图书的销售总额。
from djang.db.models import Sum
result = Book.objects.annotate(total=Sum("bookstore__price")).values("name","total")
以上的代码 annotate
的意思是给 Book
表在查询的时候添加一个字段叫做 total
,这个字段的数据来源是从 BookStore
模型的 price
的总和而来。 values
方法是只提取 name
和 total
两个字段的值。
更多的聚合函数可以参考官方文档:https://docs.djangoproject.com/zh-hans/5.0/ref/models/querysets/#aggregation-functions
aggregate和annotate的区别
aggregate :返回使用聚合函数后的字段和值。
annotate :在原来模型字段的基础之上添加一个使用了聚合函数的字段,并且在使用聚合函数的时候,会使用当前这个模型的主键进行分组(group by
)。
比如以上 Sum
的例子,如果使用的是 annotate
,那么将在每条图书的数据上都添加一个字段叫做total
,计算这本书的销售总额。
而如果使用的是 aggregate
,那么将求所有图书的销售总额。
F表达式和Q表达式
F表达式
F表达式
是用来优化 ORM
操作数据库的。比如我们要将公司所有员工的薪水都增加1000元,如果按照正常的流程,应该是先从数据库中提取所有的员工工资到Python内存中,然后使用Python代码在员工工资的基础之上增加1000元,最后再保存到数据库中。这里面涉及的流程就是,首先从数据库中提取数据到Python内存中,然后在Python内存中做完运算,之后再保存到数据库中。
employees = Employee.objects.all()
for employee in employees:
employee.salary += 1000
employee.save()
而 F表达式
就可以优化这个流程,它可以不需要先把数据从数据库中提取出来,计算完成后再保存回去,他可以直接执行 SQL语句
,就将员工的工资增加1000元。
from djang.db.models import F
Employee.object.update(salary=F("salary")+1000)
F表达式
并不会马上从数据库中获取数据,而是在生成 SQL 语句的时候,动态的获取传给 F表达式
的值。
比如如果想要获取作者中, name
和 email
相同的作者数据。如果不使用 F表达式
,那么需要使用以下代码来完成:
authors = Author.objects.all()
for author in authors:
if author.name == author.email:
print(author)
如果使用 F表达式
,那么一行代码就可以搞定。
from django.db.models import F
authors = Author.objects.filter(name=F("email"))
Q表达式
如果想要实现所有价格高于100元,并且评分达到9.0以上评分的图书。那么可以通过以下代码来实现:
books = Book.objects.filter(price__gte=100,rating__gte=9)
以上这个案例是一个并集查询,可以简单的通过传递多个条件进去来实现。
但是如果想要实现一些复杂的查询语句,比如要查询所有价格低于10元,或者是评分低于9分的图书。那就没有办法通过传递多个条件进去实现了。
这时候就需要使用 Q表达式
来实现了。示例代码如下:
from django.db.models import Q
books = Book.objects.filter(Q(price__lte=10) | Q(rating__lte=9))
以上是进行或运算,当然还可以进行其他的运算,比如有 &
和 ~
(非) 等。一些用Q表达式
的例子如下
from django.db.models import Q
# 获取id等于3的图书
books = Book.objects.filter(Q(id=3))
# 获取id等于3,或者名字中包含文字"记"的图书
books = Book.objects.filter(Q(id=3)|Q(name__contains("记")))
# 获取价格大于100,并且书名中包含"记"的图书
books = Book.objects.filter(Q(price__gte=100)&Q(name__contains("记")))
# 获取书名包含"记",但是id不等于3的图书
books = Book.objects.filter(Q(name__contains='记') & ~Q(id=3))