yyz notes
YiZhang-You
2023-05-18
目录

模型的元数据Meta

模型的元数据，指的是“除了字段外的所有内容”，例如排序方式、数据库表名、人类可读的单数或者复数名等等。所有的这些都是非必须的，甚至元数据本身对模型也是非必须的。但是，我要说但是，有些元数据选项能给予你极大的帮助，在实际使用中具有重要的作用，是实际应用的‘必须’。

想在模型中增加元数据，方法很简单，在模型类中添加一个子类，名字是固定的Meta，然后在这个Meta类下面增加各种元数据选项或者说设置项。参考下面的例子：

from django.db import models

class Ox(models.Model):
    horn_length = models.IntegerField()

    class Meta:         # 注意，是模型的子类，要缩进！
        ordering = ["horn_length"]
        verbose_name_plural = "oxen"

# 上面的例子中，我们为模型Ox增加了两个元数据‘ordering’和‘verbose_name_plural’，分别表示排序和复数名
1
2
3
4
5
6
7
8
9
10
class Person(models.Model):
    pid = models.AutoField(primary_key=True)  #设置主键， 如果没有设置，会自动添加
    name = models.CharField(verbose_name="姓名",db_column='nick',max_length=32, blank=True,unique=True) # varchar(32)
    age = models.IntegerField(null=True,default=18) #整形
    birth = models.DateTimeField(auto_now_add=True) #新创建对象时自动添加当前时间
    # birth = models.DateTimeField(auto_now=True) #修改对象的时候改变时间
    sex = models.BooleanField(choices=((True,"男"),(False,"女"))) #0为True  1为False
    #添加自定义的字段
    cname = MyCharField(max_length=11)  #char(11)

    class Meta:
        # 数据库中生成的表名称 默认 app名称 + 下划线 + 类名(右边这个Database里面的数据表)
        db_table = "Person"
        
        # admin中显示的表名称
        verbose_name = '个人信息'

        # verbose_name加s   admin中显示
        verbose_name_plural = '所有用户信息'

        # 联合索引  会和上面的unique=True冲突，所以一定要看好
        index_together = [
            ("name", "age"),  # 应为两个存在的字段
        ]

        # 联合唯一索引  会和上面的unique=True冲突，所以一定要看好
        unique_together = (("name", "age"),)  # 应为两个存在的字段
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

强调：每个模型都可以有自己的元数据类，每个元数据类也只对自己所在模型起作用。

# abstract 抽象模型

如果abstract=True，那么模型会被认为是一个抽象模型。抽象模型本身不实际生成数据库表，而是作为其它模型的父类，被继承使用。具体内容可以参考Django模型的继承。

# app_label

如果定义了模型的app没有在INSTALLED_APPS中注册，则必须通过此元选项声明它属于哪个app，例如：

app_label = 'myapp'

# base_manager_name

模型的_base_manager管理器的名字，默认是'objects'。模型管理器是Django为模型提供的API所在。

# db_table

指定在数据库中，当前模型生成的数据表的表名。比如：

db_table = 'my_freinds'

如果你没有指定这个选项，那么Django会自动使用app名和模型名，通过下划线连接生成数据表名，比如app_book。

不要使用SQL语言或者Python的保留字，注意冲突。

友情建议：使用MySQL和MariaDB数据库时，db_table用小写英文。

# db_tablespace

自定义数据库表空间的名字。默认值是项目的DEFAULT_TABLESPACE配置项指定的值。

# default_manager_name

模型的_default_manager管理器的名字。

默认情况下，从一个模型反向关联设置有关系字段的源模型，我们使用<model_name>_set，也就是源模型的名字+下划线+set。

这个元数据选项可以让你自定义反向关系名，同时也影响反向查询关系名！看下面的例子：

from django.db import models

class Foo(models.Model):
    pass

class Bar(models.Model):
    foo = models.ForeignKey(Foo, on_delete=models.CASCADE)

    class Meta:
        default_related_name = 'bars'   # 关键在这里
