字段名限制

Django 对模型的字段名仅有两个小小的限制:

1. 字段名不能是 Python 保留字, 否则显然会导致 Python 语法错误:

   class Example(models.Model):
       pass = models.IntegerField() # 'pass' is a reserved word!
   

2. 字段名中至多只允许有一个下划线, 否则 Django 查询语法就会出错:

   class Example(models.Model):
       foo__bar = models.IntegerField() 'foo__bar' has two underscores!
   

Django允许模型中使用的字段名可以与数据库中实际使用的不同,因此这些限制其实也不是绝对的.参阅下文中的 db_column .

SQL 保留字,比如 join, where 或 select, 都 允许在模型字段名中使用( Django 在生成SQL语句时会给表名及字段名加上引号,从而保证SQL语句的正确执行).

字段类型

你的 model 中的每个字段都必须是相关 Field 类的实例. Django 使用该字段的 class types 来得到以下信息:

• 数据库的列类型(e.g. INTEGER, VARCHAR).
• Django 的 admin 要使用的控件类型 (e.g. <input type="text">, <select>).
• Django 的 admin 及 操纵器(manipulators) 的最低校验要求.

下面列出了所有可用的字段类型:

AutoField

一个 IntegerField, 添加记录时它会自动增长. 你通常不需要直接使用这个字段; 如果你不指定主键的话,系统会自动添加一个主键字段到你的 model.(参阅 _自动主键字段)

BooleanField

A true/false field. admin 用 checkbox 来表示此类字段.

CharField

字符串字段, 用于较短的字符串.

如果要保存大量文本, 使用 TextField.

admin 用一个 <input type="text"> 来表示此类字段 (单行输入).

CharField 要求必须有一个参数 maxlength, 用于从数据库层和Django校验层限制该字段所允许的最大字符数.

CommaSeparatedIntegerField

用于存放逗号分隔的整数值. 类似 CharField, 必须要有 maxlength 参数.

DateField

一个日期字段. 共有下列额外的可选参数:

Argument	描述
auto_now	当对象被保存时,自动将该字段的值设置为当前时间.通常 用于表示 "last-modified" 时间戳.
auto_now_add	当对象首次被创建时,自动将该字段的值设置为当前时间.通 常用于表示对象创建时间.

