django model

Posted pungchur

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了django model相关的知识,希望对你有一定的参考价值。

 

ORM

映射关系:

表名      <------->  类名

字段      <------->  属性

表记录    <------->  类实例对象

创建表(建立模型)

实例:我们来假定下面这些概念,字段和关系

作者模型:一个作者有姓名和年龄。

作者详细模型:把作者的详情放到详情表,包含生日,手机号,家庭住址等信息。作者详情模型和作者模型之间是一对一的关系(one-to-one)

出版商模型:出版商有名称,所在城市以及email。

书籍模型: 书籍有书名和出版日期,一本书可能会有多个作者,一个作者也可以写多本书,所以作者和书籍的关系就是多对多的关联关系(many-to-many);一本书只应该由一个出版商出版,所以出版商和书籍是一对多关联关系(one-to-many)。

模型建立如下:

from django.db import models


class Author(models.Model):
    nid = models.AutoField(primary_key=True)
    name = models.CharField(max_length=32)
    age = models.IntegerField()

    # 与AuthorDetail建立一对一的关系
    authorDetail = models.OneToOneField(to="AuthorDetail", on_delete=models.CASCADE)


class AuthorDetail(models.Model):
    nid = models.AutoField(primary_key=True)
    birthday = models.DateField()
    telephone = models.BigIntegerField()
    addr = models.CharField(max_length=64)


class Publish(models.Model):
    nid = models.AutoField(primary_key=True)
    name = models.CharField(max_length=32)
    city = models.CharField(max_length=32)
    email = models.EmailField()


class Book(models.Model):
    nid = models.AutoField(primary_key=True)
    title = models.CharField(max_length=32)
    publishDate = models.DateField()
    price = models.DecimalField(max_digits=5, decimal_places=2)
    keepNum = models.IntegerField()
    commentNum = models.IntegerField()
    # 与Publish建立一对多的关系,外键字段建立在多的一方
    publish = models.ForeignKey(to="Publish", to_field="nid", on_delete=models.CASCADE)

    # 与Author表建立多对多的关系,ManyToManyField可以建在两个模型中的任意一个,自动创建第三张表
    authors = models.ManyToManyField(to=Author)

通过logging可以查看翻译成的sql语句(在settings.py里配置)

技术图片
LOGGING = {
    version: 1,
    disable_existing_loggers: False,
    handlers: {
        console:{
            level:DEBUG,
            class:logging.StreamHandler,
        },
    },
    loggers: {
        django.db.backends: {
            handlers: [console],
            propagate: True,
            level:DEBUG,
        },
    }
}  
logging

注意事项:

  1. 表的名称myapp_modelName,是根据 模型中的元数据自动生成的,也可以覆写为别的名称  
  2. id 字段是自动添加的
  3. 对于外键字段,Django 会在字段名上添加"_id" 来创建数据库中的列名
  4. 这个例子中的CREATE TABLE SQL 语句使用PostgreSQL 语法格式,要注意的是Django 会根据settings 中指定的数据库类型来使用相应的SQL 语句。
  5. 定义好模型之后,你需要告诉Django _使用_这些模型。你要做的就是修改配置文件中的INSTALL_APPSZ中设置,在其中添加models.py所在应用的名称。
  6. 外键字段 ForeignKey 有一个 null=True 的设置(它允许外键接受空值 NULL),你可以赋给它空值 None 。

字段选项

每个字段有一些特有的参数,例如,CharField需要max_length参数来指定varchar数据库字段的大小。还有一些适用于所有字段的通用参数。 这些参数在文档中有详细定义,这里我们只简单介绍一些最常用的:

技术图片
(1)null

如果为True,Django 将用NULL 来在数据库中存储空值。 默认值是 False.

(1)blank

如果为True,该字段允许不填。默认为False。
要注意,这与 null 不同。null纯粹是数据库范畴的,而 blank 是数据验证范畴的。
如果一个字段的blank=True,表单的验证将允许该字段是空值。如果字段的blank=False,该字段就是必填的。

(2)default

字段的默认值。可以是一个值或者可调用对象。如果可调用 ,每有新对象被创建它都会被调用。

(3)primary_key

如果为True,那么这个字段就是模型的主键。如果你没有指定任何一个字段的primary_key=True,
Django 就会自动添加一个IntegerField字段做为主键,所以除非你想覆盖默认的主键行为,
否则没必要设置任何一个字段的primary_key=True。

(4)unique

如果该值设置为 True, 这个数据字段的值在整张表中必须是唯一的

(5)choices
由二元组组成的一个可迭代对象(例如,列表或元组),用来给字段提供选择项。 如果设置了choices ,默认的表单将是一个选择框而不是标准的文本框,而且这个选择框的选项就是choices 中的选项。

这是一个关于 choices 列表的例子:

YEAR_IN_SCHOOL_CHOICES = (
    (FR, Freshman),
    (SO, Sophomore),
    (JR, Junior),
    (SR, Senior),
    (GR, Graduate),
)
每个元组中的第一个元素,是存储在数据库中的值;第二个元素是在管理界面或 ModelChoiceField 中用作显示的内容。 在一个给定的 model 类的实例中,想得到某个 choices 字段的显示值,就调用 get_FOO_display 方法(这里的 FOO 就是 choices 字段的名称 )。例如:

from django.db import models

class Person(models.Model):
    SHIRT_SIZES = (
        (S, Small),
        (M, Medium),
        (L, Large),
    )
    name = models.CharField(max_length=60)
    shirt_size = models.CharField(max_length=1, choices=SHIRT_SIZES)


