Django ORM 查询优化和进阶知识
查询优化
selected_related与prefetch_related方法的使用
详细讲解了django相关的性能优化:https://mp.weixin.qq.com/s/U07oOF8t04H8jyNv0TMJFw
五个常见的Django错误 https://zhuanlan.zhihu.com/p/390325954
Django的select_related 和 prefetch_related 函数优化查询 https://www.cnblogs.com/wangkun122/articles/9106233.html
select_related 和 prefetch_related 函数,前者针对多对1或者1对多的FK字段,后者针对manytomany字段.目的是对关联字段需要遍历循环查询的时候,统一获取set对象,减少遍历对数据库频繁读取的压力
(1)select_related()
对于一对一字段(OneToOneField)和外键字段(ForeignKey),可以使用select_related 来对QuerySet进行优化。
select_related 返回一个QuerySet
,当执行它的查询时它沿着外键关系查询关联的对象的数据。它会生成一个复杂的查询并引起性能的损耗,但是在以后使用外键关系时将不需要数据库查询。
简单说,在对QuerySet使用select_related()函数后,Django会获取相应外键对应的对象,从而在之后需要的时候不必再查询数据库了。
下面的例子解释了普通查询和select_related()
查询的区别。
查询id=2的的书籍的出版社名称,下面是一个标准的查询:
# Hits the database.
book= models.Book.objects.get(nid=2)
# Hits the database again to get the related Blog object.
print(book.publish.name)
如果我们使用select_related()函数:
books=models.Book.objects.select_related("publish").all()
for book in books:
# Doesn't hit the database, because book.publish
# has been prepopulated in the previous query.
print(book.publish.name)
多外键查询
这是针对publish的外键查询,如果是另外一个外键呢?让我们一起看下:
book=models.Book.objects.select_related("publish").get(nid=1)
print(book.authors.all())
观察logging结果,发现依然需要查询两次,所以需要改为:
book=models.Book.objects.select_related("publish","").get(nid=1)
print(book.publish)
或者:
book=models.Article.objects
.select_related("publish")
.select_related("")
.get(nid=1) # django 1.7 支持链式操作
print(book.publish)
(2)prefetch_related()
对于多对多字段(ManyToManyField)和反向外键关系的查询,可以使用prefetch_related()来进行优化。
prefetch_related()和select_related()的设计目的很相似,都是为了减少SQL查询的数量,但是实现的方式不一样。后者是通过JOIN语句,在SQL查询内解决问题。但是对于多对多关系,使用SQL语句解决就显得有些不太明智,因为JOIN得到的表将会很长,会导致SQL语句运行时间的增加和内存占用的增加。若有n个对象,每个对象的多对多字段对应Mi条,就会生成Σ(n)Mi 行的结果表。
prefetch_related()的解决方法是,分别查询每个表,然后用Python处理他们之间的关系。
# 查询所有文章关联的所有标签
books=models.Book.objects.all()
for book in books:
print(book.authors.all()) #4篇文章: hits database 5
改为prefetch_related:
# 查询所有文章关联的所有标签
books=models.Book.objects.prefetch_related("authors").all()
for book in books:
print(book.authors.all()) #4篇文章: hits database 2
注意prefetch_related 可以传多个值,表示预取多个关联关系的数据。
比如 models.Book.objects.prefetch_related("authors","xxxxx","xxxx_set")
class Menu(models.Model):
""" 一级菜单 (左侧目录)"""
objects = models.Manager()
title = models.CharField(max_length=15, verbose_name="一级菜单标题")
icon = models.CharField(max_length=15, verbose_name="图标样式")
def __str__(self):
return self.title
class NaviBar(models.Model):
""" 二级菜单(左侧导航) """
objects = models.Manager()
title = models.CharField(verbose_name="标题", max_length=32)
name = models.CharField(verbose_name="路由名称", max_length=64)
is_menu = models.BooleanField(verbose_name="是否菜单", default=True)
rooter = models.ForeignKey(verbose_name="菜单目录", to="Menu", on_delete=models.PROTECT)
def __str__(self):
return self.title
class Permission(models.Model):
""" 三级菜单(权限)"""
objects = models.Manager()
title = models.CharField(verbose_name="标题", max_length=32)
name = models.CharField(verbose_name="API代码", max_length=32)
method_choices = (
('GET', "GET"),
('POST', "POST"),
('PUT', "PUT"),
('PATCH', "PATCH"),
('DELETE', "DELETE"),
)
method = models.CharField(verbose_name="方法", max_length=32, choices=method_choices)
router = models.ForeignKey(verbose_name="关联路由", to="NaviBar", on_delete=models.PROTECT)
def __str__(self):
return self.title
class Role(models.Model):
"""角色表"""
objects = models.Manager()
title = models.CharField(verbose_name="角色名", max_length=32)
permission = models.ManyToManyField(to="Permission", blank=True, verbose_name="角色权限")
def __str__(self):
return self.title
这里我们的需求是通过Role 通过permission__ router__rooter 获取Menu,NaviBar,Permission 三个表的所有数据
如果不用prefetch_related的方法就是
1. 获取Role所有对象 role=models.Role.objects.all()
2. 遍历对象.字段去重复查询数据库
role = models.Role.objects.all()
for i in role:
for j in i.permission.all(): # 这里循环一次就会关联一次role和permission表
print(j.router.title) # 这里又会再关联Navibar表N次
return Response({'name':'ok'})
一次结果查询下来需要数据库查询N * N次
优化的查询语法
role_objs = models.Role.objects.prefetch_related('permission__router') 这里就关联好Role,Permission,Navibar三张表,后续的for循环不会对数据库进行读取行为,
for role_obj in role_objs:
print("角色",role_obj.title)
for per in role_obj.permission.all():
print('权限',per.title)
print('navi',per.router.title)
这个写法也很方便输出嵌套结果
预关联的过滤1
prefetch_related 做的预关联,减少数据库查询的目的,但是如果遇到要过滤数据,可以用get方法进行,
# models
class Userinfo(models.Model):
objects = models.Manager()
# username = models.CharField(max_length=15, verbose_name="用户名", unique=True, blank=False,error_messages={"unique":"账号已被注册"})
username = models.CharField(max_length=15, verbose_name="用户名", blank=False,)
pwd = models.CharField(max_length=15)
mobile_phone = models.CharField(max_length=11, verbose_name="手机号", blank=True,error_messages={"max_length":_('手机长度不要超过 %(max_length)s 个字符。')})
user = models.ManyToManyField(to="Role", blank=True, verbose_name="用户角色")
sign_up_date = models.DateTimeField(auto_now_add=True, verbose_name="注册时间")
def __str__(self):
return self.username
class Role(models.Model):
"""角色表"""
objects = models.Manager()
title = models.CharField(verbose_name="角色名", max_length=32)
permission = models.ManyToManyField(to="Permission", blank=True, verbose_name="角色权限")
def __str__(self):
return self.title
这里的过滤对象不能是预关联的对象,也就是说下面的代码只能过滤Userinfo表
obj = models.Userinfo.objects.prefetch_related('user').get(username='alex')
print(obj) # 输出Userinfo数据
# 输出关联字段的数据 也就是输出role.title
for i in obj.user.all():
print(i.title)
预关联的过滤2
有时候我们需要过滤预关联的数据,比如我想预关联Role,但是预关联的时候对预关联数据做一个处理,比如排序,或者过滤
我们可以使用Prefetch对象 from django.db.models import Prefetch
Prefetch对象按照顺序会传入三个值
-
查询对象,按照正向查找用字段,反向查找用表名_set的形式
-
querset 对预关联数据写入一个查询方式,
比如过滤Role.title为经理queryset=models.Role.objects.filter(title='经理')
比如 过滤后再做个排序,这里的Role没有name字段只是举例queryset=models.Role.objects.filter(title='经理').order_by('name')
-
设置一个变量,接收这个预关联数据处理后的结果
代码示例
managers = Prefetch(
'user', # 注意:这里使用关联字段名 'user',如果反向关联就是''role_set
queryset=models.Role.objects.filter(title='经理'),
to_attr='filter_managers'
)
# 这里的prefetch_related 可以放多个Prefetch对象
obj = models.Userinfo.objects.prefetch_related(managers)
# 遍历用户,并访问过滤后的角色信息
for user in obj:
print('用户信息',user.username,)
for i in user.filter_managers:
print('角色信息',i.title)
# 注意这个输出结果,只有一个dlex3有经理这个角色,其他是没有经理角色的
# 从输出结果看managers的预关联数据过滤结果只影响Role,但是不会作用Userinfo,她还是会遍历所有的Userinfo,但是只有dlex3这个用户的role关联数据中有filter_managers属性
用户信息 alex
用户信息 Glex
用户信息 glex_te3
用户信息 dlex3
角色信息 经理
用户信息 dlex2
用户信息 elex1
用户信息 test_88931
用户信息 test_25959
我们调整下代码结构
# 遍历用户,并访问过滤后的角色信息
for user in obj:
if user.filter_managers:
print('用户信息',user.username,'角色信息',",".join([i.title for i in user.filter_managers]))
else:
print('用户信息',user.username)
用户信息 alex
用户信息 Glex
用户信息 glex_te3
用户信息 dlex3 角色信息 经理
用户信息 dlex2
用户信息 elex1
用户信息 test_88931
用户信息 test_25959
(3)extra
extra(select=None, where=None, params=None,
tables=None, order_by=None, select_params=None)
有些情况下,Django的查询语法难以简单的表达复杂的 WHERE
子句,对于这种情况, Django 提供了 extra()
QuerySet
修改机制 — 它能在 QuerySet
生成的SQL从句中注入新子句
extra可以指定一个或多个 参数
,例如 select
, where
or tables
. 这些参数都不是必须的,但是你至少要使用一个!要注意这些额外的方式对不同的数据库引擎可能存在移植性问题.(因为你在显式的书写SQL语句),除非万不得已,尽量避免这样。
参数之select
The select
参数可以让你在 SELECT
从句中添加其他字段信息,它应该是一个字典,存放着属性名到 SQL 从句的映射。
queryResult=models.Article
.objects.extra(select={'is_recent': "create_time > '2017-09-05'"})
结果集中每个 Entry 对象都有一个额外的属性is_recent, 它是一个布尔值,表示 Article对象的create_time 是否晚于2017-09-05.
参数之where
/ tables
您可以使用where
定义显式SQL WHERE
子句 - 也许执行非显式连接。您可以使用tables
手动将表添加到SQL FROM
子句。
where
和tables
都接受字符串列表。所有where
参数均为“与”任何其他搜索条件。
举例来讲:
queryResult=models.Article
.objects.extra(where=['nid in (3,4) OR title like "py%" ','nid>2'])
(4)only和defer
#ORM查询优化之only
only会将括号内填写的字段封装成一个个数据对象,对象在点击的时候不会再走数据库查询
但是对象也可以点击括号内没有的字段,只不过每次都会走数据库查询
res = models.Book.objects.only('title','price')
for obj in res:
print(obj.title)
print(obj.price)
print(obj.publish_time)
# ORM查询优化之defer
defer与only相反
数据对象点击括号内出现的字段,每次都会走数据库查询
数据对象点击括号内的没有的字典,不会走数据库查询
res = models.Book.objects.defer('title','price')
for obj in res:
#print(obj.title)
#print(obj.price)
print(obj.publiesh_time)
ORM进阶
queryset特性
(1)可切片
使用Python 的切片语法来限制查询集
记录的数目 。它等同于SQL 的LIMIT
和OFFSET
子句。
>>> Article.objects.all()[:5] # (LIMIT 5)
>>> Article.objects.all()[5:10] # (OFFSET 5 LIMIT 5)
不支持负的索引(例如Article.objects.all()[-1]
)。通常,查询集
的切片返回一个新的查询集
—— 它不会执行查询。
(2)可迭代
articleList=models.Article.objects.all()
for article in articleList:
print(article.title)
(3)惰性查询
查询集
是惰性执行的 —— 创建查询集
不会带来任何数据库的访问。你可以将过滤器保持一整天,直到查询集
需要求值时,Django 才会真正运行这个查询。
queryResult=models.Article.objects.all() # not hits database
print(queryResult) # hits database
for article in queryResult:
print(article.title) # hits database
一般来说,只有在“请求”查询集
的结果时才会到数据库中去获取它们。当你确实需要结果时,查询集
通过访问数据库来求值。 关于求值发生的准确时间。
(4)缓存机制
每个查询集
都包含一个缓存来最小化对数据库的访问。理解它是如何工作的将让你编写最高效的代码。
在一个新创建的查询集
中,缓存为空。首次对查询集
进行求值 —— 同时发生数据库查询 ——Django 将保存查询的结果到查询集
的缓存中并返回明确请求的结果(例如,如果正在迭代查询集
,则返回下一个结果)。接下来对该查询集
的求值将重用缓存的结果。
请牢记这个缓存行为,因为对查询集
使用不当的话,它会坑你的。例如,下面的语句创建两个查询集
,对它们求值,然后扔掉它们:
queryset = Book.objects.all()
print(queryset) # hit database
print(queryset) # hit database
注:简单地打印查询集不会填充缓存。
这意味着相同的数据库查询将执行两次,显然倍增了你的数据库负载。同时,还有可能两个结果列表并不包含相同的数据库记录,因为在两次请求期间有可能有Article被添加进来或删除掉。为了避免这个问题,只需保存查询集
并重新使用它:
queryset = Book.objects.all()
ret = [i for i in queryset] # hit database
print(queryset) # 使用缓存
print(queryset) # 使用缓存
何时查询集会被缓存?
- 遍历queryset时
- if语句(为了避免这个,可以用exists()方法来检查是否有数据)
所以单独queryset的索引或者切片都不会缓存。
queryset = Book.objects.all()
one = queryset[0] # hit database
two = queryset[1] # hit database
print(one)
print(two)
(5)exists()与iterator()方法
exists
简单的使用if语句进行判断也会完全执行整个queryset并且把数据放入cache,虽然你并不需要这些 数据!为了避免这个,可以用exists()方法来检查是否有数据:
if queryResult.exists():
#SELECT (1) AS "a" FROM "blog_article" LIMIT 1; args=()
print("exists...")
iterator
当queryset非常巨大时,cache会成为问题。
处理成千上万的记录时,将它们一次装入内存是很浪费的。更糟糕的是,巨大的queryset可能会锁住系统 进程,让你的程序濒临崩溃。要避免在遍历数据的同时产生queryset cache,可以使用iterator()方法 来获取数据,处理完数据就将其丢弃。
objs = Book.objects.all().iterator()
# iterator()可以一次只从数据库获取少量数据,这样可以节省内存
for obj in objs:
print(obj.title)
#BUT,再次遍历没有打印,因为迭代器已经在上一次遍历(next)到最后一次了,没得遍历了
for obj in objs:
print(obj.title)
当然,使用iterator()方法来防止生成cache,意味着遍历同一个queryset时会重复执行查询。所以使 #用iterator()的时候要当心,确保你的代码在操作一个大的queryset时没有重复执行查询。
queryset的cache是用于减少程序对数据库的查询,在通常的使用下会保证只有在需要的时候才会查询数据库。 使用exists()和iterator()方法可以优化程序对内存的使用。不过,由于它们并不会生成queryset cache,可能 会造成额外的数据库查询。
总结:在使用缓存机制还是生成器机制的选择上如果是,数据量大情况主要使用生成器;数据少使用次数多的情况使用缓存机制。
中介模型
处理类似搭配 pizza 和 topping 这样简单的多对多关系时,使用标准的ManyToManyField
就可以了。但是,有时你可能需要关联数据到两个模型之间的关系上。
例如,有这样一个应用,它记录音乐家所属的音乐小组。我们可以用一个ManyToManyField
表示小组和成员之间的多对多关系。但是,有时你可能想知道更多成员关系的细节,比如成员是何时加入小组的。
对于这些情况,Django 允许你指定一个中介模型来定义多对多关系。 你可以将其他字段放在中介模型里面。源模型的ManyToManyField
字段将使用through
参数指向中介模型。对于上面的音乐小组的例子,代码如下:
from django.db import models
class Person(models.Model):
name = models.CharField(max_length=128)
def __str__(self): # __unicode__ on Python 2
return self.name
class Group(models.Model):
name = models.CharField(max_length=128)
members = models.ManyToManyField(Person, through='Membership')
def __str__(self): # __unicode__ on Python 2
return self.name
class Membership(models.Model):
person = models.ForeignKey(Person)
group = models.ForeignKey(Group)
date_joined = models.DateField()
invite_reason = models.CharField(max_length=64)
既然你已经设置好ManyToManyField
来使用中介模型(在这个例子中就是Membership
),接下来你要开始创建多对多关系。你要做的就是创建中介模型的实例:
>>> ringo = Person.objects.create(name="Ringo Starr")
>>> paul = Person.objects.create(name="Paul McCartney")
>>> beatles = Group.objects.create(name="The Beatles")
>>> m1 = Membership(person=ringo, group=beatles,
... date_joined=date(1962, 8, 16),
... invite_reason="Needed a new drummer.")
>>> m1.save()
>>> beatles.members.all()
[<Person: Ringo Starr>]
>>> ringo.group_set.all()
[<Group: The Beatles>]
>>> m2 = Membership.objects.create(person=paul, group=beatles,
... date_joined=date(1960, 8, 1),
... invite_reason="Wanted to form a band.")
>>> beatles.members.all()
[<Person: Ringo Starr>, <Person: Paul McCartney>]
与普通的多对多字段不同,你不能使用add
、 create
和赋值语句(比如,beatles.members = [...]
)来创建关系:
# THIS WILL NOT WORK
>>> beatles.members.add(john)
# NEITHER WILL THIS
>>> beatles.members.create(name="George Harrison")
# AND NEITHER WILL THIS
>>> beatles.members = [john, paul, ringo, george]
为什么不能这样做? 这是因为你不能只创建 Person
和 Group
之间的关联关系,你还要指定 Membership
模型中所需要的所有信息;而简单的add
、create
和赋值语句是做不到这一点的。所以它们不能在使用中介模型的多对多关系中使用。此时,唯一的办法就是创建中介模型的实例。
remove()
方法被禁用也是出于同样的原因。但是clear()
方法却是可用的。它可以清空某个实例所有的多对多关系:
>>> # Beatles have broken up
>>> beatles.members.clear()
>>> # Note that this deletes the intermediate model instances
>>> Membership.objects.all()
[]
数据库表反向生成模型类
众所周知,Django较为适合原生开发,即通过该框架搭建一个全新的项目,通过在修改models.py来创建新的数据库表。但是往往有时候,我们需要利用到之前的已经设计好的数据库,数据库中提供了设计好的多种表单。那么这时如果我们再通过models.py再来设计就会浪费很多的时间。所幸Django为我们提供了inspecdb的方法。他的作用即使根据已经存在对的mysql数据库表来反向映射结构到models.py中.
我们在展示django ORM反向生成之前,我们先说一下怎么样正向生成代码。
正向生成,指的是先创建model.py文件,然后通过django内置的编译器,在数据库如mysql中创建出符合model.py的表。
反向生成,指的是先在数据库中create table,然后通过django内置的编译器,生成model代码。
python manage.py inspectdb > models文件名