Django ORM 常用字段和参数

常用字段

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()实例。

TextField

    文本类型。

其他类型

  1 AutoField(Field)
  2     - int自增列,必须填入参数 primary_key=True
  3 
  4 BigAutoField(AutoField)
  5     - bigint自增列,必须填入参数 primary_key=True
  6     注:当model中如果没有自增列,则自动会创建一个列名为id的列
  7      from django.db import models
  8 
  9     class UserInfo(models.Model):
 10         # 自动创建一个列名为id的且为自增的整数列
 11         username = models.CharField(max_length=32)
 12 
 13     class Group(models.Model):
 14         # 自定义自增列
 15          nid = models.AutoField(primary_key=True)
 16          name = models.CharField(max_length=32)
 17 
 18 SmallIntegerField(IntegerField):
 19     - 小整数 -32768 ~ 32767
 20 
 21 PositiveSmallIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
 22     - 正小整数 0 ~ 32767
 23 
 24 IntegerField(Field)
 25     - 整数列(有符号的) -2147483648 ~ 2147483647
 26 
 27 PositiveIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
 28      - 正整数 0 ~ 2147483647
 29 
 30 BigIntegerField(IntegerField):
 31     - 长整型(有符号的) -9223372036854775808 ~ 9223372036854775807
 32 
 33 BooleanField(Field)
 34      - 布尔值类型
 35 
 36 NullBooleanField(Field):
 37      - 可以为空的布尔值
 38 
 39 CharField(Field)
 40      - 字符类型
 41     - 必须提供max_length参数, max_length表示字符长度
 42 
 43 TextField(Field)
 44     - 文本类型
 45 
 46 EmailField(CharField):
 47     - 字符串类型,Django Admin以及ModelForm中提供验证机制
 48 
 49 IPAddressField(Field)
 50     - 字符串类型,Django Admin以及ModelForm中提供验证 IPV4 机制
 51 
 52 GenericIPAddressField(Field)
 53     - 字符串类型,Django Admin以及ModelForm中提供验证 Ipv4和Ipv6
 54     - 参数:
 55         protocol,用于指定Ipv4或Ipv6, 'both',"ipv4","ipv6"
 56         unpack_ipv4, 如果指定为True,则输入::ffff:192.0.2.1时候,可解析为192.0.2.1,开启此功能,需要protocol="both"
 57 
 58 URLField(CharField)
 59     - 字符串类型,Django Admin以及ModelForm中提供验证 URL
 60 
 61 SlugField(CharField)
 62     - 字符串类型,Django Admin以及ModelForm中提供验证支持 字母、数字、下划线、连接符(减号)
 63 
 64 CommaSeparatedIntegerField(CharField)
 65     - 字符串类型,格式必须为逗号分割的数字
 66 
 67 UUIDField(Field)
 68     - 字符串类型,Django Admin以及ModelForm中提供对UUID格式的验证
 69 
 70 FilePathField(Field)
 71     - 字符串,Django Admin以及ModelForm中提供读取文件夹下文件的功能
 72     - 参数:
 73         path,                             文件夹路径
 74         match=None,                 正则匹配
 75         recursive=False,             递归下面的文件夹
 76         allow_files=True,            允许文件
 77         allow_folders=False,       允许文件夹
 78 
 79 FileField(Field)
 80     - 字符串,路径保存在数据库,文件上传到指定目录
 81     - 参数:
 82         upload_to = ""        上传文件的保存路径
 83         storage = None       存储组件,默认django.core.files.storage.FileSystemStorage
 84 
 85     ImageField(FileField)
 86         - 字符串,路径保存在数据库,文件上传到指定目录
 87         - 参数:
 88             upload_to = ""      上传文件的保存路径
 89             storage = None      存储组件,默认django.core.files.storage.FileSystemStorage
 90             width_field=None,   上传图片的高度保存的数据库字段名(字符串)
 91             height_field=None   上传图片的宽度保存的数据库字段名(字符串)
 92 
 93 DateTimeField(DateField)
 94     - 日期+时间格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]
 95 
 96 DateField(DateTimeCheckMixin, Field)
 97     - 日期格式      YYYY-MM-DD
 98 
 99 TimeField(DateTimeCheckMixin, Field)
100     - 时间格式      HH:MM[:ss[.uuuuuu]]
101 
102 DurationField(Field)
103     - 长整数,时间间隔,数据库中按照bigint存储,ORM中获取的值为datetime.timedelta类型
104 
105 FloatField(Field)
106     - 浮点型
107 
108 DecimalField(Field)
109     - 10进制小数
110     - 参数:
111         max_digits,小数总长度
112         decimal_places,小数位长度
113 
114 BinaryField(Field)
115     - 二进制类型
字段合集

 自定义字段

class UnsignedIntegerField(models.IntegerField):
    def db_type(self, connection):
        return 'integer UNSIGNED'

自定义char类型字段:

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

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


class Class(models.Model):
    id = models.AutoField(primary_key=True)
    title = models.CharField(max_length=25)
    # 使用上面自定义的char类型的字段
    cname = FixedCharField(max_length=25)