>>> p = Person(name="Fred Flintstone", shirt_size="L")
>>> p.save()
>>> p.shirt_size
L
>>> p.get_shirt_size_display()
Large   
常用字段

一旦你建立好数据模型之后,django会自动生成一套数据库抽象的API,可以让你执行关于表记录的增删改查的操作。

添加表记录

普通字段

# 方式1
publish_obj = Publish(name="人民出版社", city="北京", email="renMin@163.com")
publish_obj.save()  # 将数据保存到数据库
# 方式2
# 返回值publish_obj是添加的记录对象
publish_obj = Publish.objects.create(name="人民出版社", city="北京", email="renMin@163.com")
# 方式3
publish_obj = Publish.objects.create(**request.POST.dict())

外键字段

# 方式一
publish_obj = Publish.objects.get(nid=1)
Book.objects.create(title="追风筝的人", publishDate="2019-12-12", price=665, pageNum=334, publish=publish_obj)

# 方式二
Book.objects.create(title="追风筝的人", publishDate="2019-12-12", price=665, pageNum=334, publish_id=1)

关键点:book_obj.publish是什么?

多对多字段

book_obj = Book.objects.create(title="追风筝的人", publishDate="2019-12-12", price=69, pageNum=314, publish_id=1)

author_小李 = Author.objects.create(name="小李", age=23, authorDetail_id=1)
author_egon = Author.objects.create(name="egon", age=32, authorDetail_id=2)
# 将某个特定的 model 对象添加到被关联对象集合中。   =======    book_obj.authors.add(*[])
book_obj.authors.add(author_egon, author_小李)
# 创建并保存一个新对象,然后将这个对象加被关联对象的集合中,然后返回这个新对象。
book_obj.authors.create()

关键点:book_obj.authors是什么?

解除关系:

# 将某个特定的对象从被关联对象集合中去除。    ======   book_obj.authors.remove(*[])
book_obj.authors.remove()    
#清空被关联对象集合。
book_obj.authors.clear()    

class RelatedManager

"关联管理器"是在一对多或者多对多的关联上下文中使用的管理器。它存在于下面两种情况:

ForeignKey关系的“另一边”。像这样:

from django.db import models


class Reporter(models.Model):
    # ...
    pass


class Article(models.Model):
    reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE)

在上面的例子中,管理器reporter.article_set拥有下面的方法。

ManyToManyField关系的两边:

class Topping(models.Model):
    # ...
    pass
 
class Pizza(models.Model):
    toppings = models.ManyToManyField(Topping)

这个例子中,topping.pizza_set 和pizza.toppings都拥有下面的方法。

add(obj1[, obj2, ...])

把指定的模型对象添加到关联对象集中。

例如:

>>> b = Blog.objects.get(id=1)
>>> e = Entry.objects.get(id=234)
>>> b.entry_set.add(e) # Associates Entry e with Blog b.
在上面的例子中,对于ForeignKey关系,e.save()由关联管理器调用,执行更新操作。然而,在多对多关系中使用add()并不会调用任何 save()方法,而是由QuerySet.bulk_create()创建关系。

延伸:

# 1 *[]的使用
>>> book_obj = Book.objects.get(id=1)
>>> author_list = Author.objects.filter(id__gt=2)
>>> book_obj.authors.add(*author_list)


# 2 直接绑定主键
book_obj.authors.add(*[1,3])  

# 将id=1和id=3的作者对象添加到这本书的作者集合中 # 应用: 添加或者编辑时,提交作者信息时可以用到.

create(**kwargs)

创建一个新的对象,保存对象,并将它添加到关联对象集之中。返回新创建的对象:

>>> b = Blog.objects.get(id=1)
>>> e = b.entry_set.create(
...     headline=Hello,
...     body_text=Hi,
...     pub_date=datetime.date(2005, 1, 1)
... )

# No need to call e.save() at this point -- it‘s already been saved.
这完全等价于(不过更加简洁于):

>>> b = Blog.objects.get(id=1)
>>> e = Entry(
...     blog=b,
...     headline=Hello,
...     body_text=Hi,
...     pub_date=datetime.date(2005, 1, 1)
... )
>>> e.save(force_insert=True)
要注意我们并不需要指定模型中用于定义关系的关键词参数。在上面的例子中,我们并没有传入blog参数给create()。Django会明白新的 Entry对象blog 应该添加到b中。

remove(obj1[, obj2, ...])

从关联对象集中移除执行的模型对象:

>>> b = Blog.objects.get(id=1)
>>> e = Entry.objects.get(id=234)
>>> b.entry_set.remove(e) # Disassociates Entry e from Blog b.
对于ForeignKey对象,这个方法仅在null=True时存在。

clear()

从关联对象集中移除一切对象。

>>> b = Blog.objects.get(id=1)
>>> b.entry_set.clear()
注意这样不会删除对象 —— 只会删除他们之间的关联。

就像 remove() 方法一样,clear()只能在 null=True的ForeignKey上被调用。

set()方法

先清空,在设置,编辑书籍时即可用到

技术图片

注意

对于所有类型的关联字段,add()、create()、remove()和clear(),set()都会马上更新数据库。换句话说,在关联的任何一端,都不需要再调用save()方法。

直接赋值:

通过赋值一个新的可迭代的对象,关联对象集可以被整体替换掉。

>>> new_list = [obj1, obj2, obj3]
>>> e.related_set = new_list

如果外键关系满足null=True,关联管理器会在添加new_list中的内容之前,首先调用clear()方法来解除关联集中一切已存在对象的关联。否则, new_list中的对象会在已存在的关联的基础上被添加。  

 

查询表记录

查询相关API

<1> all():                 查询所有结果
 
<2> filter(**kwargs):      它包含了与所给筛选条件相匹配的对象
 
