Django之ORM常用操作

ORM常用操作

官网文档

最常用的操作

<1> all():                 查询所有结果,QuerySet  对象列表

<2> get(**kwargs):         返回与所给筛选条件相匹配的对象，返回结果有且只有一个，如果符合筛选条件的对象超过一个或者没有都会抛出错误。
 
<3> filter(**kwargs):      它包含了与所给筛选条件相匹配的对象
 
<4> exclude(**kwargs):     它包含了与所给筛选条件不匹配的对象
 
<5> values(*field):        返回一个ValueQuerySet——一个特殊的QuerySet，运行后得到的并不是一系列model的实例化对象，而是一个可迭代的字典序列 不给参数的话返回所有字段和值
 
<6> values_list(*field):   它与values()非常相似，它返回的是一个元组序列，values返回的是一个字典序列  不给参数的话返回所有字段的值
 
<7> order_by(*field):      对查询结果排序 默认升序  -降序
 
<8> reverse():             对查询结果反向排序，请注意reverse()通常只能在具有已定义顺序的QuerySet上调用(在model类的Meta中指定ordering或调用order_by()方法)。
 
<9> distinct():            从返回结果中剔除重复纪录(如果你查询跨越多个表，可能在计算QuerySet时得到重复的结果。此时可以使用distinct()，注意只有在PostgreSQL中支持按字段去重。)
 
<10> count():              返回数据库中匹配查询(QuerySet)的对象数量。
 
<11> first():              返回第一条记录
 
<12> last():               返回最后一条记录
 
<13> exists():             如果QuerySet包含数据，就返回True，否则返回False

分类记忆:

方法	返回类型
all()	QuerySet对象列表
filter()	QuerySet对象列表
exclude()	QuerySet对象列表
order_by()	QuerySet对象列表
reverse()	QuerySet对象列表
distinct()	QuerySet对象列表
values()	QuerySet 字典列表
values_list()	QuerySet 元组列表
get()	对象
first()	对象
last()	对象
exists()	Bool值

单表查询之神奇的双下划线

ret = models.Person.objects.filter(pk__gt=1)  # 大于 greater than
ret = models.Person.objects.filter(pk__lt=5)  # 小于 less than
ret = models.Person.objects.filter(pk__gte=1)  # 大于等于 greater than equal
ret = models.Person.objects.filter(pk__lte=5)  # 小于等于 less than  equal

ret = models.Person.objects.filter(pk__range=[1,5])  # 范围 相当于between and 包含头尾

ret = models.Person.objects.filter(pk__in=[1,5,7,9])  # in 范围

ret = models.Person.objects.filter(name__contains='sun')  # like 包含
ret = models.Person.objects.filter(name__icontains='sun')  # like ignore 忽略大小写

ret = models.Person.objects.filter(name__startswith='a')  # 以什么开头
ret = models.Person.objects.filter(name__istartswith='a')  # 以什么开头 ignore 忽略大小写

ret = models.Person.objects.filter(name__endswith='x')  # 以什么结尾
ret = models.Person.objects. filter(name__iendswith='a')  # 以什么结尾 ignore 忽略大小写

ret = models.Person.objects.filter(birth__year='2020')
ret = models.Person.objects.filter(birth__contains='2020-10')

ret = models.Person.objects.filter(age__isnull=False)  # 为null和''空字符串不一样

Foreign Key操作

正向查找

对象查找

语法：

对象.关联字段.字段

示例：

book_obj = models.Book.objects.first()  # 第一本书对象
print(book_obj.publisher)  # 得到这本书关联的出版社对象
print(book_obj.publisher_id)  # 外键字段的id
print(book_obj.publisher.name)  # 得到出版社对象的名称

字段查找

语法：

关联字段__字段

示例：

print(models.Book.objects.filter(publisher__name__contains='沙'))

# 指定related_query_name时,优先级最高
# 查询所有出版社的名字中包含"沙"的出版社所出版的书籍
# 转化为sql语句: 连表后,对publisher__name进行筛选,然后展示书籍信息

反向操作

对象查找

语法：

obj.表名_set

示例：

publisher_obj = models.Publisher.objects.first()  # 找到第一个出版社对象
obj = publisher_obj.book_set         # 关系管理对象(一对多时)
books = publisher_obj.book_set.all()  # 找到第一个出版社出版的所有书
titles = books.values_list("title")  # 找到第一个出版社出版的所有书的书名
# 不指定related_name时,类名小写_set
# 设置related_name='books': publisher_obj.books.all()     