自定义字段

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

 1 对应关系:
 2     'AutoField': 'integer AUTO_INCREMENT',
 3     'BigAutoField': 'bigint AUTO_INCREMENT',
 4     'BinaryField': 'longblob',
 5     'BooleanField': 'bool',
 6     'CharField': 'varchar(%(max_length)s)',
 7     'CommaSeparatedIntegerField': 'varchar(%(max_length)s)',
 8     'DateField': 'date',
 9     'DateTimeField': 'datetime',
10     'DecimalField': 'numeric(%(max_digits)s, %(decimal_places)s)',
11     'DurationField': 'bigint',
12     'FileField': 'varchar(%(max_length)s)',
13     'FilePathField': 'varchar(%(max_length)s)',
14     'FloatField': 'double precision',
15     'IntegerField': 'integer',
16     'BigIntegerField': 'bigint',
17     'IPAddressField': 'char(15)',
18     'GenericIPAddressField': 'char(39)',
19     'NullBooleanField': 'bool',
20     'OneToOneField': 'integer',
21     'PositiveIntegerField': 'integer UNSIGNED',
22     'PositiveSmallIntegerField': 'smallint UNSIGNED',
23     'SlugField': 'varchar(%(max_length)s)',
24     'SmallIntegerField': 'smallint',
25     'TextField': 'longtext',
26     'TimeField': 'time',
27     'UUIDField': 'char(32)',
对应关系

字段参数

常用参数

null

用于表示某个字段可以为空。

blank

针对表单的,字段可以为空。

unique

如果设置为unique=True 则该字段在此表中必须是唯一的 。

db_index

如果db_index=True 则代表着为此字段设置数据库索引。

default

为该字段设置默认值。

时间字段独有

DatetimeField、DateField、TimeField这个三个时间字段,都可以设置如下属性。

auto_now_add

配置auto_now_add=True,创建数据记录的时候会把当前时间添加到数据库。

auto_now

配置上auto_now=True,每次更新数据记录的时候会更新该字段。

字段关系

ForeignKey

外键类型在ORM中用来表示外键关联关系,一般把ForeignKey字段设置在 '一对多'中'多'的一方。

ForeignKey可以和其他表做关联关系同时也可以和自身做关联关系。

to

设置要关联的表

to_field

设置要关联的表的字段

related_name

反向操作时,使用的字段名,用于代替原反向查询时的'表名_set'。

related_query_name

反向查询操作时,使用的连接前缀,用于替换表名。

db_constraint

是否在数据库中创建外键约束,默认为True。

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(可执行对象)

OneToOneField

一对一字段。

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

to

设置要关联的表。

to_field

设置要关联的字段。

on_delete

同ForeignKey字段。

ManyToManyField

用于表示多对多的关联关系。在数据库中通过第三张表来建立关联关系。

to

设置要关联的表

related_name

同ForeignKey字段。

related_query_name

同ForeignKey字段。

symmetrical

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

through

在使用ManyToManyField字段时,Django将自动生成一张表来管理多对多的关联关系。

但我们也可以手动创建第三张表来管理多对多关系,此时就需要通过through来指定第三张表的表名。

through_fields

设置关联的字段。

db_table

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

多对多关联关系的三种方式 

方式一:自行创建第三张表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")


class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者姓名")


# 自己创建第三张表,分别通过外键关联书和作者
class Author2Book(models.Model):
    author = models.ForeignKey(to="Author")
    book = models.ForeignKey(to="Book")

    class Meta:
        unique_together = ("author", "book")

方式二:通过ManyToManyField自动创建第三张表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")


# 通过ORM自带的ManyToManyField自动创建第三张表
class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者姓名")
    books = models.ManyToManyField(to="Book", related_name="authors")

方式三:设置ManyTomanyField并指定自行创建的第三张表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")


# 自己创建第三张表,并通过ManyToManyField指定关联
class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者姓名")
    books = models.ManyToManyField(to="Book", through="Author2Book", through_fields=("author", "book"))
    # through_fields接受一个2元组('field1','field2'):
    # 其中field1是定义ManyToManyField的模型外键的名(author),field2是关联目标模型(book)的外键名。


class Author2Book(models.Model):
    author = models.ForeignKey(to="Author")
    book = models.ForeignKey(to="Book")

    class Meta:
        unique_together = ("author", "book")

注意:

当我们需要在第三张关系表中存储额外的字段时,就要使用第三种方式。

但是当我们使用第三种方式创建多对多关联关系时,就无法使用set、add、remove、clear方法来管理多对多的关系了,需要通过第三张表的model来管理多对多关系。

元数据信息

ORM对应的类里面包含另一个Meta类,而Meta类封装了一些数据库的信息。主要字段如下:

db_table

ORM在数据库中的表名默认是 app_类名,可以通过db_table可以重写表名。

index_together

联合索引。

unique_together

联合唯一索引。

ordering

指定默认按什么字段排序。

只有设置了该属性,我们查询到的结果才可以被reverse()。

 

posted @ 2020-07-17 20:56  闫世成  阅读(89)  评论(0)    收藏  举报