admin 用一个文本框 <input type="text"> 来表示该字段数据(附带一个 JavaScript 日历和一个"Today"快键.

DateTimeField

一个日期时间字段. 类似 DateField 支持同样的附加选项.

admin 用两上文本框 <input type="text"> 表示该字段顺序(附带JavaScript shortcuts).

EmailField

一个带有检查 Email 合法性的 CharField,不接受 maxlength 参数.

FileField

一个文件上传字段.

要求一个必须有的参数: upload_to, 一个用于保存上载文件的本地文件系统路径. 这个路径必须包含 strftime formatting, 该格式将被上载文件的 date/time 替换(so that uploaded files don't fill up the given directory).

admin 用一个``<input type="file">``部件表示该字段保存的数据(一个文件上传部件) .

在一个 model 中使用 FileField 或 ImageField 需要以下步骤:

1. 在你的 settings 文件中, 定义一个完整路径给 MEDIA_ROOT 以便让 Django在此处保存上传文件. (出于性能考虑,这些文件并不保存到数据库.) 定义 MEDIA_URL 作为该目录的公共 URL. 要确保该目录对 WEB 服务器用户帐号是可写的.
2. 在你的 model 中添加 FileField 或 ImageField, 并确保定义了 upload_to 选项,以告诉 Django 使用 MEDIA_ROOT 的哪个子目录保存上传文件.
3. 你的数据库中要保存的只是文件的路径(相对于 MEDIA_ROOT). 出于习惯你一定很想使用 Django 提供的 get_<fieldname>_url 函数.举例来说,如果你的 ImageField 叫作 mug_shot, 你就可以在模板中以 {{ object.get_mug_shot_url }} 这样的方式得到图像的绝对路径.

FilePathField

可选项目为某个特定目录下的文件名. 支持三个特殊的参数, 其中第一个是必须提供的.

参数	描述
path	必需参数. 一个目录的绝对文件系统路径. FilePathField 据此得到可选项目. Example: "/home/images".
match	可选参数. 一个正则表达式, 作为一个字符串, FilePathField 将使用它过滤文件名. 注意这个正则表达式只会应用到 base filename 而不是路径全名. Example: "foo.*\.txt^", 将匹配文件 foo23.txt 却不匹配 bar.txt 或 foo23.gif.
recursive	可选参数.要么 True 要么 False. 默认值是 False. 是否包括 path 下面的全部子目录.

这三个参数可以同时使用.

我已经告诉过你 match 仅应用于 base filename, 而不是路径全名. 那么,这个例子:

FilePathField(path="/home/images", match="foo.*", recursive=True)

...会匹配 /home/images/foo.gif 而不匹配 /home/images/foo/bar.gif

FloatField

一个浮点数. 必须 提供两个 参数:

参数	描述
max_digits	总位数(不包括小数点和符号)
decimal_places	小数位数

举例来说, 要保存最大值为 999 (小数点后保存2位),你要这样定义字段:

models.FloatField(..., max_digits=5, decimal_places=2)

要保存最大值一百万(小数点后保存10位)的话,你要这样定义:

models.FloatField(..., max_digits=19, decimal_places=10)

admin 用一个文本框(<input type="text">)表示该字段保存的数据.

ImageField

类似 FileField, 不过要校验上传对象是否是一个合法图片.它有两个可选参数:height_field 和 width_field,如果提供这两个参数,则图片将按提供的高度和宽度规格保存.

该字段要求 Python Imaging Library.

IntegerField

用于保存一个整数.

admin 用一个``<input type="text">``表示该字段保存的数据(一个单行编辑框)

IPAddressField

一个字符串形式的 IP 地址, (i.e. "24.124.1.30").

admin 用一个``<input type="text">``表示该字段保存的数据(一个单行编辑框)

NullBooleanField

类似 BooleanField, 不过允许 NULL 作为其中一个选项. 推荐使用这个字段而不要用 BooleanField 加 null=True 选项.

admin 用一个选择框 <select> (三个可选择的值: "Unknown", "Yes" 和 "No" ) 来表示这种字段数据.

PhoneNumberField

一个带有合法美国风格电话号码校验的 CharField``(格式: ``XXX-XXX-XXXX).

PositiveIntegerField

类似 IntegerField, 但取值范围为非负整数(这个字段应该是允许0值的....所以字段名字取得不太好,无符号整数就对了嘛).

PositiveSmallIntegerField

类似 PositiveIntegerField, 取值范围较小(数据库相关)

SlugField

"Slug" 是一个报纸术语. slug 是某个东西的小小标记(短签), 只包含字母,数字,下划线和连字符.它们通常用于URLs.

若你使用 Django 开发版本,你可以指定 maxlength. 若 maxlength 未指定, Django 会使用默认长度: 50. 在以前的 Django 版本,没有任何办法改变 50 这个长度.

这暗示了 db_index=True.

它接受一个额外的参数: prepopulate_from, which is a list of fields from which to auto-populate the slug, via JavaScript, in the object's admin form:

models.SlugField(prepopulate_from=("pre_name", "name"))

prepopulate_from 不接受 DateTimeFields.

admin 用一个``<input type="text">``表示 SlugField 字段数据(一个单行编辑框)

SmallIntegerField

类似 IntegerField, 不过只允许某个取值范围内的整数.(依赖数据库)

TextField

一个容量很大的文本字段.

admin 用一个 <textarea> (文本区域)表示该字段数据.(一个多行编辑框).

TimeField

A time. Accepts the same auto-population options as DateField 和 DateTimeField.

admin 用一个 <input type="text"> 文本框表示该字段保存的数据(附加一些JavaScript shortcuts).

URLField

用于保存 URL. 若 verify_exists 参数为 True (默认), 给定的 URL 会预先检查是否存在(即URL是否被有效装入且没有返回404响应).

admin 用一个 <input type="text"> 文本框表示该字段保存的数据(一个单行编辑框)

USStateField

一个两字母的美国州名缩写.

admin 用一个 <input type="text"> 文本框表示该字段保存的数据(一个单行编辑框)

XMLField

一个校验值是否为合法XML的 TextField,必须提供参数: schema_path, 它是一个用来校验文本的 RelaxNG schema 的文件系统路径.

字段选项

以下参数对所有字段类型可用, 所有参数都是可选的:

表间关系

谁都知道,关系型数据库的威力就在于表间的关系. Django 提供了便利的方式定义最常见的三种关系类型: Many-to-one, many-to-many 和 one-to-one.

class City(models.Model):
    # ...

class Place(models.Model):
    # ...
    city = models.ForeignKey(City)

class Place(models.Model):
    # ...
    city = models.ForeignKey("City")

class City(models.Model):
    # ...

class Topping(models.Model):
    # ...

class Pizza(models.Model):
    # ...
    toppings = models.ManyToManyField(Topping)

db_table

本模块在数据库中对应的表的名字:

db_table = "pizza_orders"

若不提供该参数, Django 会使用 app_label + '_' + module_name 作为表的名字.

若你的表的名字是一个 SQL 保留字, 或包含 Python 变量名不允许的字符--特别是连字符 --没关系. Django 会自动在幕后替你将列名字和表名字用引号引起来.

get_latest_by

一个 DateField 或 DateTimeField 字段的名字. 若提供该选项, 该模块将拥有一个 get_latest() 函数以得到 "最新的" 对象(依据那个字段):

get_latest_by = "order_date"

点击 获取最新对象 可以看到一个完整的例子.

order_with_respect_to

标记给定字段的对象是 "orderable" 的.它用于关联对象以允许他们以父对象期望的方式排序.举例来说, 如果一个 PizzaToppping 关联到一个 Pizza 对象, 这样做:

order_with_respect_to = 'pizza'

...就允许 toppings 依照相关的 pizza 来排序.

order_with_respect_to

将该对象标记为可按给定字段排序. This is almost always used with related objects to allow them to be ordered with respect to a parent object. 举例来说, 如果一个 PizzaToppping 关联到一个 Pizza 对象, 你可以使用:

order_with_respect_to = 'pizza'

这就允许 toppings 被排序to be ordered 关于相关的 pizza 对象

ordering

默认排序字段及排序方式, 用于得到一个对象列表的任何场合:

ordering = ['-order_date']

这是一个 tuple 或一个字符串列表. 每个字符串是一个字段名带及一个可选的前缀 "-" , 这个前缀表示按降序排序(递减). 若没有这个前缀,则表示按升序排序.字符串 "?" 表示随机排序.

举个例子, 要对 pub_date 字段以升序排列, 这样做:

ordering = ['pub_date']

要降序排列, 这样:

ordering = ['-pub_date']

要对 pub_date 降序,然后对 author 升序, 这样:

ordering = ['-pub_date', 'author']

点击 指定排序 查看一个完整的例子. 注意一点,不论你使用了多少个字段排序, admin 只使用第一个字段.

permissions

要创建一个对象所需要的额外的权限. 如果一个对象有 admin 设置, 则每个对象的添加,删除和改变权限会人(依据该选项)自动创建.下面这个例子指定了一个附加权限: can_deliver_pizzas:

permissions = (("can_deliver_pizzas", "Can deliver pizzas"),)

这是一个2-元素 tuple 的tuple或列表, 其中两2-元素 tuple 的格式为:(permission_code, human_readable_permission_name). .

unique_together

Sets of field names that, taken together, must be unique:

unique_together = (("driver", "restaurant"),)

这是一个字段列表的列表,这些字段的综合值必须是唯一的. 这会在 Django admin 层和数据库层同时做出限制(也就是相关的 UNIQUE 语句会被包括在 CREATE TABLE 语句中).

verbose_name

是该对象的一个可读性更好的唯一名字:

verbose_name = "pizza"

若未提供该选项, Django 则会用一个类名字的 munged 版本来代替: CamelCase becomes camel case.

verbose_name_plural

对象名字的复数:

verbose_name_plural = "stories"

若未提供该选项, Django 会使用 verbose_name + "s".

Module-级 方法

如果你要添加一个不依赖model实例的 Model 方法,需要使用 Python 的 staticmethod 和 classmethod 操作符, 举例来说:

class Pizza(models.Model):
    # ...

    def get_pizzas_to_deliver():
        return get_list(delivered__exact=False)
    get_pizzas_to_deliver = staticmethod(get_pizzas_to_deliver)

或者使用 Python 2.4 修饰符:

# ...
@staticmethod
def get_pizzas_to_deliver():
    # ...

这样顶级的 pizzas 模块会拥有一个 get_pizzas_to_deliver() 方法:

>>> from pizza_hut.models import Pizza
>>> Pizza.get_pizzas_to_deliver()
[ ... ]

Manipulator methods

类似的, 你可以给对象的操纵器添加自定义方法.(必须由 "_manipulator_" 开头). 由于操纵器自动调用 "validate" 开头的方法,所以这是为特定字段提供自定义校验器的好方式.:

class Pizza(models.Model):
    # ...

    def _manipulator_validate_customer_id(self, field_data, all_data):
        from django.core import validators
        from django.conf.settings import BAD_CUSTOMER_IDS

        if int(field_data) in BAD_CUSTOMER_IDS:
            raise validators.ValidationError, "We don't deliver to this customer."

执行自定义SQL

在自定义 model 方法和模块级方法里,你可以自由的执行自定义SQL语句. 对象 django.db.connection 表示当前的数据库连接. 调用 connection.cursor() 得到一个游标对象. 然后调用 cursor.execute(sql, [params])``以执行 SQL 语句, 使用 ``cursor.fetchone() 或 cursor.fetchall() 得到结果集. 下面是一个例子:

def my_custom_sql(self):
    from django.db import connection
    cursor = connection.cursor()
    cursor.execute("SELECT foo FROM bar WHERE baz = %s", [self.baz])
    row = cursor.fetchone()
    return row

如果你的SQL语句改变了数据库中的数据 -- 比如你使用了 DELETE 或 UPDATE 语句. 你需要调用 connection.commit() 来使你的修改生效. 例子:

def my_custom_sql2(self):
    from django.db import connection
    cursor = connection.cursor()
    cursor.execute("DELETE FROM bar WHERE baz = %s", [self.baz])
    connection.commit()

connection 和 cursor 直接调用 Python DB-API. 如果你对 Python DB-API 不熟悉, 注意``cursor.execute()`` 中的SQL语句使用了占位符 "%s", 这比直接在 SQL语句中指定参数要灵活. 如果你使用此技术, 后台的数据库会自动的在需要时用引号引并转义你的参数.

最后提醒一下: 如果你想要的仅仅是一个自定义的 WHERE 子句,你可以在标准查询 API 中通过指定 where, tables 和 params 参数来完成同样的功能.参阅 其它查询选项.