Model

一、Django model 常用字段和参数

1.1 常用字段

AutoField       int自增列，必须填入参数 primary_key=True。当model中如果没有自增列，则自动会创建一个列名为id的列
IntegerField    一个整数类型,范围在 -2147483648 to 2147483647
CharField    　　字符类型，必须提供max_length参数， max_length表示字符长度
DateField    　　日期字段，日期格式  YYYY-MM-DD，相当于Python中的datetime.date()实例
DateTimeField   日期时间字段，格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]，相当于Python中的datetime.datetime()实例

# DateField 和 DateTimeField 字段的参数
auto_now_add=True   # 创建数据记录的时候会把当前时间添加到数据库
auto_now=True       # 每次更新数据记录的时候会更新该字段

1.2 字段合集

AutoField(Field)
    int自增列，必须填入参数 primary_key=True

BigAutoField(AutoField)
    bigint自增列，必须填入参数 primary_key=True

注：当model中如果没有自增列，则自动会创建一个列名为id的列

 SmallIntegerField(IntegerField):
    小整数 -32768 ～ 32767

PositiveSmallIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
    正小整数 0 ～ 32767

IntegerField(Field)
    整数列(有符号的) -2147483648 ～ 2147483647

PositiveIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
    正整数 0 ～ 2147483647

BigIntegerField(IntegerField):
    长整型(有符号的) -9223372036854775808 ～ 9223372036854775807

BooleanField(Field)
    布尔值类型

NullBooleanField(Field):
    可以为空的布尔值

CharField(Field)
    字符类型，必须提供max_length参数，max_length表示字符长度

TextField(Field)
    文本类型

EmailField(CharField)：
    字符串类型，Django Admin 以及 ModelForm 中提供验证机制

IPAddressField(Field)
    字符串类型，Django Admin 以及 ModelForm 中提供验证 IPV4 机制

GenericIPAddressField(Field)
    字符串类型，Django Admin 以及 ModelForm 中提供验证 Ipv4和Ipv6
    参数：
        protocol，用于指定Ipv4或Ipv6， 'both',"ipv4","ipv6"
        unpack_ipv4， 如果指定为True，则输入::ffff:192.0.2.1时候，可解析为192.0.2.1，开启此功能，需要protocol="both"

URLField(CharField)
    字符串类型，Django Admin 以及 ModelForm 中提供验证 URL

SlugField(CharField)
    字符串类型，Django Admin 以及 ModelForm 中提供验证支持 字母、数字、下划线、连接符（减号）

CommaSeparatedIntegerField(CharField)
    字符串类型，格式必须为逗号分割的数字

UUIDField(Field)
    字符串类型，Django Admin 以及 ModelForm 中提供对 UUID 格式的验证

FilePathField(Field)
    字符串，Django Admin 以及 ModelForm 中提供读取文件夹下文件的功能
    参数：
        path,                  文件夹路径
        match=None,            正则匹配
        recursive=False,       递归下面的文件夹
        allow_files=True,      允许文件
        allow_folders=False,   允许文件夹

FileField(Field)
    字符串，路径保存在数据库，文件上传到指定目录
    参数：
        upload_to = ""      上传文件的保存路径
        storage = None      存储组件，默认django.core.files.storage.FileSystemStorage

ImageField(FileField)
    字符串，路径保存在数据库，文件上传到指定目录
    参数：
        upload_to = ""      上传文件的保存路径
        storage = None      存储组件，默认django.core.files.storage.FileSystemStorage
        width_field=None,   上传图片的高度保存的数据库字段名（字符串）
        height_field=None   上传图片的宽度保存的数据库字段名（字符串）

DateTimeField(DateField)
    日期+时间格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]

DateField(DateTimeCheckMixin, Field)
    日期格式      YYYY-MM-DD

TimeField(DateTimeCheckMixin, Field)
    时间格式      HH:MM[:ss[.uuuuuu]]

DurationField(Field)
    长整数，时间间隔，数据库中按照 bigint 存储，ORM 中获取的值为 datetime.timedelta 类型

FloatField(Field)
    浮点型

DecimalField(Field)
    10进制小数
    参数：
        max_digits，小数总长度
        decimal_places，小数位长度

BinaryField(Field)
    二进制类型

1.3 自定义字段

自定义char类型字段：

