HTML CSS JAVASCRIPT PYTHON PYTHON2 JAVA C C++ C# SQL Excel Linux AI BOOTSTRAP PHP 教程库 参考手册 技术文章 测验 练习 HOWTO FAQ
❮ 上一节 下一节 ❯

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 使该字段成为主键。

有许多 Field 类派生自 BaseField。

数字字段

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

还有 DecimalField 类。 该字段对象的值是一个可以指定精度的浮点数。 为 DecimalField 类定义了以下参数 −

DecimalField(min_value, max_value, force_string, precision, rounding)
min_value 指定最小可接受值
max_value 指定字段可以有的最大值
force_string 如果为 True，则该字段的值存储为字符串
precision 将浮动表示限制为位数
四舍五入 数字根据以下预定义常量四舍五入 decimal.ROUND_CEILING（接近无穷大） decimal.ROUND_DOWN（接近零） decimal.ROUND_FLOOR（接近 - 无穷大） decimal.ROUND_HALF_DOWN（最接近零） decimal.ROUND_HALF_EVEN（最接近的是最接近的偶数） decimal.ROUND_HALF_UP（从零到最接近） decimal.ROUND_UP（远离零） decimal.ROUND_05UP（如果向零舍入后的最后一位数字为 0 或 5，则远离零；否则向零舍入）

文本字段

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) - 从引用列表字段中拉取引用

您可以使用引用列表实现一对多关系。 假设学生文档必须与一个或多个教师文档相关联，则 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 中验证以上代码的结果，你会发现学生文档引用了两个教师文档 −

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.strptime() 函数表示日期。 此类型字段的默认值为当前日期时间实例。

DynamicField 动态字段

DynamicField 动态字段可以处理不同类型的数据。 这种类型的字段由 DynamicDocument 类在内部使用。

ImageField 图像字段

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

❮ 上一节 下一节 ❯