<3> get(**kwargs):         返回与所给筛选条件相匹配的对象,返回结果有且只有一个,
                           如果符合筛选条件的对象超过一个或者没有都会抛出错误。
 
<5> exclude(**kwargs):     它包含了与所给筛选条件不匹配的对象
 
<4> values(*field):        返回一个ValueQuerySet——一个特殊的QuerySet,运行后得到的并不是一系列
                           model的实例化对象,而是一个可迭代的字典序列
 
<9> values_list(*field):   它与values()非常相似,它返回的是一个元组序列,values返回的是一个字典序列
 
<6> order_by(*field):      对查询结果排序
 
<7> reverse():             对查询结果反向排序
 
<8> distinct():            从返回结果中剔除重复纪录
 
<10> count():              返回数据库中匹配查询(QuerySet)的对象数量。
 
<11> first():              返回第一条记录
 
<12> last():               返回最后一条记录
 
<13> exists():             如果QuerySet包含数据,就返回True,否则返回False

注意:一定区分object与querySet的区别 !!!

双下划线之单表查询

# 获取id大于1 且 小于10的值
models.tables.objects.filter(id__lt=10, id__gt=1)
# 获取id等于11、22、33的数据
models.tables.objects.filter(id__in=[11, 22, 33])
# not in
models.tables.objects.exclude(id__in=[11, 22, 33])

models.tables.objects.filter(name__contains="ven")
# icontains大小写不敏感
models.tables.objects.filter(name__icontains="ven")
# 范围bettwen and
models.tables.objects.filter(id__range=[1, 2])

# startswith,istartswith, endswith, iendswith 

基于对象的跨表查询 

一对多查询(Publish 与 Book)

正向查询(按字段:publish):

# 查询nid=1的书籍的出版社所在的城市
book_obj=Book.objects.get(nid=1)
# book_obj.publish 是nid=1的书籍对象关联的出版社对象 
print(book_obj.publish.city) 

反向查询(按表名:book_set):

# 查询 人民出版社出版过的所有书籍
publish = Publish.objects.get(name="人民出版社")
# 与人民出版社关联的所有书籍对象集合
book_list = publish.book_set.all()  

for book_obj in book_list:
    print(book_obj.title)

一对一查询(Author 与 AuthorDetail)

正向查询(按字段:authorDetail):

# 查询小李作者的手机号
author_egon = Author.objects.get(name="小李")
print(author_egon.authorDetail.telephone)

反向查询(按表名:author):

# 查询所有住址在北京的作者的姓名
authorDetail_list=AuthorDetail.objects.filter(addr="北京")

for obj in authorDetail_list:
    print(obj.author.name)

多对多查询 (Author 与 Book)

正向查询(按字段:authors):

# 放风筝的人所有作者的名字以及手机号
book_obj = Book.objects.filter(title="放风筝的人").first()
authors = book_obj.authors.all()

for author_obj in authors:
    print(author_obj.name, author_obj.authorDetail.telephone)
    

反向查询(按表名:book_set):

# 查询小李出过的所有书籍的名字
author_obj = Author.objects.get(name="小李")
# 与小李作者相关的所有书籍
book_list = author_obj.book_set.all()  

for book_obj in book_list:
    print(book_obj.title)

注意:

你可以通过在 ForeignKey() 和ManyToManyField的定义中设置 related_name 的值来覆写 object_set 的名称。例如,如果 Article model 中做一下更改: publish = ForeignKey(Blog, related_name=‘bookList‘),那么接下来就会如我们看到这般:

# 查询 人民出版社出版过的所有书籍
publish=Publish.objects.get(name="人民出版社")
# 与人民出版社关联的所有书籍对象集合
book_list=publish.bookList.all()  

基于双下划线的跨表查询 

Django 还提供了一种直观而高效的方式在查询(lookups)中表示关联关系,它能自动确认 SQL JOIN 联系。要做跨关系查询,就使用两个下划线来链接模型(model)间关联字段的名称,直到最终链接到你想要的 model 为止。

关键点:正向查询按字段,反向查询按表明。

# 练习1:  查询人民出版社出版过的所有书籍的名字与价格(一对多)

    # 正向查询 按字段:publish

    queryResult=Book.objects
            .filter(publish__name="人民出版社")
            .values_list("title","price") # 反向查询 按表名:book queryResult=Publish.objects
              .filter(name="人民出版社")
              .values_list("book__title","book__price") # 练习2: 查询小王出过的所有书籍的名字(多对多) # 正向查询 按字段:authors: queryResult=Book.objects
            .filter(authors__name="小王")
            .values_list("title") # 反向查询 按表名:book queryResult=Author.objects
              .filter(name="小王")
              .values_list("book__title","book__price") # 练习3: 查询人民出版社出版过的所有书籍的名字以及作者的姓名 # 正向查询 queryResult=Book.objects
            .filter(publish__name="人民出版社")
            .values_list("title","authors__name") # 反向查询 queryResult=Publish.objects
              .filter(name="人民出版社")
              .values_list("book__title","book__authors__age","book__authors__name") # 练习4: 手机号以151开头的作者出版过的所有书籍名称以及出版社名称 queryResult=Book.objects
            .filter(authors__authorDetail__telephone__regex="151")
            .values_list("title","publish__name")

 注意:

反向查询时,如果定义了related_name ,则用related_name替换表名,例如: publish = ForeignKey(Blog, related_name=‘bookList‘):

# 练习1:  查询人民出版社出版过的所有书籍的名字与价格(一对多)
# 反向查询 不再按表名:book,而是related_name:bookList
 queryResult=Publish.objects.filter(name="人民出版社").values_list("bookList__title","bookList__price")

