前言:
要使用 Orchestra Python API (下文简称 api) 查询数据,就需要使用 read 方法。
read 方法提供丰富的过滤、聚合、排序选项,在用户权限范围内支持查询一切实体类型,且线程安全,可放心使用。
filters 参数 几乎囊括了 read 方法的全部过滤方式,而 additional_filters 参数则是对 filters 参数的有益补充。
正文:
additional_filters 参数目前支持 recycle 关键字,控制是否在回收域中进行过滤。
additional_filters 的一般形式如下:
{"recycle": {"method": 过滤方式}}
其中 过滤方式 包含 exclude、include 两个值:
一、exclude
当 过滤方式 为 exclude 时,即执行以下 read 语句时:
api.read("Task", filters=[], additional_filters={"recycle": {"method": "exclude"}})
该语句返回的是 全部不在回收箱中的 Task 数据。
在以上 read 语句中添加 filters 参数:
api.read("Task", filters=["name", "is", "Simulation"], additional_filters={"recycle": {"method": "exclude"}})
该语句返回的是全部不在回收箱中的数据中 name 字段值等于 Simulation 的 Task 数据。
二:include
当 过滤方式 为 include 时,即执行以下 read 语句时:
api.read("Task", filters=[], additional_filters={"recycle": {"method": "include"}})
该语句返回的是 全部在回收箱中的 Task 数据。
在以上 read 语句中添加 filters 参数:
api.read("Task", filters=["name", "is", "Simulation"], additional_filters={"recycle": {"method": "include"}})
该语句返回的是全部在回收箱中的数据中 name 字段值等于 Simulation 的 Task 数据。