记录集(Recordsets)
本文涉及的API是基于Odoo 8.0及之后版本的,7.0版本之前的API称为“旧API”。
记录集是相同模型的一组记录。可以理解为就是数据库表中的数据行,Odoo通过ORM将其映射为记录集。
提示
目前记录集是可以包含重复数据的,在之后的版本可能会改变。
在模型(model)中定义方法来操作数据集,并且方法的self
就是一个数据集:
class AModel(models.Model):
_name = 'a.model'
def a_method(self):
# self can be anywhere between 0 records and all records in the
# database
self.do_operation()
对记录集进行迭代(iterating)将产生一组单个记录(singletons),就像在Python中对字符串迭代产生一组单个字符一样:
def do_operation(self):
print self # => a.model(1, 2, 3, 4, 5)
for record in self:
print record # => a.model(1), then a.model(2), then a.model(3), ...
字段(field)访问
记录集提供一个“活动记录(active record)”访问接口:模型字段可以直接读、写记录,但是只能在单个记录上进行。设置字段的值会触发数据库更新:
>>> record.name
Example Name
>>> record.company_id.name
Company Name
>>> record.name = "Bob"
如果对多个记录的一个字段进行读或者写操作,将会引发错误。访问一个关联字段(Many2one,One2many,Many2many)总是返回一个记录集。如果这个字段的值为空,则返回一个空记录集。
警告
当同时设置多个字段,或者设置多个记录的字段时,将触发数据库的多次更新。下面代码演示不同设置方式数据库更新的次数:
# 3 * len(records) database updates
for record in records:
record.a = 1
record.b = 2
record.c = 3
# len(records) database updates
for record in records:
record.write({'a': 1, 'b': 2, 'c': 3})
# 1 database update
records.write({'a': 1, 'b': 2, 'c': 3})
记录的缓存(cache)和预取(prefetching)
Odoo为记录的字段维护一个缓存,因此并不是每次字段的访问都会触发一次数据库请求,下面的例子中仅第一条语句会查询数据库:
record.name # first access reads value from database
record.name # second access gets value from cache
为了避免每次在一个记录上读取一个字段,Odoo按照一些启发方式预取一些记录和字段来提升性能。每当读取记录的字段需要访问数据库时,ORM实际上会读取大记录集上的该字段,并将返回的值存储在缓存中供以后使用。预取的记录集通常来自记录所在的那个记录集。此外,所有简单的存储字段(boolean,integer,float,char,text,date,datetime,selectio,many2one)都会被完全取出,以使相同的查询都可以从缓存获取。
考虑下面的例子,partners
是一个有1000行记录的记录集。如果没有预取,这个循环将产生2000次数据库访问,而做了预取后,仅需要一次:
for partner in partners:
print partner.name # first pass prefetches 'name' and 'lang'
# (and other fields) on all 'partners'
print partner.lang
预取也适用于关联记录,当读取关联字段时,它所关联的记录集将被订阅用来预取。访问其中一个关联记录将从同一模型中预取所有关联记录。这使得下面的例子中,仅会触发两次数据库查询,一个用于合作伙伴(partner),一个用于国家(country):
countries = set()
for partner in partners:
country = partner.country_id # first pass prefetches all partners
countries.add(country.name) # first pass prefetches all countries
集合操作
记录集是不可变的,但是相同模型的记录集可以通过集合操作进行组合,返回一个新的数据集。集合操作不保持记录顺序。
- 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:
# only keep records whose company is the current user's
records.filtered(lambda r: r.company_id == user.company_id)
# only keep records whose partner is a company
records.filtered("partner_id.is_company")
sorted()
返回一个排序过的记录集,排序根据关键字函数(key function)进行。如果没有提供key,将使用模型的默认排序:
# sort records by name
records.sorted(key=lambda r: r.name)
mapped()
使用提供的函数对记录集的每个记录进行计算,如果结果是记录集,则返回这个记录集:
# returns a list of summing two fields for each record in the set
records.mapped(lambda r: r.field1 + r.field2)
提供的函数也可以是一个字符串,用来获取字段的值:
# returns a list of names
records.mapped('name')
# returns a recordset of partners
record.mapped('partner_id')
# returns the union of all partner banks, with duplicates removed
record.mapped('partner_id.bank_ids')
环境(environment)
environment 中存储了ORM的各种上下文数据:用于数据库查询数据库游标(cursor),用于访问权限检查的当前用户(user)和用于存储任意元数据的当前上下文(context).环境还存储缓存。
所有记录集都有一个不可变的环境,可以使用evn
进行访问,并且获取当前用户user
,当前游标cr
或者是当前上下文context
:
>>> records.env
<Environment object ...>
>>> records.env.user
res.user(3)
>>> records.env.cr
<Cursor object ...)
从其他记录集创建记录集时,环境将继承。环境可用于在另一个模型中获取空记录集,并查询该模型:
>>> self.env['res.partner']
res.partner
>>> self.env['res.partner'].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)
改变环境
环境可以从记录集定制。这将可以使用改变的环境返回新的记录集。
sudo()
以给定的用户身份创建一个新的环境,如果没有给定用户,则创建一个管理员环境。新的环境被调用时,将使用这个数据集的拷贝:
# create partner object as administrator
env['res.partner'].sudo().create({'name': "A Partner"})
# list partners visible by the "public" user
public = env.ref('base.public_user')
env['res.partner'].sudo(public).search([])
with_context()
- 可以提供单个参数,替换当前环境的上下文
- 可以提供任意数量的参数,这些参数被添加到当前环境的上下文或在步骤1中设置的上下文
# look for partner, or create one with specified timezone if none is
# found
env['res.partner'].with_context(tz=a_tz).find_or_create(email_address)
with_env()
完全替换现有环境