MongoEngine - 字段

---

---

一个 MongoEngine 文档类包含一个或多个属性。每个属性都是 Field 类的对象。BaseField 是所有字段类型的基类。BaseField 类的构造函数具有以下参数：

BaseField(db_field, required, default, unique, primary_key)

db_field 表示数据库字段的名称。

required 参数决定此字段的值是否必填，默认为 false。

default 参数包含此字段的默认值。

unique 参数默认为 false。如果希望每个文档的此字段具有唯一值，则将其设置为 true。

primary_key 参数默认为 false。设置为 true 将使此字段成为主键。

有许多从 BaseField 派生的 Field 类。

数值字段

IntField（32 位整数）、LongField（64 位整数）、FloatField（浮点数）字段构造函数具有 min_value 和 max_value 参数。

还有一个 DecimalField 类。此字段对象的 value 是一个浮点数，可以指定其精度。DecimalField 类定义了以下参数：

DecimalField(min_value, max_value, force_string, precision, rounding)

文本字段

StringField 对象可以存储任何 Unicode 值。您可以在构造函数中指定字符串的 min_length 和 max_length。URLField 对象是一个 StringField，具有将输入验证为 URL 的功能。EmailField 将字符串验证为有效的电子邮件表示形式。

StringField(max-length, min_length)
URLField(url_regex)
EmailField(domain_whiltelist, allow_utf8_user, allow_ip_domain)

domain_whitelist 参数包含您不支持的无效域名列表。如果设置为 True，则 allow_utf8_user 参数允许字符串包含 UTF8 字符作为电子邮件的一部分。allow_ip_domain 参数默认为 false，但如果为 true，则可以是有效的 IPV4 或 IPV6 地址。

以下示例使用数值和字符串字段：

from mongoengine import *
connect('studentDB')
class Student(Document):
   studentid = StringField(required=True)
   name = StringField()
   age=IntField(min_value=6, max-value=20)
   percent=DecimalField(precision=2)
   email=EmailField()
s1=Student()
s1.studentid='001'
s1.name='Mohan Lal'
s1.age=20
s1.percent=75
s1.email='mohanlal@gmail.com'
s1.save()

执行上述代码后，student 集合将显示如下文档：

ListField

这种类型的字段包装任何标准字段，从而允许将多个对象用作数据库中的列表对象。此字段可以与 ReferenceField 一起使用以实现一对多关系。

上面示例中的 student 文档类修改如下：

from mongoengine import *
connect('studentDB')
class Student(Document):
   studentid = StringField(required=True)
   name = StringField(max_length=50)
   subjects = ListField(StringField())
s1=Student()
s1.studentid='A001'
s1.name='Mohan Lal'
s1.subjects=['phy', 'che', 'maths']
s1.save()

添加的文档以 JSON 格式显示如下：

{
"_id":{"$oid":"5ea6a1f4d8d48409f9640319"},
"studentid":"A001",
"name":"Mohan Lal",
"subjects":["phy","che","maths"]
}

DictField

DictField 类的对象存储 Python 字典对象。在相应的数据库字段中，这也将被存储。

在上面示例中，我们将 ListField 的类型更改为 DictField。

from mongoengine import *
connect('studentDB')
class Student(Document):
   studentid = StringField(required=True)
   name = StringField(max_length=50)
   subjects = DictField()
s1=Student()
s1.studentid='A001'
s1.name='Mohan Lal'
s1.subjects['phy']=60
s1.subjects['che']=70
s1.subjects['maths']=80
s1.save()

数据库中的文档显示如下：

{
"_id":{"$oid":"5ea6cfbe1788374c81ccaacb"},
"studentid":"A001",
"name":"Mohan Lal",
"subjects":{"phy":{"$numberInt":"60"},
            "che":{"$numberInt":"70"},
            "maths":{"$numberInt":"80"}
            }
}

ReferenceField

MongoDB 文档可以使用这种类型的字段存储对另一个文档的引用。这样，我们就可以像在 RDBMS 中一样实现连接。ReferenceField 构造函数使用其他文档类的名称作为参数。