1
2
3
4
5
6
7
8
9
10

具体的使用差别如下：

>>> bar = Bar.objects.get(pk=1)
>>> # 不能再使用"bar"作为反向查询的关键字了。
>>> Foo.objects.get(bar=bar)
>>> # 而要使用你自己定义的"bars"了。
>>> Foo.objects.get(bars=bar)
1
2
3
4
5

# get_latest_by

Django管理器给我们提供有latest()和earliest()方法，分别表示获取最近一个和最前一个数据对象。但是，如何来判断最近一个和最前面一个呢？也就是根据什么来排序呢？

get_latest_by元数据选项帮你解决这个问题，它可以指定一个类似 DateField、DateTimeField或者IntegerField这种可以排序的字段，作为latest()和earliest()方法的排序依据，从而得出最近一个或最前面一个对象。例如：

get_latest_by = "order_date"   # 根据order_date升序排列

get_latest_by = ['-priority', 'order_date']  # 根据priority降序排列，如果发生同序，则接着使用order_date升序排列
1
2
3

# managed

该元数据默认值为True，表示Django将按照既定的规则，管理数据库表的生命周期。

如果设置为False，将不会针对当前模型创建和删除数据库表，也就是说Django暂时不管这个模型了。

在某些场景下，这可能有用，但更多时候，你可以忘记该选项。

# order_with_respect_to

这个选项不好理解。其用途是根据指定的字段进行排序，通常用于关系字段。看下面的例子：

from django.db import models

class Question(models.Model):
    text = models.TextField()
    # ...

class Answer(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    # ...

    class Meta:
        order_with_respect_to = 'question'
1
2
3
4
5
6
7
8
9
10
11
12

上面在Answer模型中设置了order_with_respect_to = 'question'，这样的话，Django会自动提供两个API，get_RELATED_order()和set_RELATED_order()，其中的RELATED用小写的模型名代替。假设现在有一个Question对象，它关联着多个Answer对象，下面的操作返回包含关联的Anser对象的主键的列表[1,2,3]：

>>> question = Question.objects.get(id=1)
>>> question.get_answer_order()
[1, 2, 3]
1
2
3

我们可以通过set_RELATED_order()方法，指定上面这个列表的顺序：

>>> question.set_answer_order([3, 1, 2])
1

同样的，关联的对象也获得了两个方法get_next_in_order()和get_previous_in_order()，用于通过特定的顺序访问对象，如下所示：

>>> answer = Answer.objects.get(id=2)
>>> answer.get_next_in_order()
<Answer: 3>
>>> answer.get_previous_in_order()
<Answer: 1>
1
2
3
4
5

这个元数据的作用......还没用过，囧。

# ordering

最常用的元数据之一了！

用于指定该模型生成的所有对象的排序方式，接收一个字段名组成的元组或列表。默认按升序排列，如果在字段名前加上字符“-”则表示按降序排列，如果使用字符问号“？”表示随机排列。请看下面的例子：

这个顺序是你通过查询语句，获得Queryset后的列表内元素的顺序，切不可和前面的get_latest_by等混淆。

ordering = ['pub_date']             # 表示按'pub_date'字段进行升序排列
ordering = ['-pub_date']            # 表示按'pub_date'字段进行降序排列
ordering = ['-pub_date', 'author']  # 表示先按'pub_date'字段进行降序排列，再按`author`字段进行升序排列。
1
2
3

# permissions

该元数据用于当创建对象时增加额外的权限。它接收一个所有元素都是二元元组的列表或元组，每个元素都是(权限代码, 直观的权限名称)的格式。比如下面的例子：

这个Meta选项非常重要，和auth框架的权限系统紧密相关。

permissions = (("can_deliver_pizzas", "可以送披萨"),)
1

# default_permissions

Django默认会在建立数据表的时候就自动给所有的模型设置('add', 'change', 'delete')的权限，也就是增删改。你可以自定义这个选项，比如设置为一个空列表，表示你不需要默认的权限，但是这一操作必须在执行migrate命令之前。也是配合auth框架使用。

# proxy

如果设置了proxy = True，表示使用代理模式的模型继承方式。具体内容与abstract选项一样，参考模型继承章节。

# required_db_features

声明模型依赖的数据库功能。比如['gis_enabled']，表示模型的建立依赖GIS功能。

# required_db_vendor

声明模型支持的数据库。Django默认支持sqlite, postgresql, mysql, oracle。

# select_on_save

决定是否使用1.6版本之前的django.db.models.Model.save()算法保存对象。默认值为False。这个选项我们通常不用关心。

# indexes

接收一个应用在当前模型上的索引列表，如下例所示：

from django.db import models

class Customer(models.Model):
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)

    class Meta:
        indexes = [
            models.Index(fields=['last_name', 'first_name']),
            models.Index(fields=['first_name'], name='first_name_idx'),
        ]