聚合查询与分组查询

先了解sql中的聚合与分组概念

聚合:aggregate(*args, **kwargs)

# 计算所有图书的平均价格
>>> from django.db.models import Avg
>>> Book.objects.all().aggregate(Avg(price))
{price__avg: 34.35}

aggregate()QuerySet 的一个终止子句,意思是说,它返回一个包含一些键值对的字典。键的名称是聚合值的标识符,值是计算出来的聚合值。键的名称是按照字段和聚合函数的名称自动生成出来的。如果你想要为聚合值指定一个名称,可以向聚合子句提供它。

>>> Book.objects.aggregate(average_price=Avg(price))
{average_price: 34.35}

如果你希望生成不止一个聚合,你可以向aggregate()子句中添加另一个参数。所以,如果你也想知道所有图书价格的最大值和最小值,可以这样查询:

>>> from django.db.models import Avg, Max, Min
>>> Book.objects.aggregate(Avg(price), Max(price), Min(price))
{price__avg: 34.35, price__max: Decimal(81.20), price__min: Decimal(12.99)}

分组:annotate() 

调用的QuerySet中每一个对象都生成一个独立的统计值(统计方法用聚合函数)。 

(1) 练习:统计每一本书的作者个数

bookList=Book.objects.annotate(authorsNum=Count(authors))
for book_obj in bookList:
    print(book_obj.title,book_obj.authorsNum)

sql语句:

SELECT 
"myapp_book"."nid", 
"myapp_book"."title", 
"myapp_book"."publishDate", 
"myapp_book"."price", 
"myapp_book"."pageNum", 
"myapp_book"."publish_id", 
COUNT("myapp_book_authors"."author_id") AS "authorsNum" 
FROM "myapp_book" LEFT OUTER JOIN "myapp_book_authors" 
ON ("myapp_book"."nid" = "myapp_book_authors"."book_id") 
GROUP BY "myapp_book"."nid"

解析:

‘‘‘
Book.objects.annotate(authorsNum=Count(‘authors‘))
拆分解析:
Book.objects等同于Book.objects.all(),翻译成的sql类似于: select id,name,..  from Book
这样得到的对象一定是每一本书对象,有n本书籍记录,就分n个组,不会有重复对象,每一组再由annotate分组统计。‘‘‘

(2) 如果想对所查询对象的关联对象进行聚合:

练习:统计每一个出版社的最便宜的书

publishList=Publish.objects.annotate(MinPrice=Min("book__price"))
 
for publish_obj in publishList:
    print(publish_obj.name,publish_obj.MinPrice)

annotate的返回值是querySet,如果不想遍历对象,可以用上valuelist:

queryResult= Publish.objects.annotate(MinPrice=Min("book__price")).values_list("name","MinPrice")
print(queryResult)

解析同上。

方式2: 

queryResult=Book.objects.values("publish__name").annotate(MinPrice=Min(price)) 
# 思考: if 有一个出版社没有出版过书会怎样?

解析:

‘‘‘
查看 Book.objects.values("publish__name")的结果和对应的sql语句
可以理解为values内的字段即group by的字段‘‘‘

(3) 统计每一本以py开头的书籍的作者个数:

 queryResult=Book.objects.filter(title__startswith="Py").annotate(num_authors=Count(authors))

(4) 统计不止一个作者的图书:

queryResult=Book.objects.annotate(num_authors=Count(authors)).filter(num_authors__gt=1)

(5) 根据一本图书作者数量的多少对查询集 QuerySet进行排序:

Book.objects.annotate(num_authors=Count(authors)).order_by(num_authors)

(6) 查询各个作者出的书的总价格:

# 按author表的所有字段 group by
queryResult=Author.objects
              .annotate(SumPrice=Sum("book__price"))
              .values_list("name","SumPrice") print(queryResult) # 按authors__name group by queryResult2=Book.objects.values("authors__name")
              .annotate(SumPrice=Sum("price"))
              .values_list("authors__name","SumPrice") print(queryResult2)

F查询与Q查询

F查询

在上面所有的例子中,我们构造的过滤器都只是将字段值与某个常量做比较。如果我们要对两个字段的值做比较,那该怎么做呢?

Django 提供 F() 来做这样的比较。F() 的实例可以在查询中引用字段,来比较同一个 model 实例中两个不同字段的值。

# 查询评论数大于收藏数的书籍

from django.db.models import F
Book.objects.filter(commnetNum__lt=F(keepNum))

Django 支持 F() 对象之间以及 F() 对象和常数之间的加减乘除和取模的操作。

# 查询评论数大于收藏数2倍的书籍
Book.objects.filter(commnetNum__lt=F(keepNum)*2)

修改操作也可以使用F函数,比如将每一本书的价格提高30元:

Book.objects.all().update(price=F("price")+30) 

Q查询

filter() 等方法中的关键字参数查询都是一起进行“AND” 的。 如果你需要执行更复杂的查询(例如OR 语句),你可以使用对象

from django.db.models import Q
Q(title__startswith=Py)

Q 对象可以使用& 和| 操作符组合起来。当一个操作符在两个Q 对象上使用时,它产生一个新的Q 对象。

bookList=Book.objects.filter(Q(authors__name="小王")|Q(authors__name="小李"))

等同于下面的SQL WHERE 子句:

WHERE name ="小王" OR name ="小李"

你可以组合& 和|  操作符以及使用括号进行分组来编写任意复杂的Q 对象。同时,Q 对象可以使用~ 操作符取反,这允许组合正常的查询和取反(NOT) 查询:

bookList=Book.objects.filter(Q(authors__name="小李") & ~Q(publishDate__year=2019)).values_list("title")

查询函数可以混合使用Q 对象和关键字参数。所有提供给查询函数的参数(关键字参数或Q 对象)都将"AND”在一起。但是,如果出现Q 对象,它必须位于所有关键字参数的前面。例如:

bookList=Book.objects.filter(Q(publishDate__year=2016) | Q(publishDate__year=2019),title__icontains="python")

修改表记录

author = Author.objects.get(id=4)
author.name = "王明"
author.save()

Publisher.objects.filter(id=1).update(name="清华出版社")

注意:

<1> 第二种方式修改不能用get的原因是:update是QuerySet对象的方法,get返回的是一个model对象,它没有update方法,而filter返回的是一个QuerySet对象(filter里面的条件可能有多个条件符合,比如name=‘alvin‘,可能有两个name=‘alvin‘的行数据)。

<2>在“插入和更新数据”小节中,我们有提到模型的save()方法,这个方法会更新一行里的所有列。 而某些情况下,我们只需要更新行里的某几列。

 

此外,update()方法对于任何结果集(QuerySet)均有效,这意味着你可以同时更新多条记录update()方法会返回一个整型数值,表示受影响的记录条数。

注意,这里因为update返回的是一个整形,所以没法用query属性;对于每次创建一个对象,想显示对应的raw sql,需要在settings加上日志记录部分

删除表记录

删除方法就是 delete()。它运行时立即删除对象而不返回任何值。例如:

obj.delete()

你也可以一次性删除多个对象。每个 QuerySet 都有一个 delete() 方法,它一次性删除 QuerySet 中所有的对象。

例如,下面的代码将删除 pub_date 是2018年的 Entry 对象:

Entry.objects.filter(pub_date__year=2018).delete()

要牢记这一点:无论在什么情况下,QuerySet 中的 delete() 方法都只使用一条 SQL 语句一次性删除所有对象,而并不是分别删除每个对象。如果你想使用在 model 中自定义的 delete() 方法,就要自行调用每个对象的delete 方法。(例如,遍历 QuerySet,在每个对象上调用 delete()方法),而不是使用 QuerySet 中的 delete()方法。

在 Django 删除对象时,会模仿 SQL 约束 ON DELETE CASCADE 的行为,换句话说,删除一个对象时也会删除与它相关联的外键对象。例如:

b = Blog.objects.get(pk=1)
# This will delete the Blog and all of its Entry objects.
b.delete()

要注意的是: delete() 方法是 QuerySet 上的方法,但并不适用于 Manager 本身。这是一种保护机制,是为了避免意外地调用 Entry.objects.delete() 方法导致 所有的 记录被误删除。如果你确认要删除所有的对象,那么你必须显式地调用:

Entry.objects.all().delete() 

如果不想级联删除,可以设置为:

pubHouse = models.ForeignKey(to=Publisher, on_delete=models.SET_NULL, blank=True, null=True)

 QuerySet

可切片

使用Python 的切片语法来限制查询集记录的数目 。它等同于SQL 的LIMIT 和OFFSET 子句。

>>> Entry.objects.all()[:5]      # (LIMIT 5)
>>> Entry.objects.all()[5:10]    # (OFFSET 5 LIMIT 5)

不支持负的索引(例如Entry.objects.all()[-1])。通常,查询集 的切片返回一个新的查询集 —— 它不会执行查询。

可迭代

articleList=models.Article.objects.all()

for article in articleList:
    print(article.title)

惰性查询

查询集 是惰性执行的 —— 创建查询集不会带来任何数据库的访问。你可以将过滤器保持一整天,直到查询集 需要求值时,Django 才会真正运行这个查询。

queryResult=models.Article.objects.all() # not hits database

print(queryResult) # hits database

for article in queryResult:
    print(article.title)    # hits database

 一般来说,只有在“请求”查询集 的结果时才会到数据库中去获取它们。当你确实需要结果时,查询集 通过访问数据库来求值。 关于求值发生的准确时间,参见何时计算查询集

缓存机制

每个查询集都包含一个缓存来最小化对数据库的访问。理解它是如何工作的将让你编写最高效的代码。

在一个新创建的查询集中,缓存为空。首次对查询集进行求值 —— 同时发生数据库查询 ——Django 将保存查询的结果到查询集的缓存中并返回明确请求的结果(例如,如果正在迭代查询集,则返回下一个结果)。接下来对该查询集 的求值将重用缓存的结果。

请牢记这个缓存行为,因为对查询集使用不当的话,它会坑你的。例如,下面的语句创建两个查询集,对它们求值,然后扔掉它们:

print([a.title for a in models.Article.objects.all()])
print([a.create_time for a in models.Article.objects.all()])

这意味着相同的数据库查询将执行两次,显然倍增了你的数据库负载。同时,还有可能两个结果列表并不包含相同的数据库记录,因为在两次请求期间有可能有Article被添加进来或删除掉。为了避免这个问题,只需保存查询集并重新使用它:

queryResult=models.Article.objects.all()
print([a.title for a in queryResult])
print([a.create_time for a in queryResult])

何时查询集不会被缓存?

查询集不会永远缓存它们的结果。当只对查询集的部分进行求值时会检查缓存, 如果这个部分不在缓存中,那么接下来查询返回的记录都将不会被缓存。所以,这意味着使用切片或索引来限制查询集将不会填充缓存。

例如,重复获取查询集对象中一个特定的索引将每次都查询数据库:

>>> queryset = Entry.objects.all()
>>> print queryset[5] # Queries the database
>>> print queryset[5] # Queries the database again

然而,如果已经对全部查询集求值过,则将检查缓存:

>>> queryset = Entry.objects.all()
>>> [entry for entry in queryset] # Queries the database
>>> print queryset[5] # Uses cache
>>> print queryset[5] # Uses cache

下面是一些其它例子,它们会使得全部的查询集被求值并填充到缓存中:

>>> [entry for entry in queryset]
>>> bool(queryset)
>>> entry in queryset
>>> list(queryset)

注:简单地打印查询集不会填充缓存。

queryResult=models.Article.objects.all()
print(queryResult) #  hits database
print(queryResult) #  hits database

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):
        return self.name


class Group(models.Model):
    name = models.CharField(max_length=128)
    members = models.ManyToManyField(Person, through=Membership)

    def __str__(self):
        return self.name


class Membership(models.Model):
    person = models.ForeignKey(to="Person", on_delete=models.CASCADE)
    group = models.ForeignKey(to="Group", on_delete=models.CASCADE)
    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模型中所需要的所有信息;而简单的addcreate 和赋值语句是做不到这一点的。所以它们不能在使用中介模型的多对多关系中使用。此时,唯一的办法就是创建中介模型的实例。

 remove()方法被禁用也是出于同样的原因。但是clear() 方法却是可用的。它可以清空某个实例所有的多对多关系:

>>> # Beatles have broken up
>>> beatles.members.clear()
>>> # Note that this deletes the intermediate model instances
>>> Membership.objects.all()
[]

查询优化

表数据

技术图片
from django.db import models
from django.contrib.auth.models import AbstractUser


class UserInfo(AbstractUser):
    """
    用户信息
    """
    nid = models.BigAutoField(primary_key=True)
    nickname = models.CharField(verbose_name=昵称, max_length=32)
    telephone = models.CharField(max_length=11, blank=True, null=True, unique=True, verbose_name=手机号码)
    avatar = models.FileField(verbose_name=头像, upload_to=avatar/, default="/avatar/default.png")
    create_time = models.DateTimeField(verbose_name=创建时间, auto_now_add=True)

    fans = models.ManyToManyField(verbose_name=粉丝们,
                                  to=UserInfo,
                                  through=UserFans,
                                  related_name=f,
                                  through_fields=(user, follower))

    def __str__(self):
        return self.username


class UserFans(models.Model):
    """
    互粉关系表
    """
    nid = models.AutoField(primary_key=True)
    user = models.ForeignKey(verbose_name=博主, to=UserInfo, to_field=nid, related_name=users,
                             on_delete=models.CASCADE)
    follower = models.ForeignKey(verbose_name=粉丝, to=UserInfo, to_field=nid, related_name=followers,
                                 on_delete=models.CASCADE)


class Blog(models.Model):
    """
    博客信息
    """
    nid = models.BigAutoField(primary_key=True)
    title = models.CharField(verbose_name=个人博客标题, max_length=64)
    site = models.CharField(verbose_name=个人博客后缀, max_length=32, unique=True)
    theme = models.CharField(verbose_name=博客主题, max_length=32)
    user = models.OneToOneField(to=UserInfo, to_field=nid, on_delete=models.CASCADE)

    def __str__(self):
        return self.title


class Category(models.Model):
    """
    博主个人文章分类表
    """
    nid = models.AutoField(primary_key=True)
    title = models.CharField(verbose_name=分类标题, max_length=32)

    blog = models.ForeignKey(verbose_name=所属博客, to=Blog, to_field=nid, on_delete=models.CASCADE)


class Article(models.Model):
    nid = models.BigAutoField(primary_key=True)
    title = models.CharField(max_length=50, verbose_name=文章标题)
    desc = models.CharField(max_length=255, verbose_name=文章描述)
    read_count = models.IntegerField(default=0)
    comment_count = models.IntegerField(default=0)
    up_count = models.IntegerField(default=0)
    down_count = models.IntegerField(default=0)
    category = models.ForeignKey(verbose_name=文章类型, to=Category, to_field=nid, null=True,
                                 on_delete=models.CASCADE)
    create_time = models.DateField(verbose_name=创建时间)
    blog = models.ForeignKey(verbose_name=所属博客, to=Blog, to_field=nid, on_delete=models.CASCADE)
    tags = models.ManyToManyField(
        to="Tag",
        through=Article2Tag,
        through_fields=(article, tag),
    )


class ArticleDetail(models.Model):
    """
    文章详细表
    """
    nid = models.AutoField(primary_key=True)
    content = models.TextField(verbose_name=文章内容, )

    article = models.OneToOneField(verbose_name=所属文章, to=Article, to_field=nid, on_delete=models.CASCADE)


class Comment(models.Model):
    """
    评论表
    """
    nid = models.BigAutoField(primary_key=True)
    article = models.ForeignKey(verbose_name=评论文章, to=Article, to_field=nid, on_delete=models.CASCADE)
    content = models.CharField(verbose_name=评论内容, max_length=255)
    create_time = models.DateTimeField(verbose_name=创建时间, auto_now_add=True)

    parent_comment = models.ForeignKey(self, blank=True, null=True, verbose_name=父级评论, on_delete=models.CASCADE)
    user = models.ForeignKey(verbose_name=评论者, to=UserInfo, to_field=nid, on_delete=models.CASCADE)

    up_count = models.IntegerField(default=0)

    def __str__(self):
        return self.content


class ArticleUpDown(models.Model):
    """
    点赞表
    """
    nid = models.AutoField(primary_key=True)
    user = models.ForeignKey(UserInfo, null=True, on_delete=models.CASCADE)
    article = models.ForeignKey("Article", null=True, on_delete=models.CASCADE)
    models.BooleanField(verbose_name=是否赞)


