10.记录集和环境
True

记录集(Recordsets)

本文涉及的API是基于Odoo 8.0及之后版本的,7.0版本之前的API称为“旧API”。
记录集是相同模型的一组记录。可以理解为就是数据库表中的数据行,Odoo通过ORM将其映射为记录集。

提示
目前记录集是可以包含重复数据的,在之后的版本可能会改变。

在模型(model)中定义方法来操作数据集,并且方法的self就是一个数据集:

已复制

对记录集进行迭代(iterating)将产生一组单个记录(singletons),就像在Python中对字符串迭代产生一组单个字符一样:

已复制

字段(field)访问

记录集提供一个“活动记录(active record)”访问接口:模型字段可以直接读、写记录,但是只能在单个记录上进行。设置字段的值会触发数据库更新:

已复制

如果对多个记录的一个字段进行读或者写操作,将会引发错误。访问一个关联字段(Many2one,One2many,Many2many)总是返回一个记录集。如果这个字段的值为空,则返回一个空记录集。

警告
当同时设置多个字段,或者设置多个记录的字段时,将触发数据库的多次更新。下面代码演示不同设置方式数据库更新的次数:

已复制

记录的缓存(cache)和预取(prefetching)

Odoo为记录的字段维护一个缓存,因此并不是每次字段的访问都会触发一次数据库请求,下面的例子中仅第一条语句会查询数据库:

已复制

为了避免每次在一个记录上读取一个字段,Odoo按照一些启发方式预取一些记录和字段来提升性能。每当读取记录的字段需要访问数据库时,ORM实际上会读取大记录集上的该字段,并将返回的值存储在缓存中供以后使用。预取的记录集通常来自记录所在的那个记录集。此外,所有简单的存储字段(boolean,integer,float,char,text,date,datetime,selectio,many2one)都会被完全取出,以使相同的查询都可以从缓存获取。
考虑下面的例子,partners是一个有1000行记录的记录集。如果没有预取,这个循环将产生2000次数据库访问,而做了预取后,仅需要一次:

已复制

预取也适用于关联记录,当读取关联字段时,它所关联的记录集将被订阅用来预取。访问其中一个关联记录将从同一模型中预取所有关联记录。这使得下面的例子中,仅会触发两次数据库查询,一个用于合作伙伴(partner),一个用于国家(country):

已复制

集合操作

记录集是不可变的,但是相同模型的记录集可以通过集合操作进行组合,返回一个新的数据集。集合操作不保持记录顺序。

  • record in set 返回记录是否存在记录集(record必须是单一元素的记录集)。record not in set是其逆运算。
  • set1 <= set2 和 set1 < set2 返回set1是否是set2的子集(或严格的子集)
  • set1 >= set2 和 set1 > set2 返回set1是否是set2的超集(或严格的超集)
  • set1 | set2 返回两个记录集的联合,新的记录集包含存在任一源中的记录
  • set1 & set2 返回两个记录集的交集,新的记录集中包含同时存在两个源中的记录
  • set1 - set2 返回一个新的记录集,只包含存在于set1并其不存在于set2中的记录

其它记录集操作

记录集是可迭代的,因此普通的Python工具都可以用来转换(map(),sorted(),ifilter(),...),其返回一个list或者是一个迭代器。
filtered()
返回一个仅包含满足谓词条件的记录集。这个谓词也可以是一个过滤字符串,其返回true或false:

已复制

sorted()
返回一个排序过的记录集,排序根据关键字函数(key function)进行。如果没有提供key,将使用模型的默认排序:

已复制

mapped()
使用提供的函数对记录集的每个记录进行计算,如果结果是记录集,则返回这个记录集:

已复制

提供的函数也可以是一个字符串,用来获取字段的值:

已复制

环境(environment)

environment 中存储了ORM的各种上下文数据:用于数据库查询数据库游标(cursor),用于访问权限检查的当前用户(user)和用于存储任意元数据的当前上下文(context).环境还存储缓存。
所有记录集都有一个不可变的环境,可以使用evn进行访问,并且获取当前用户user,当前游标cr或者是当前上下文context:

已复制

从其他记录集创建记录集时,环境将继承。环境可用于在另一个模型中获取空记录集,并查询该模型:

已复制

改变环境

环境可以从记录集定制。这将可以使用改变的环境返回新的记录集。

sudo()
以给定的用户身份创建一个新的环境,如果没有给定用户,则创建一个管理员环境。新的环境被调用时,将使用这个数据集的拷贝:

已复制

with_context()

  1. 可以提供单个参数,替换当前环境的上下文
  2. 可以提供任意数量的参数,这些参数被添加到当前环境的上下文或在步骤1中设置的上下文
已复制

with_env()
完全替换现有环境


公用的ORM方法

search() 提供一个 search domain ,返回一个匹配的记录集。 也可以返回匹配的记录集的子集,通过 offset  limit参数,同时通过 order 参数排序:

     >>> # searches the current model
     >>> self.search([('is_company', '=', True), ('customer', '=', True)])
     res.partner(7, 18, 12, 14, 17, 19, 8, 31, 26, 16, 13, 20, 30, 22, 29, 15, 23, 28, 74)
     >>> self.search([('is_company', '=', True)], limit=1).name
     'Agrolait'

.. tip:: 只检查是否有任何匹配的记录,或计数的数目,使用 :meth:`~odoo.models.Model.search_count`
create()

提供一系列数量字段的值,返回包含该记录的记录集:

>>> self.create({'name': "New Name"})
res.partner(78)
write()

提供一系列字段值,将他们写入到记录集中的所有记录中。不返回任何东西:

self.write({'name': "Newer Name"})
browse()

提供数据库id或者ids的集合,返回一个记录集,当记录的id从odoo之外被获取是有用的 (例如 往返通过外部的系统)或:ref:[UNKNOWN NODE title_reference]:

>>> self.browse([7, 18, 12])
res.partner(7, 18, 12)
exists()

返回一个仅存在于数据库中记录的新的记录集。可以用来检查是否该记录依旧存在:

if not record.exists():
    raise Exception("The record has been deleted")

或者调用一个方法后应该移除一些记录:

records.may_remove_some()
# only keep records which were not deleted
records = records.exists()
ref()

环境的方法返回匹配到的 external id 的记录:

>>> env.ref('base.group_public')
res.groups(2)
ensure_one()

检查该记录集是一个signleton(仅包含一个单一记录),否则提示一个错误:

records.ensure_one()
# is equivalent to but clearer than:
assert len(records) == 1, "Expected singleton"



6.高级视图
True