1
2
3
4
5
6
7
8
9
10
11

# unique_together

这个元数据是非常重要的一个！它等同于数据库的联合约束！

举个例子，假设有一张用户表，保存有用户的姓名、出生日期、性别和籍贯等等信息。要求是所有的用户唯一不重复，可现在有好几个叫“张伟”的，如何区别它们呢？（不要和我说主键唯一，这里讨论的不是这个问题）

我们可以设置不能有两个用户在同一个地方同一时刻出生并且都叫“张伟”，使用这种联合约束，保证数据库能不能重复添加用户（也不要和我谈小概率问题）。在Django的模型中，如何实现这种约束呢？

使用unique_together，也就是联合唯一！

比如：

unique_together = [['name', 'birth_day', 'address'],......]
1

这样，哪怕有两个在同一天出生的张伟，但他们的籍贯不同，也就是两个不同的用户。一旦三者都相同，则会被Django拒绝创建。这个元数据选项经常被用在admin后台，并且强制应用于数据库层面。

unique_together接收一个二维的列表，每个元素都是一维列表，表示一组联合唯一约束，可以同时设置多组约束。为了方便，对于只有一组约束的情况下，可以简单地使用一维元素，例如：

unique_together = ['name', 'birth_day', 'address']
1

联合唯一无法作用于普通的多对多字段。

# index_together

联合索引，用法和特性类似unique_together。

# constraints

为模型添加约束条件。通常是列表的形式，每个列表元素就是一个约束。

from django.db import models

class Customer(models.Model):
    age = models.IntegerField()

    class Meta:
        constraints = [
            models.CheckConstraint(check=models.Q(age__gte=18), name='age_gte_18'),
        ]
1
2
3
4
5
6
7
8
9

上例中，会检查age年龄的大小，不得低于18。

# verbose_name

最常用的元数据之一！用于设置模型对象的直观、人类可读的名称，用于在各种打印、页面展示等场景。可以用中文。例如：

verbose_name = "story"
verbose_name = "披萨"
1
2

如果你不指定它，那么Django会使用小写的模型名作为默认值。

# verbose_name_plural

英语有单数和复数形式。这个就是模型对象的复数名，比如“apples”。因为我们中文通常不区分单复数，所以保持和verbose_name一致也可以。

verbose_name_plural = "stories"
verbose_name_plural = "披萨"
verbose_name_plural = verbose_name
1
2
3

如果不指定该选项，那么默认的复数名字是verbose_name加上‘s’

# label

前面介绍的元数据都是可修改和设置的，但还有两个只读的元数据，label就是其中之一。

label等同于app_label.object_name。例如polls.Question，polls是应用名，Question是模型名。

# label_lower

同上，不过是小写的模型名。

编辑 (opens new window)
模型的继承
ORM单表增删改查

← ORM单表增删改查→

最近更新
01
配置yun源
05-24
02
linux-配置python虚拟环境
05-24
03
linux文件目录管理
05-24
更多文章>
Theme by Vdoing | Copyright © 2023-2023 yizhang | MIT License