class CommentUp(models.Model):
    """
    点赞表
    """
    nid = models.AutoField(primary_key=True)
    user = models.ForeignKey(UserInfo, null=True, on_delete=models.CASCADE)
    comment = models.ForeignKey("Comment", null=True, on_delete=models.CASCADE)


class Tag(models.Model):
    nid = models.AutoField(primary_key=True)
    title = models.CharField(verbose_name=标签名称, max_length=32)
    blog = models.ForeignKey(verbose_name=所属博客, to=Blog, to_field=nid, on_delete=models.CASCADE)


class Article2Tag(models.Model):
    nid = models.AutoField(primary_key=True)
    article = models.ForeignKey(verbose_name=文章, to="Article", to_field=nid, on_delete=models.CASCADE)
    tag = models.ForeignKey(verbose_name=标签, to="Tag", to_field=nid, on_delete=models.CASCADE)
models.py

select_related

简单使用

对于一对一字段(OneToOneField)和外键字段(ForeignKey),可以使用select_related 来对QuerySet进行优化。

select_related 返回一个QuerySet,当执行它的查询时它沿着外键关系查询关联的对象的数据。它会生成一个复杂的查询并引起性能的损耗,但是在以后使用外键关系时将不需要数据库查询。

简单说,在对QuerySet使用select_related()函数后,Django会获取相应外键对应的对象,从而在之后需要的时候不必再查询数据库了。

下面的例子解释了普通查询和select_related() 查询的区别。

查询id=2的文章的分类名称,下面是一个标准的查询:

# Hits the database.
article=models.Article.objects.get(nid=2)

# Hits the database again to get the related Blog object.
print(article.category.title)

 SQL语句:

技术图片
SELECT 
    "blog_article"."nid", 
    "blog_article"."title", 
    "blog_article"."desc", 
    "blog_article"."read_count", 
    "blog_article"."comment_count", 
    "blog_article"."up_count", 
    "blog_article"."down_count", 
    "blog_article"."category_id", 
    "blog_article"."create_time",
     "blog_article"."blog_id", 
     "blog_article"."article_type_id" 
             FROM "blog_article" 
             WHERE "blog_article"."nid" = 2; args=(2,)

SELECT
     "blog_category"."nid", 
     "blog_category"."title", 
     "blog_category"."blog_id"
              FROM "blog_category" 
              WHERE "blog_category"."nid" = 4; args=(4,)
SQL语句

如果我们使用select_related()函数:

articleList = models.Article.objects.select_related("category").all()

for article_obj in articleList:
    #  Doesn‘t hit the database, because article_obj.category
    #  has been prepopulated in the previous query.
    print(article_obj.category.title)

SQL语句:

技术图片
SELECT 
     "blog_article"."nid", 
     "blog_article"."title", 
     "blog_article"."desc",
     "blog_article"."read_count", 
     "blog_article"."comment_count", 
     "blog_article"."up_count", 
     "blog_article"."down_count",
     "blog_article"."category_id", 
     "blog_article"."create_time", 
     "blog_article"."blog_id", 
     "blog_article"."article_type_id", 

     "blog_category"."nid", 
     "blog_category"."title", 
     "blog_category"."blog_id" 

FROM "blog_article" 
LEFT OUTER JOIN "blog_category" ON ("blog_article"."category_id" = "blog_category"."nid"); 
SQL语句

多外键查询

这是针对category的外键查询,如果是另外一个外键呢?让我们一起看下:

article=models.Article.objects.select_related("category").get(nid=1)
print(article.articledetail)

 观察logging结果,发现依然需要查询两次,所以需要改为:

article=models.Article.objects.select_related("category","articledetail").get(nid=1)
print(article.articledetail)

 或者:

article=models.Article.objects.select_related("category").select_related("articledetail").get(nid=1) 
print(article.articledetail)

 SQL语句:

技术图片
SELECT 
     "blog_article"."nid", 
     "blog_article"."title", 
     ......

     "blog_category"."nid", 
     "blog_category"."title",
     "blog_category"."blog_id", 

     "blog_articledetail"."nid",
     "blog_articledetail"."content",
     "blog_articledetail"."article_id" 

    FROM "blog_article" 
    LEFT OUTER JOIN "blog_category" ON ("blog_article"."category_id" = "blog_category"."nid")
    LEFT OUTER JOIN "blog_articledetail" ON ("blog_article"."nid" = "blog_articledetail"."article_id") 
    WHERE "blog_article"."nid" = 1; args=(1,)
SQL语句

深层查询

# 查询id=1的文章的用户姓名

article = models.Article.objects.select_related("blog").get(nid=1)
print(article.blog.user.username)

 依然需要查询两次:

技术图片
SELECT 
    "blog_article"."nid", 
    "blog_article"."title", 
    ......

     "blog_blog"."nid", 
     "blog_blog"."title", 

   FROM "blog_article" INNER JOIN "blog_blog" ON ("blog_article"."blog_id" = "blog_blog"."nid") 
   WHERE "blog_article"."nid" = 1; 


SELECT 
    "blog_userinfo"."password", 
    "blog_userinfo"."last_login",
    ......

FROM "blog_userinfo" 
WHERE "blog_userinfo"."nid" = 1; 
SQL语句

 这是因为第一次查询没有query到userInfo表,所以,修改如下:

article=models.Article.objects.select_related("blog__user").get(nid=1)
print(article.blog.user.username)

SQL语句:

技术图片
SELECT 

"blog_article"."nid", "blog_article"."title",
......

 "blog_blog"."nid", "blog_blog"."title", 
......

 "blog_userinfo"."password", "blog_userinfo"."last_login",
......