字段查找

语法：

表名__字段

示例：

print(models.Publisher.objects.filter(book__title__contains='孙'))
# 找到所有书名中包含"孙"的书籍的出版社

Many To Many Field

class Related Manager

"关联管理器"是在一对多或者多对多的关联上下文中使用的管理器。

它存在于下面两种情况：

1. 外键关系的反向查询
2. 多对多关联关系

简单来说就是当 点后面的对象 可能存在多个的时候就可以使用以下的方法。

对象查找

# 正向
book_obj = models.Book.objects.get(pk=1)
print(book_obj.author)         # 关系管理对象
print(book_obj.author.all())   # 每一个对象

# 反向
author_obj = models.Author.objects.get(pk=1)
print(author_obj.book_set)     # 关系管理对象
print(author_obj.book_set.all())  # 每一个对象

字段查找

# 正向
print(models.Book.objects.filter(author__age__gt=10))

# 反向
print(models.Author.objects.filter(book__title='悟空传'))

方法

all()

获取所有对象 Query set

book_obj = models.Book.objects.get(pk=1)
print(book_obj.author.all())
author_obj = models.Author.objects.get(pk=1)
print(author_obj.book_set.all())

set()

设置多对多关系,可以放id列表,也可以放对象列表

book_obj.author.set([1, 3])   # id的列表

book_obj.author.set(models.Author.objects.filter(pk__in=[2, 3]))   # 对象列表

# 删除之前的记录,重新添加,不是修改

add()

添加多对多关系,可以放id,也可以放对象,注意不是列表

book_obj.author.add(1, 4)   # id

book_obj.author.add(*models.Author.objects.filter(pk__in=[1, 2, 3, 4]))    # 用*将对象列表打散成单个对象

remove()

从关联对象集中移除执行的model对象,用法同add()

book_obj = models.Book.objects.first()
book_obj.authors.remove(2, 3)
book_obj.authors.remove(*models.Author.objects.filter(pk__in=[1, 2, 3, 4]))

clear()

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

book_obj = models.Book.objects.first()
book_obj.authors.clear()

create()

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

book_obj = models.Book.objects.get(pk=1)
obj = book_obj.author.create(name='猪八戒', age=20, phone='12345678912')

注意：

对于Foreign Key对象:

• clear()和remove()方法仅在null=True时存在
• set()和add()只能添加对象
• create()时,可以另指定外键关联对象

举个例子：

Foreign Key字段没设置null=True时，

class Book(models.Model):
    title = models.CharField(max_length=32)
    publisher = models.ForeignKey(to=Publisher)

没有clear()和remove()方法：

>>> models.Publisher.objects.first().book_set.clear()
Traceback (most recent call last):
  File "<input>", line 1, in <module>
AttributeError: 'RelatedManager' object has no attribute 'clear'

当Foreign Key字段设置null=True时，

class Book(models.Model):
    name = models.CharField(max_length=32)
    publisher = models.ForeignKey(to=Class, null=True)

此时就有clear()和remove()方法：

models.Publisher.objects.first().book_set.clear()

注意：

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

聚合查询和分组查询

聚合

aggregate()是QuerySet 的一个终止子句，意思是说，它返回一个包含一些键值对的字典。

键的名称是聚合值的标识符，值是计算出来的聚合值。键的名称是按照字段和聚合函数的名称自动生成出来的。

用到的内置函数：

from django.db.models import Avg, Sum, Max, Min, Count

示例：

models.Book.objects.aggregate(Max('price'))
# {'price__max': Decimal('39.99')}
# 查询所有书中最高的价格

如果想要为聚合值指定一个名称，可以向聚合子句提供它。

models.Book.objects.aggregate(max=Max('price'))
# {'max': Decimal('39.99')}

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

models.Book.objects.aggregate(max=Max('price'), min=Min('price'), avg=Avg('price'))
# {'max': Decimal('39.99'), 'min': Decimal('0.99'), 'avg': 15.9675}

分组

先复习一下SQL语句的分组。

假设现在有一张公司职员表：

使用原生SQL语句，按照部门分组求平均工资：

select dept,AVG(salary) from employee group by dept;

ORM查询:

注意: annotate是注释,就像是在原表后新加了一列

models.Employee.objects.values("dept").annotate(avg=Avg("salary")
# 按照"dept"进行分组,然后查询"dept"和每组的Avg("salary")

连表查询的分组：

SQL查询：

select dept.name,AVG(salary) from employee inner join dept on (employee.dept_id=dept.id) group by dept_id;

ORM查询：

models.Dept.objects.annotate(avg=Avg("employee__salary")).values("name", "avg")
# Dept left join employee, 按照dept.id进行分组, 给每组加上一个新字段avg=Avg("employee__salary"), 然后拿出每组的"name", "avg"

更多示例：

示例1：统计每一本书的作者个数

print(models.Book.objects.annotate(count=Count('author__name')).values('title', 'count'))

示例2：统计出每个出版社的最便宜的书的价格

方法一:

print(models.Publisher.objects.annotate(min=Min('book__price')).values('name', 'min'))
# Publisher left join book,按照Publisher.id进行分组,然后拿出每组的出版社名字和最小的书籍价格

方法二:

print(models.Book.objects.values('publisher__name').annotate(min=Min('price')))
# book left join Publisher,按照publisher.name进行分组,然后拿出publisher.name和最小的书籍价格

示例3：统计不止一个作者的图书

print(models.Book.objects.annotate(count=Count('author__name')).filter(count__gt=1).values('title', 'count'))

示例4：根据一本图书作者数量的多少对查询集 QuerySet进行排序

print(models.Book.objects.annotate(count=Count('author__id')).order_by('count').values('title', 'count'))

示例5：查询各个作者出的书的总价格

print(models.Author.objects.annotate(sum=Sum('book__price')).values('name', 'sum'))

F查询和Q查询

F查询

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

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

示例1：

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

from django.db.models import F
models.Book.objects.filter(comment__gt=F('collect'))

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

models.Book.objects.filter(comment__gt=F('collect') + 2)

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

models.Book.objects.update(price=F('price') + 30)

引申：

如果要修改char字段咋办？

如：把所有书名后面加上(第一版)

from django.db.models.functions import Concat
from django.db.models import Value
models.Book.objects.update(title=Concat(F("title"), Value("("), Value("第一版"), Value(")")))

Q查询

filter() 等方法中的关键字参数查询都是一起进行and的。 如果需要执行更复杂的查询（例如or语句），可以使用Q对象。

示例1：

查询作者名是小仙女或小魔女的书籍:

models.Book.objects.filter(Q(authors__name="小仙女")|Q(authors__name="小魔女"))

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

示例：查询作者名字是小仙女并且不是2018年出版的书的书名。

models.Book.objects.filter(Q(author__name="小仙女") & ~Q(publish_date__year=2018)).values_list("title")

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

例如：查询出版年份是2017或2018，书名中带物语的所有书。

models.Book.objects.filter(Q(publish_date__year=2018) | Q(publish_date__year=2017), title__icontains="物语")

事务

import os

if __name__ == '__main__':
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ORM.settings")
    import django
    django.setup()

    import datetime
    from app01 import models

    try:
        from django.db import transaction
        with transaction.atomic():
            new_publisher = models.Publisher.objects.create(name="火星出版社")
            models.Book.objects.create(title="橘子物语", publish_date=datetime.date.today(), publisher_id=10)  # 指定一个不存在的出版社id
    except Exception as e:
        print(str(e))

其他的操作

Django ORM执行原生SQL

# extra
# 在QuerySet的基础上继续执行子语句
# extra(self, select=None, where=None, params=None, tables=None, order_by=None, select_params=None)

# select和select_params是一组，where和params是一组，tables用来设置from哪个表
# Entry.objects.extra(select={'new_id': "select col from sometable where othercol > %s"}, select_params=(1,))
# Entry.objects.extra(where=['headline=%s'], params=['Lennon'])
# Entry.objects.extra(where=["foo='a' OR bar = 'a'", "baz = 'a'"])
# Entry.objects.extra(select={'new_id': "select id from tb where id > %s"}, select_params=(1,), order_by=['-nid'])

举个例子：
models.UserInfo.objects.extra(
                    select={'newid':'select count(1) from app01_usertype where id>%s'},
                    select_params=[1,],
                    where = ['age>%s'],
                    params=[18,],
                    order_by=['-age'],
                    tables=['app01_usertype']
                )
                """
                select 
                    app01_userinfo.id,
                    (select count(1) from app01_usertype where id>1) as newid
                from app01_userinfo,app01_usertype
                where 
                    app01_userinfo.age > 18
                order by 
                    app01_userinfo.age desc
                """


# 执行原生SQL
# 更高灵活度的方式执行原生SQL语句
# from django.db import connection, connections
# cursor = connection.cursor()  # cursor = connections['default'].cursor()
# cursor.execute("""SELECT * from auth_user where id = %s""", [1])
# row = cursor.fetchone()

Query Set方法大全

##################################################################
# PUBLIC METHODS THAT ALTER ATTRIBUTES AND RETURN A NEW QUERYSET #
##################################################################

def all(self)
    # 获取所有的数据对象

def filter(self, *args, **kwargs)
    # 条件查询
    # 条件可以是：参数，字典，Q

def exclude(self, *args, **kwargs)
    # 条件查询
    # 条件可以是：参数，字典，Q

def select_related(self, *fields)
    性能相关：表之间进行join连表操作，一次性获取关联的数据。

    总结：
    1. select_related主要针一对一和多对一关系进行优化。
    2. select_related使用SQL的JOIN语句进行优化，通过减少SQL查询的次数来进行优化、提高性能。

def prefetch_related(self, *lookups)
    性能相关：多表连表操作时速度会慢，使用其执行多次SQL查询在Python代码中实现连表操作。

    总结：
    1. 对于多对多字段（ManyToManyField）和一对多字段，可以使用prefetch_related()来进行优化。
    2. prefetch_related()的优化方式是分别查询每个表，然后用Python处理他们之间的关系。

def annotate(self, *args, **kwargs)
    # 用于实现聚合group by查询

    from django.db.models import Count, Avg, Max, Min, Sum

    v = models.UserInfo.objects.values('u_id').annotate(uid=Count('u_id'))
    # SELECT u_id, COUNT(ui) AS `uid` FROM UserInfo GROUP BY u_id

    v = models.UserInfo.objects.values('u_id').annotate(uid=Count('u_id')).filter(uid__gt=1)
    # SELECT u_id, COUNT(ui_id) AS `uid` FROM UserInfo GROUP BY u_id having count(u_id) > 1

    v = models.UserInfo.objects.values('u_id').annotate(uid=Count('u_id',distinct=True)).filter(uid__gt=1)
    # SELECT u_id, COUNT( DISTINCT ui_id) AS `uid` FROM UserInfo GROUP BY u_id having count(u_id) > 1

def distinct(self, *field_names)
    # 用于distinct去重
    models.UserInfo.objects.values('nid').distinct()
    # select distinct nid from userinfo

    注：只有在PostgreSQL中才能使用distinct进行去重

def order_by(self, *field_names)
    # 用于排序
    models.UserInfo.objects.all().order_by('-id','age')

def extra(self, select=None, where=None, params=None, tables=None, order_by=None, select_params=None)
    # 构造额外的查询条件或者映射，如：子查询

    Entry.objects.extra(select={'new_id': "select col from sometable where othercol > %s"}, select_params=(1,))
    Entry.objects.extra(where=['headline=%s'], params=['Lennon'])
    Entry.objects.extra(where=["foo='a' OR bar = 'a'", "baz = 'a'"])
    Entry.objects.extra(select={'new_id': "select id from tb where id > %s"}, select_params=(1,), order_by=['-nid'])

 def reverse(self):
    # 倒序
    models.UserInfo.objects.all().order_by('-nid').reverse()
    # 注：如果存在order_by，reverse则是倒序，如果多个排序则一一倒序


 def defer(self, *fields):
    models.UserInfo.objects.defer('username','id')
    或
    models.UserInfo.objects.filter(...).defer('username','id')
    #映射中排除某列数据

 def only(self, *fields):
    #仅取某个表中的数据
     models.UserInfo.objects.only('username','id')
     或
     models.UserInfo.objects.filter(...).only('username','id')

 def using(self, alias):
     指定使用的数据库，参数为别名（setting中的设置）


##################################################
# PUBLIC METHODS THAT RETURN A QUERYSET SUBCLASS #
##################################################

def raw(self, raw_query, params=None, translations=None, using=None):
    # 执行原生SQL
    models.UserInfo.objects.raw('select * from userinfo')

    # 如果SQL是其他表时，必须将名字设置为当前UserInfo对象的主键列名
    models.UserInfo.objects.raw('select id as nid from 其他表')

    # 为原生SQL设置参数
    models.UserInfo.objects.raw('select id as nid from userinfo where nid>%s', params=[12,])

    # 将获取的到列名转换为指定列名
    name_map = {'first': 'first_name', 'last': 'last_name', 'bd': 'birth_date', 'pk': 'id'}
    Person.objects.raw('SELECT * FROM some_other_table', translations=name_map)

    # 指定数据库
    models.UserInfo.objects.raw('select * from userinfo', using="default")

    ################### 原生SQL ###################
    from django.db import connection, connections
    cursor = connection.cursor()  # cursor = connections['default'].cursor()
    cursor.execute("""SELECT * from auth_user where id = %s""", [1])
    row = cursor.fetchone() # fetchall()/fetchmany(..)


def values(self, *fields):
    # 获取每行数据为字典格式

def values_list(self, *fields, **kwargs):
    # 获取每行数据为元祖

def dates(self, field_name, kind, order='ASC'):
    # 根据时间进行某一部分进行去重查找并截取指定内容
    # kind只能是："year"（年）, "month"（年-月）, "day"（年-月-日）
    # order只能是："ASC"  "DESC"
    # 并获取转换后的时间
        - year : 年-01-01
        - month: 年-月-01
        - day  : 年-月-日

    models.DatePlus.objects.dates('ctime','day','DESC')

def datetimes(self, field_name, kind, order='ASC', tzinfo=None):
    # 根据时间进行某一部分进行去重查找并截取指定内容，将时间转换为指定时区时间
    # kind只能是 "year", "month", "day", "hour", "minute", "second"
    # order只能是："ASC"  "DESC"
    # tzinfo时区对象
    models.DDD.objects.datetimes('ctime','hour',tzinfo=pytz.UTC)
    models.DDD.objects.datetimes('ctime','hour',tzinfo=pytz.timezone('Asia/Shanghai'))

    """
    pip3 install pytz
    import pytz
    pytz.all_timezones
    pytz.timezone(‘Asia/Shanghai’)
    """

def none(self):
    # 空QuerySet对象


####################################
# METHODS THAT DO DATABASE QUERIES #
####################################

def aggregate(self, *args, **kwargs):
   # 聚合函数，获取字典类型聚合结果
   from django.db.models import Count, Avg, Max, Min, Sum
   result = models.UserInfo.objects.aggregate(k=Count('u_id', distinct=True), n=Count('nid'))
   ===> {'k': 3, 'n': 4}

def count(self):
   # 获取个数

def get(self, *args, **kwargs):
   # 获取单个对象

def create(self, **kwargs):
   # 创建对象

def bulk_create(self, objs, batch_size=None):
    # 批量插入
    # batch_size表示一次插入的个数
    objs = [
        models.DDD(name='r11'),
        models.DDD(name='r22')
    ]
    models.DDD.objects.bulk_create(objs, 10)

def get_or_create(self, defaults=None, **kwargs):
    # 如果存在，则获取，否则，创建
    # defaults 指定创建时，其他字段的值
    obj, created = models.UserInfo.objects.get_or_create(username='root1', defaults={'email': '1111111','u_id': 2, 't_id': 2})

def update_or_create(self, defaults=None, **kwargs):
    # 如果存在，则更新，否则，创建
    # defaults 指定创建时或更新时的其他字段
    obj, created = models.UserInfo.objects.update_or_create(username='root1', defaults={'email': '1111111','u_id': 2, 't_id': 1})

def first(self):
   # 获取第一个

def last(self):
   # 获取最后一个

def in_bulk(self, id_list=None):
   # 根据主键ID进行查找
   id_list = [11,21,31]
   models.DDD.objects.in_bulk(id_list)

def delete(self):
   # 删除

def update(self, **kwargs):
    # 更新

def exists(self):
   # 是否有结果

Django终端打印SQL语句

在Django项目的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',
        },
    }
}

即为Django项目配置上一个名为django.db.backends的logger实例即可查看翻译后的SQL语句。

在Python脚本中调用Django环境

import os

if __name__ == '__main__':
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ORM.settings")
    import django
    django.setup()

    from app01 import models

    books = models.Book.objects.all()
    print(books)