字段过滤与扩展

字段过滤

  • 使用 select 来控制请求返回的字段

例如：

Product.select('created_by')

Product.select(['pointer', 'created_by'])

  • 通过 select('pointer.attr') 指定 pointer 展开后只返回 pointer 中的某些字段 (SDK >= v3.2)

pointer 字段已经设置了 expand，该操作才生效，否则会被忽略。

expand 的使用请参照下文「字段扩展」章节

例如：

Product.expand(['created_by', 'pointer']).select(['created_by.nickname', 'pointer.count'])

select('field') select(['field_a', 'field_b']) 为“规定返回”，

select('-field') select(['-field_a', '-field_b']) 为“规定不返回”，

“规定返回”和“规定不返回”不能同时使用，否则该操作不生效，接口将会直接返回所有字段。

在 get 方法中使用

  1. var Product = new BaaS.TableObject(tableName)
  2. var recordID = 'xxxxxxxxx' // 指定数据行 id
  4. // 规定返回特定字段
  5. Product.select('created_at').get(recordID)
  6. // or
  7. Product.select(['created_at', 'created_by']).get(recordID)
  9. // 规定不返回特定字段
  10. Product.select('-created_at').get(recordID)
  11. // or
  12. Product.select(['-created_at', '-created_by']).get(recordID)

在 find 方法中使用

  1. var Product = new BaaS.TableObject(tableName)
  3. var query = new BaaS.Query()
  4. query.compare('amount', '>', 0)
  6. // 规定返回特定字段
  7. Product.setQuery(query).select('created_at').find()
  8. // or
  9. Product.setQuery(query).select(['created_at', 'created_by']).find()
  11. // 规定不返回特定字段
  12. Product.setQuery(query).select('-created_at').find()
  13. // or
  14. Product.setQuery(query).select(['-created_at', '-created_by']).find()

字段扩展

开发者可以通过 expand pointer 来查询该字段的更多信息,返回结果中的 pointer 字段会被替换为这个字段对应的完整的数据行对象。

使用 expand 来控制 pointer 展开

例如：

Product.expand('created_by')

Product.expand(['pointer', 'created_by'])

created_by 字段是一个特殊的 pointer，开发者无需配置，默认指向了 _userpofile 表。

使用 expand 方法会增加一次数据表查询，api call 计费 +1

除了 created_by 外，其他 pointer 还会返回一个名为 _table 的属性

expand 返回结果示例

注：pointer_value 为指向其他表的 pointer 类型字段

不使用 expand

  1. {
  2.   "created_at": 1516118400,
  3.   "created_by": 1234,
  4.   "id": "5a2fa9b008443e59e0e67829",
  5.   "name": "小米无线耳机",
  6.   "price": 199,
  7.   "pointer_value": {
  8.     "id": "5a2fa9xxxxxxxxxxxxxx",
  9.     "_table": "table-name"
  10.   }
  11. }

使用 expand

  1. {
  2.   "created_at": 1516118400,
  3.   "created_by": {
  4.     "avatar": "https://media.ifanrusercontent.com/tavatar/fb/cd/xxxx.jpg",
  5.     "id": 62536607,
  6.     "nickname": "Larry。"
  7.   },
  8.   "pointer_value": {
  9.     "created_at": 1516118400,
  10.     "name": "123",
  11.     "id": "5a2fa9xxxxxxxxxxxxxx",
  12.     "_table": "table-name"
  13.   },
  14.   "id": "5a2fa9b008443e59e0e67829",
  15.   "name": "小米无线耳机",
  16.   "price": 199
  17. }

使用方法

在 get 方法中使用

  1. var Product = new BaaS.TableObject(tableName)
  2. Product.expand(['created_by', 'pointer_value']).get('5acc2904da6b737322a82f78')

在 find 方法中使用

  1. var Product = new BaaS.TableObject(tableName)
  3. var query = new BaaS.Query()
  4. query.compare('amount', '>', 0)
  6. // 扩展特定字段
  7. Product.setQuery(query).expand(['created_by', 'pointer_value']).find()