FROM "blog_article"

INNER JOIN "blog_blog" ON ("blog_article"."blog_id" = "blog_blog"."nid") 

INNER JOIN "blog_userinfo" ON ("blog_blog"."user_id" = "blog_userinfo"."nid") 
WHERE "blog_article"."nid" = 1; 
SQL语句

总结

  1. select_related主要针一对一和多对一关系进行优化。
  2. select_related使用SQL的JOIN语句进行优化,通过减少SQL查询的次数来进行优化、提高性能。
  3. 可以通过可变长参数指定需要select_related的字段名。也可以通过使用双下划线“__”连接字段名来实现指定的递归查询。
  4. 没有指定的字段不会缓存,没有指定的深度不会缓存,如果要访问的话Django会再次进行SQL查询。
  5. 也可以通过depth参数指定递归的深度,Django会自动缓存指定深度内所有的字段。如果要访问指定深度外的字段,Django会再次进行SQL查询。
  6. 也接受无参数的调用,Django会尽可能深的递归查询所有的字段。但注意有Django递归的限制和性能的浪费。
  7. Django >= 1.7,链式调用的select_related相当于使用可变长参数。Django < 1.7,链式调用会导致前边的select_related失效,只保留最后一个。

prefetch_related()

对于多对多字段(ManyToManyField)和一对多字段,可以使用prefetch_related()来进行优化。

prefetch_related()和select_related()的设计目的很相似,都是为了减少SQL查询的数量,但是实现的方式不一样。后者是通过JOIN语句,在SQL查询内解决问题。但是对于多对多关系,使用SQL语句解决就显得有些不太明智,因为JOIN得到的表将会很长,会导致SQL语句运行时间的增加和内存占用的增加。若有n个对象,每个对象的多对多字段对应Mi条,就会生成Σ(n)Mi 行的结果表。

prefetch_related()的解决方法是,分别查询每个表,然后用Python处理他们之间的关系。

# 查询所有文章关联的所有标签
article_obj = models.Article.objects.all()
for i in article_obj:
    print(i.tags.all())  # 4篇文章: hits database 5

改为prefetch_related:

# 查询所有文章关联的所有标签
article_obj = models.Article.objects.prefetch_related("tags").all()
for i in article_obj:
    print(i.tags.all())  # 3篇文章: hits database 2

SQL语句:

技术图片
SELECT "blog_article"."nid",
               "blog_article"."title", 
               ......

FROM "blog_article";


SELECT
  ("blog_article2tag"."article_id") AS "_prefetch_related_val_article_id", 
  "blog_tag"."nid", 
  "blog_tag"."title",
  "blog_tag"."blog_id"
   FROM "blog_tag"
  INNER JOIN "blog_article2tag" ON ("blog_tag"."nid" = "blog_article2tag"."tag_id") 
  WHERE "blog_article2tag"."article_id" IN (1, 2, 3, 4); 
SQL语句

extra

extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)

有些情况下,Django的查询语法难以简单的表达复杂的 WHERE 子句,对于这种情况, Django 提供了 extra() QuerySet修改机制 — 它能在 QuerySet生成的SQL从句中注入新子句

extra可以指定一个或多个 参数,例如 selectwhere or tables这些参数都不是必须的,但是你至少要使用一个!要注意这些额外的方式对不同的数据库引擎可能存在移植性问题.(因为你在显式的书写SQL语句),除非万不得已,尽量避免这样做

参数之select

The select 参数可以让你在 SELECT 从句中添加其他字段信息,它应该是一个字典,存放着属性名到 SQL 从句的映射。

queryResult=models.Article.objects.extra(select={is_recent: "create_time > ‘2019-09-05‘"})

结果集中每个 Entry 对象都有一个额外的属性is_recent, 它是一个布尔值,表示 Article对象的create_time 是否晚于2017-09-05.

练习:

# in sqlite:
article_obj = models.Article.objects.filter(nid=1).extra(
    select={"standard_time": "strftime(‘%%Y-%%m-%%d‘,create_time)"}).values("standard_time", "nid", "title")
print(article_obj)
# <QuerySet [{‘title‘: ‘MongoDb 入门教程‘, ‘standard_time‘: ‘2019-09-03‘, ‘nid‘: 1}]>

参数之where / tables

您可以使用where定义显式SQL WHERE子句 - 也许执行非显式连接。您可以使用tables手动将表添加到SQL FROM子句。

wheretables都接受字符串列表。所有where参数均为“与”任何其他搜索条件。

举例来讲:

queryResult=models.Article.objects.extra(where=[nid in (1,3) OR title like "py%" ,nid>2])

整体插入

创建对象时,尽可能使用bulk_create()来减少SQL查询的数量。例如:

Entry.objects.bulk_create([
    Entry(headline="Python 3.6 Released"),
    Entry(headline="Python 3.7 Planned")
])

更优于:

Entry.objects.create(headline="Python 3.6 Released")
Entry.objects.create(headline="Python 3.7 Planned")

注意该方法有很多注意事项,所以确保它适用于你的情况。

这也可以用在ManyToManyFields中,所以:

my_band.members.add(me, my_friend)

更优于:

my_band.members.add(me)
my_band.members.add(my_friend)

其中Bands和Artists具有多对多关联。

以上是关于django model的主要内容,如果未能解决你的问题,请参考以下文章

Django REST framework 基本组件

[TimLinux] Django 信号

如何在 Django Summernote 中显示编程片段的代码块?

Django的models实现分析

Django rest_framewok框架的基本组件

django.core.exceptions.ImproperlyConfigured: Requested setting DEFAULT_INDEX_TABLESPACE的解决办法(转)(代码片段