class FixedCharField(models.Field):
    """
    自定义的char类型的字段类
    """
    def __init__(self, max_length, *args, **kwargs):
        self.max_length = max_length
        super(FixedCharField, self).__init__(max_length=max_length, *args, **kwargs)

    def db_type(self, connection):
        """
        限定生成数据库表的字段类型为char，长度为max_length指定的值
        """
        return 'char(%s)' % self.max_length


class Book(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.CharField(max_length=16)
    # 使用自定义的char类型的字段
    publisher = FixedCharField(max_length=16)

1.4 ORM字段与数据库实际字段的对应关系

'AutoField': 'integer AUTO_INCREMENT',
'BigAutoField': 'bigint AUTO_INCREMENT',
'BinaryField': 'longblob',
'BooleanField': 'bool',
'CharField': 'varchar(%(max_length)s)',
'CommaSeparatedIntegerField': 'varchar(%(max_length)s)',
'DateField': 'date',
'DateTimeField': 'datetime',
'DecimalField': 'numeric(%(max_digits)s, %(decimal_places)s)',
'DurationField': 'bigint',
'FileField': 'varchar(%(max_length)s)',
'FilePathField': 'varchar(%(max_length)s)',
'FloatField': 'double precision',
'IntegerField': 'integer',
'BigIntegerField': 'bigint',
'IPAddressField': 'char(15)',
'GenericIPAddressField': 'char(39)',
'NullBooleanField': 'bool',
'OneToOneField': 'integer',
'PositiveIntegerField': 'integer UNSIGNED',
'PositiveSmallIntegerField': 'smallint UNSIGNED',
'SlugField': 'varchar(%(max_length)s)',
'SmallIntegerField': 'smallint',
'TextField': 'longtext',
'TimeField': 'time',
'UUIDField': 'char(32)',

1.5 字段参数

null                数据库中字段是否可以为空
db_column           数据库中字段的列名
default             数据库中字段的默认值
primary_key         数据库中字段是否为主键
db_index            数据库中字段是否可以建立索引
unique              数据库中字段是否可以建立唯一索引
unique_for_date     数据库中字段【日期】部分是否可以建立唯一索引
unique_for_month    数据库中字段【月】部分是否可以建立唯一索引
unique_for_year     数据库中字段【年】部分是否可以建立唯一索引

verbose_name        Admin中显示的字段名称
blank               Admin中是否允许用户输入为空
editable            Admin中是否可以编辑
help_text           Admin中该字段的提示信息
choices             Admin中显示选择框的内容，用不变动的数据放在内存中从而避免跨表操作
                    如：gender = models.IntegerField(choices=[(0, '女'), (1, '男')], default=1)

error_messages      自定义错误信息（字典类型），从而定制想要显示的错误信息；
                    字典健：null, blank, invalid, invalid_choice, unique, and unique_for_date
                    如：
                    {'null': "不能为空.", 'invalid': '格式错误'}

validators          自定义错误验证（列表类型），从而定制想要的验证规则
                    from django.core.validators import RegexValidator
                    from django.core.validators import EmailValidator,URLValidator,DecimalValidator,
                    MaxLengthValidator,MinLengthValidator,MaxValueValidator,MinValueValidator
                    如：
                    test = models.CharField(
                        max_length=32,
                        error_messages={
                            'c1': '优先错信息1',
                            'c2': '优先错信息2',
                            'c3': '优先错信息3',
                        },
                        validators=[
                            RegexValidator(regex='root_d+', message='错误了', code='c1'),
                            RegexValidator(regex='root_112233d+', message='又错误了', code='c2'),
                            EmailValidator(message='又错误了', code='c3'), ]
                    )

1.6 元信息

 class UserInfo(models.Model):
    username = models.CharField(max_length=16)
    password = models.CharField(max_length=32)
    class Meta:
        # 数据库中生成的表名称，默认：app名称 + 下划线 + 类名
        db_table = "table_name"
        # 联合索引
        index_together = [
            ("pub_date", "deadline"),
        ]
        # 联合唯一索引
        unique_together = [
            ("driver", "restaurant"),
        ]
        # admin中显示的表名称
        verbose_name
        # verbose_name加s
        verbose_name_plural

二、Django ORM 关系字段

2.1 ForeignKey

外键类型在ORM中用来表示外键关联关系，一般把 ForeignKey 字段设置在 "一对多"中"多"的一方；ForeignKey可以和其他表做关联关系，同时也可以和自身做关联关系。

字段的参数：

to  设置要关联的表

to_field  设置要关联的表的字段

related_name  反向操作时，使用的字段名，用于代替原反向查询时的"表名_set"

示例：

class Classes(models.Model):
    name = models.CharField(max_length=32)

class Student(models.Model):
    name = models.CharField(max_length=32)
    theclass = models.ForeignKey(to="Classes")

当要查询某个班级关联的所有学生（反向查询）时，这么写：

models.Classes.objects.first().student_set.all()

当在ForeignKey字段中添加了参数 related_name 后：

class Student(models.Model):
    name = models.CharField(max_length=32)
    theclass = models.ForeignKey(to="Classes", related_name="students")

当要查询某个班级关联的所有学生（反向查询）时，这么写：

models.Classes.objects.first().students.all()

related_query_name  反向查询操作时，使用的连接前缀，用于替换表名；如：

models.UserGroup.objects.filter(表名__字段名=1).values("表名__字段名")

on_delete  当删除关联表中的数据时，当前表与其关联的行的行为

models.CASCADE
删除关联数据，与之关联也删除

models.DO_NOTHING
删除关联数据，引发错误IntegrityError

models.PROTECT
删除关联数据，引发错误ProtectedError

models.SET_NULL
删除关联数据，与之关联的值设置为null（前提FK字段需要设置为可空）

models.SET_DEFAULT
删除关联数据，与之关联的值设置为默认值（前提FK字段需要设置默认值）

models.SET
删除关联数据
a. 与之关联的值设置为指定值，设置：models.SET(值)
b. 与之关联的值设置为可执行对象的返回值，设置：models.SET(可执行对象)

def func():
    return 10

class MyModel(models.Model):
    user = models.ForeignKey(
        to="User",
        to_field="id"，
        on_delete=models.SET(func)
      )

db_constraint  是否在数据库中创建外键约束，默认为True；如果设置为False，相当于没有建立约束（软关联）

2.2 OneToOneField

一对一字段；通常用来扩展已有字段。

示例：

一对一的关联关系多用在当一张表的不同字段查询频次差距过大的情况下，将本可以存储在一张表的字段拆开放置在两张表中，然后将两张表建立一对一的关联关系。

# 字段参数同ForeignKey字段
to
to_field
on_delete

2.3 ManyToManyField

用于表示多对多的关联关系；在数据库中通过第三张表来建立关联关系；ManyToManyField() 通常设置在正向查询多的那一边，比如：通过作者查书比通过书查作者多，那么就设置在作者这边。

2.3.1 字段的参数：

# 以下字段参数同ForeignKey字段
to
related_name
related_query_name
db_constraint

symmetrical  仅用于多对多自关联时，指定内部是否创建反向操作的字段，默认为True

示例：

class Person(models.Model):
    name = models.CharField(max_length=16)
    friends = models.ManyToManyField("self")

此时，person对象就没有person_set属性；

class Person(models.Model):
    name = models.CharField(max_length=16)
    friends = models.ManyToManyField("self", symmetrical=False)

此时，person对象现在就可以使用 person_set 属性进行反向查询。

through

在使用ManyToManyField字段时，Django将自动生成一张表来管理多对多的关联关系；但我们也可以手动创建第三张表来管理多对多关系，此时就需要通过 through 来指定第三张表的表名。

through_fields  自定义第三张表时，用于指定关系表中哪些字段建立多对多关系

db_table  默认创建第三张表时，数据库中表的名称

2.3.2 多对多关联关系的三种创建方式

①通过ManyToManyField自动创建第三张表

②自行创建第三张表，利用外键分别关联

③设置ManyToManyField并指定自行创建第三张表

注意：

当我们需要在第三张关系表中存储额外的字段时，就要使用第③种方式；但是当我们使用这种方式创建多对多关联关系时，就无法使用 set、add、remove、clear 方法来管理多对多的关系了，需要通过第三张表的 model 来管理多对多关系（即直接在第三种表操作）。

models.Author2Book.objects.get(author_id=1, book_id=1).delete()

PS：

相亲网站，男女约会是多对多的关系，第三张表中除了ORM自动创建的 id、boy_id、girl_id 之外，还要有约会日期，这个日期就是额外字段，就用第③种方式。