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()实例。
二、字段合集
1 AutoField(Field) 2 - int自增列,必须填入参数 primary_key=True 3 4 BigAutoField(AutoField) 5 - bigint自增列,必须填入参数 primary_key=True 6 7 注:当model中如果没有自增列,则自动会创建一个列名为id的列 8 from django.db import models 9 10 class UserInfo(models.Model): 11 # 自动创建一个列名为id的且为自增的整数列 12 username = models.CharField(max_length=32) 13 14 class Group(models.Model): 15 # 自定义自增列 16 nid = models.AutoField(primary_key=True) 17 name = models.CharField(max_length=32) 18 19 SmallIntegerField(IntegerField): 20 - 小整数 -32768 ~ 32767 21 22 PositiveSmallIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField) 23 - 正小整数 0 ~ 32767 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 - 二进制类型
三、自定义字段
1 class UnsignedIntegerField(models.IntegerField): 2 def db_type(self, connection): 3 return 'integer UNSIGNED'
自定义char类型字段:
1 class FixedCharField(models.Field): 2 """ 3 自定义的char类型的字段类 4 """ 5 def __init__(self, max_length, *args, **kwargs): 6 self.max_length = max_length 7 super(FixedCharField, self).__init__(max_length=max_length, *args, **kwargs) 8 9 def db_type(self, connection): 10 """ 11 限定生成数据库表的字段类型为char,长度为max_length指定的值 12 """ 13 return 'char(%s)' % self.max_length 14 15 16 class Class(models.Model): 17 id = models.AutoField(primary_key=True) 18 title = models.CharField(max_length=25) 19 # 使用自定义的char类型的字段 20 cname = FixedCharField(max_length=25)
创建的表结构:
1 附ORM字段与数据库实际字段的对应关系 2 对应关系: 3 'AutoField': 'integer AUTO_INCREMENT', 4 'BigAutoField': 'bigint AUTO_INCREMENT', 5 'BinaryField': 'longblob', 6 'BooleanField': 'bool', 7 'CharField': 'varchar(%(max_length)s)', 8 'CommaSeparatedIntegerField': 'varchar(%(max_length)s)', 9 'DateField': 'date', 10 'DateTimeField': 'datetime', 11 'DecimalField': 'numeric(%(max_digits)s, %(decimal_places)s)', 12 'DurationField': 'bigint', 13 'FileField': 'varchar(%(max_length)s)', 14 'FilePathField': 'varchar(%(max_length)s)', 15 'FloatField': 'double precision', 16 'IntegerField': 'integer', 17 'BigIntegerField': 'bigint', 18 'IPAddressField': 'char(15)', 19 'GenericIPAddressField': 'char(39)', 20 'NullBooleanField': 'bool', 21 'OneToOneField': 'integer', 22 'PositiveIntegerField': 'integer UNSIGNED', 23 'PositiveSmallIntegerField': 'smallint UNSIGNED', 24 'SlugField': 'varchar(%(max_length)s)', 25 'SmallIntegerField': 'smallint', 26 'TextField': 'longtext', 27 'TimeField': 'time', 28 'UUIDField': 'char(32)',
四、字段参数
Null
用于表示某个字段可以为空。
Unique
如果设置为unique=True 则该字段在此表中必须是唯一的 。
db_index
如果db_index=True 则代表着为此字段设置索引。
default
为该字段设置默认值。
五、DateField和DateTimeField
auto_now_add
配置auto_now_add=True,创建数据记录的时候会把当前时间添加到数据库。
auto_now
配置上auto_now=True,每次更新数据记录的时候会更新该字段。
六、关系字段:ForeignKey
外键类型在ORM中用来表示外键关联关系,一般把ForeignKey字段设置在 '一对多'中'多'的一方。
ForeignKey可以和其他表做关联关系同时也可以和自身做关联关系。
To
设置要关联的表
to_field
设置要关联的表的字段
related_name
反向操作时,使用的字段名,用于代替原反向查询时的'表名_set'。
例如:
1 class Classes(models.Model): 2 name = models.CharField(max_length=32) 3 4 class Student(models.Model): 5 name = models.CharField(max_length=32) 6 theclass = models.ForeignKey(to="Classes") 7 当我们要查询某个班级关联的所有学生(反向查询)时,我们会这么写: 8 models.Classes.objects.first().student_set.all() 9 当我们在ForeignKey字段中添加了参数 related_name 后, 10 class Student(models.Model): 11 name = models.CharField(max_length=32) 12 theclass = models.ForeignKey(to="Classes", related_name="students") 13 当我们要查询某个班级关联的所有学生(反向查询)时,我们会这么写: 14 models.Classes.objects.first().students.all()
related_query_name
反向查询操作时,使用的连接前缀,用于替换表名。
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(可执行对象)
1 def func(): 2 return 10 3 4 class MyModel(models.Model): 5 user = models.ForeignKey( 6 to="User", 7 to_field="id", 8 on_delete=models.SET(func) 9 )
db_constraint
是否在数据库中创建外键约束,默认为True。
七、关系字段:OneToOneField
一对一字段。
通常一对一字段用来扩展已有字段。
To
设置要关联的表。
to_field
设置要关联的表的字段
on_delete
同ForeignKey字段。
八、关系字段:ManyToManyField
用于表示多对多的关联关系。在数据库中通过第三张表来建立关联关系
To
设置要关联的表
related_name
同ForeignKey字段。
related_query_name
同ForeignKey字段。
symmetrical
仅用于多对多自关联时,指定内部是否创建反向操作的字段。默认为True。
举个例子:
1 class Person(models.Model): 2 name = models.CharField(max_length=16) 3 friends = models.ManyToManyField("self") 4 此时,person对象就没有person_set属性。 5 class Person(models.Model): 6 name = models.CharField(max_length=16) 7 friends = models.ManyToManyField("self", symmetrical=False) 8 此时,person对象现在就可以使用person_set属性进行反向查询。
hrough
在使用ManyToManyField字段时,Django将自动生成一张表来管理多对多的关联关系。
但我们也可以手动创建第三张表来管理多对多关系,此时就需要通过through来指定第三张表的表名。
through_fields
设置关联的字段。
db_table
默认创建第三张表时,数据库中表的名称。
九、元信息
ORM对应的类里面包含另一个Meta类,而Meta类封装了一些数据库的信息。主要字段如下:
db_table
ORM在数据库中的表名默认是 app_类名,可以通过db_table可以重写表名。
index_together
联合索引。
unique_together
联合唯一索引。
ordering
指定默认按什么字段排序。
只有设置了该属性,我们查询到的结果才可以被reverse()。