模型准确且唯一的描述了数据。它包含您储存的数据的重要字段和行为。一般来说,每一个模型都映射一张数据库表。
基础:
- 每个模型都是一个 Python 的类,这些类继承
django.db.models.Model
- 模型类的每个属性都相当于一个数据库的字段。
- 利用这些,Django 提供了一个自动生成访问数据库的 API;请参阅 执行查询。
快速上手
这个样例定义了一个 Person 模型,拥有 first_name 和 last_name:
from django.db import models
class Person(models.Model):
first_name = models.CharField(max_length=30)
last_name = models.CharField(max_length=30)
first_name
和 last_name
是模型的 字段。每个字段都被指定为一个类属性,并且每个属性映射为一个数据库列。
上面的 Person
模型会创建一个如下的数据库表:
CREATE TABLE myapp_person (
"id" serial NOT NULL PRIMARY KEY,
"first_name" varchar(30) NOT NULL,
"last_name" varchar(30) NOT NULL
);
一些技术上的说明:
- 该表的名称
myapp_person
是自动从某些模型元数据中派生出来,但可以被改写。参阅 Table names 获取更多信息。 - 一个
id
字段会被自动添加,但是这种行为可以被改写。请参阅 自动设置主键。 - 本例子中
创建数据表
的语法是 PostgreSQL 格式的。值得注意的是,Django 依据你在 配置文件 中指定的数据库后端生成对应的 SQL 语句。
使用模型
一旦你定义了你的模型,你需要告诉 Django 你准备 使用 这些模型。你需要修改设置文件中的 INSTALLED_APPS
,在这个设置中添加包含 models.py
文件的模块名称。
例如,若模型位于项目中的 myapp.models
模块( 此包结构由 manage.py startapp
命令创建), INSTALLED_APPS
应设置如下:
INSTALLED_APPS = [
#...
'myapp',
#...
]
当你向 INSTALLED_APPS
添加新的应用的时候,请务必运行 manage.py migrate
,此外你也可以先使用以下命令进行迁移 manage.py makemigrations
。
字段
模型中最重要且唯一必要的是数据库的字段定义。字段在类属性中定义。定义字段名时应小心避免使用与 模型 API 冲突的名称, 如 clean
, save
, or delete
等.
举例:
from django.db import models
class Musician(models.Model):
first_name = models.CharField(max_length=50)
last_name = models.CharField(max_length=50)
instrument = models.CharField(max_length=100)
class Album(models.Model):
artist = models.ForeignKey(Musician, on_delete=models.CASCADE)
name = models.CharField(max_length=100)
release_date = models.DateField()
num_stars = models.IntegerField()
字段类型
模型中每一个字段都应该是某个 Field
类的实例, Django 利用这些字段类来实现以下功能:
- 字段类型用以指定数据库数据类型(如:
INTEGER
,VARCHAR
,TEXT
)。 - 在渲染表单字段时默认使用的 HTML 视图 (如:
<input type="text">
,<select>
)。 - 基本的有效性验证功能,用于 Django 后台和自动生成的表单。
Django 内置了数十种字段类型;你可以在 模型字段参考 中看到完整列表。如果 Django 内置类型不能满足你的需求,你可以很轻松地编写自定义的字段类型;参见 编写自定义模型字段(model fields)。
字段选项
每一种字段都需要指定一些特定的参数(参考 模型字段 )。 例如, CharField
(以及它的子类)需要接收一个 max_length
参数,用以指定数据库存储 VARCHAR
数据时用的字节数。
一些可选的参数是通用的,可以用于任何字段类型,详情请见 参考 ,下面介绍一部分经常用到的通用参数:
null
如果设置为 True,当该字段为空时,Django 会将数据库中该字段设置为 NULL。默认为 False 。
如果设置为 True
,该字段允许为空。默认为 False
。
注意该选项与null
不同, null
选项仅仅是数据库层面的设置,然而 blank
是涉及表单验证方面。如果一个字段设置为 blank=True
,在进行表单验证时,接收的数据该字段值允许为空,而设置为 blank=False
时,不允许为空。
一系列二元组,用作此字段的选项。如果提供了二元组,默认表单小部件是一个选择框,而不是标准文本字段,并将限制给出的选项。
YEAR_IN_SCHOOL_CHOICES = [
('FR', 'Freshman'),
('SO', 'Sophomore'),
('JR', 'Junior'),
('SR', 'Senior'),
('GR', 'Graduate'),
]
注解
每当 choices 的顺序变动时将会创建新的迁移。
每个二元组的第一个值会储存在数据库中,而第二个值将只会用于在表单中显示。
对于一个模型实例,要获取该字段二元组中相对应的第二个值,使用 get_FOO_display()
方法。例如:
from django.db import models
class Person(models.Model):
SHIRT_SIZES = (
('S', 'Small'),
('M', 'Medium'),
('L', 'Large'),
)
name = models.CharField(max_length=60)
shirt_size = models.CharField(max_length=1, choices=SHIRT_SIZES)
>>> p = Person(name="Fred Flintstone", shirt_size="L")
>>> p.save()
>>> p.shirt_size
'L'
>>> p.get_shirt_size_display()
'Large'
你也可以使用枚举类以简洁的方式来定义 choices :
from django.db import models
class Runner(models.Model):
MedalType = models.TextChoices('MedalType', 'GOLD SILVER BRONZE')
name = models.CharField(max_length=60)
medal = models.CharField(blank=True, choices=MedalType.choices, max_length=10)
model field reference 中定义了更多的示例。
该字段的默认值。可以是一个值或者是个可调用的对象,如果是个可调用对象,每次实例化模型时都会调用该对象。
help_text
额外的“帮助”文本,随表单控件一同显示。即便你的字段未用于表单,它对于生成文档也是很有用的。
primary_key
如果设置为 True ,将该字段设置为该模型的主键。
在一个模型中,如果你没有对任何一个字段设置 primary_key=True
选项。 Django 会自动添加一个 IntegerField
字段,并设置为主键,因此除非你想重写 Django 默认的主键设置行为,你可以不手动设置主键。详情请见 自动设置主键 。
主键字段是只可读的,如果你修改一个模型实例的主键并保存,这等同于创建了一个新的模型实例。例如:
from django.db import models
class Fruit(models.Model):
name = models.CharField(max_length=100, primary_key=True)
>>> fruit = Fruit.objects.create(name='Apple')
>>> fruit.name = 'Pear'
>>> fruit.save()
>>> Fruit.objects.values_list('name', flat=True)
<QuerySet ['Apple', 'Pear']>
如果设置为 True,这个字段的值必须在整个表中保持唯一。
再次声明,以上只是一些通用参数的简略描述。你可以在 通用可选参数参考 中找到完整的介绍。
网友评论