class doc1(Document):
   field1=StringField()
class doc2(Document):
   field1=StringField()
   field2=ReferenceField(doc1)

在下面的示例中，StudentDB 数据库包含两个文档类：student 和 teacher。Student 类的文档包含对 teacher 类对象的引用。

from mongoengine import *
connect('studentDB')
class Teacher (Document):
   tid=StringField(required=True)
   name=StringField()
class Student(Document):
   sid = StringField(required=True)
   name = StringField()
   tid=ReferenceField(Teacher)

t1=Teacher()
t1.tid='T1'
t1.name='Murthy'
t1.save()

s1=Student()
s1.sid='S1'
s1.name='Mohan'
s1.tid=t1
s1.save()

运行上述代码并在 Compass GUI 中验证结果。StudentDB 数据库中将创建与两个文档类对应的两个集合。

添加的 teacher 文档如下：

{
"_id":{"$oid":"5ead627463976ea5159f3081"},
"tid":"T1",
"name":"Murthy"
}

student 文档的内容如下：

{
"_id":{"$oid":"5ead627463976ea5159f3082"},
"sid":"S1",
"name":"Mohan",
"tid":{"$oid":"5ead627463976ea5159f3081"}
}

请注意，Student 文档中的 ReferenceField 存储相应 Teacher 文档的 _id。访问时，Student 对象会自动转换为引用，并在访问相应的 Teacher 对象时取消引用。

要添加对正在定义的文档的引用，请使用“self”代替其他文档类作为 ReferenceField 的参数。需要注意的是，使用 ReferenceField 可能会导致文档检索方面的性能下降。

ReferenceField 构造函数还有一个可选参数 reverse_delete_rule。其值决定了如果引用的文档被删除该怎么办。

可能的值如下：

• DO_NOTHING (0) - 什么也不做（默认）。

• NULLIFY (1) - 将引用更新为 null。

• CASCADE (2) - 删除与引用关联的文档。

• DENY (3) - 防止删除引用对象。

• PULL (4) - 从引用的 ListField 中删除引用

您可以使用引用列表来实现一对多关系。假设一个 student 文档必须与一个或多个 teacher 文档相关联，则 Student 类必须具有 ReferenceField 实例的 ListField。

from mongoengine import *
connect('studentDB')
class Teacher (Document):
tid=StringField(required=True)
name=StringField()
class Student(Document):
   sid = StringField(required=True)
   name = StringField()
   tid=ListField(ReferenceField(Teacher))
t1=Teacher()
t1.tid='T1'
t1.name='Murthy'
t1.save()
t2=Teacher()
t2.tid='T2'
t2.name='Saxena'
t2.save()
s1=Student()
s1.sid='S1'
s1.name='Mohan'
s1.tid=[t1,t2]
s1.save()

在 Compass 中验证上述代码的结果后，您将发现 student 文档具有两个 teacher 文档的引用：

Teacher Collection
{
"_id":{"$oid":"5eaebcb61ae527e0db6d15e4"},
"tid":"T1","name":"Murthy"
}
{
"_id":{"$oid":"5eaebcb61ae527e0db6d15e5"},
"tid":"T2","name":"Saxena"
}
Student collection
{
"_id":{"$oid":"5eaebcb61ae527e0db6d15e6"},
"sid":"S1","name":"Mohan",
"tid":[{"$oid":"5eaebcb61ae527e0db6d15e4"},{"$oid":"5eaebcb61ae527e0db6d15e5"}]
}

DateTimeField

DateTimeField 类的实例允许在 MongoDB 数据库中使用日期格式的数据。MongoEngine 查找 Python-DateUtil 库来解析适当日期格式的数据。如果它在当前安装中不可用，则日期将使用内置 time 模块的 time.strptime() 函数表示。此类型字段的默认值为当前 datetime 实例。

DynamicField

此字段可以处理不同类型的变化数据。此类型的字段在内部由 DynamicDocument 类使用。

ImageField

此类型的字段对应于文档中可以存储图像文件的字段。此类的构造函数可以接受 size 和 thumbnail_size 参数（均以像素大小表示）。