Django model 中的 class Meta 详解
Django model 中的 class Meta 详解
通过一个内嵌类class Meta
给你的 model 定义元数据, 类似下面这样:
class Foo(models.Model):
bar = models.CharField(maxlength=30)
class Meta:
# ...
Model 元数据就是 "不是一个字段的任何数据" -- 比如排序选项, admin 选项等等.
下面是所有可能用到的 Meta 选项. 没有一个选项是必需的. 是否添加class Meta
到你的 model 完全是可选的.
app_label
app_label
这个选项只在一种情况下使用,就是你的模型类不在默认的应用程序包下的 models.py 文件中,这时候你需要指定你这个模型类是哪个应用程序的。比如你在其他地方写了一个模型类,而这个模型类是属于 myapp 的,那么你这是需要指定为:
class Foo(models.Model):
bar = models.CharField(maxlength=30)
class Meta:
app_label = 'myapp'
db_table
db_table
是用于指定自定义数据库表名的。Django 有一套默认的按照一定规则生成数据模型对应的数据库表名,如果你想使用自定义的表名,就通过这个属性指定,比如:
class Foo(models.Model):
bar = models.CharField(maxlength=30)
class Meta:
table_name = 'my_owner_table'
若不提供该参数, Django 会使用 app_label + '_' + module_name 作为表的名字.
若你的表的名字是一个 SQL 保留字, 或包含 Python 变量名不允许的字符--特别是连字符 --没关系. Django 会自动在幕后替你将列名字和表名字用引号引起来.
db_tablespace
有些数据库有数据库表空间,比如 Oracle。你可以通过db_tablespace
来指定这个模型对应的数据库表放在哪个数据库表空间。
get_latest_by
由于 Django 的管理方法中有个lastest()
方法,就是得到最近一行记录。如果你的数据模型中有DateField
或DateTimeField
类型的字段,你可以通过这个选项来指定lastest()
是按照哪个字段进行选取的。
managed
由于 Django 会自动根据模型类生成映射的数据库表,如果你不希望 Django 这么做,可以把 managed 的值设置为 False。
默认值为 True时,Django 可以对数据库表进行 migrate 或 migrations、删除等操作,此时 Django 将管理数据库中表的生命周期。
如果为 False 的时候,不会对数据库表进行创建、删除等操作。可以用于现有表、数据库视图等,其他操作是一样的。
order_with_respect_to
这个选项一般用于多对多的关系中,它指向一个关联对象。就是说关联对象找到这个对象后它是经过排序的。指定这个属性后你会得到一个get_XXX_order()
和set_XXX_order()
的方法,通过它们你可以设置或者获取排序的对象。
举例来说, 如果一个 PizzaToppping 关联到一个 Pizza 对象, 这样做:
order_with_respect_to = 'pizza'
...就允许 toppings 依照相关的 pizza 来排序.
ordering
这个字段是告诉 Django 模型对象返回的记录结果集是按照哪个字段排序的。比如下面的代码:
ordering = ['order_date', ] # 按订单升序排列
ordering = ['-order_date', ] # 按订单降序排列,-表示降序
ordering = ['?order_date', ] # 随机排序,?表示随机
ordering = ['-pub_date', 'author'] # 对 pub_date 降序,然后对 author 升序
需要注意的是:不论你使用了多少个字段排序, admin 只使用第一个字段
permissions
permissions
主要是为了在 Django Admin 管理模块下使用的,如果你设置了这个属性可以让指定的方法权限描述更清晰可读。
要创建一个对象所需要的额外的权限. 如果一个对象有 admin 设置, 则每个对象的添加,删除和改变权限会(依据该选项)自动创建.下面这个例子指定了一个附加权限: can_deliver_pizzas:
permissions = (("can_deliver_pizzas", "Can deliver pizzas"), )
这是一个2-元素 tuple 的 tuple 或列表, 其中两2-元素 tuple 的格式为:(permission_code, human_readable_permission_name).
unique_together
unique_together
这个选项用于:当你需要通过两个字段保持唯一性时使用。这会在 Django admin 层和数据库层同时做出限制(也就是相关的 UNIQUE 语句会被包括在 CREATE TABLE 语句中)。比如:一个 Person 的 FirstName 和 LastName 两者的组合必须是唯一的,那么需要这样设置:
unique_together = (("first_name", "last_name"), )
verbose_name
verbose_name
的意思很简单,就是给你的模型类起一个更可读的名字:
verbose_name = "pizza"
若未提供该选项, Django 则会用一个类名字的 munged 版本来代替: CamelCase becomes camel case.
verbose_name_plural
这个选项是指定,模型的复数形式是什么,比如:
verbose_name_plural = "stories"
若未提供该选项, Django 会使用 verbose_name + "s".