Command.rename(value: string): Command

支持端:小程序 2.8.3 起, 云函数 1.2.1

更新操作符,字段重命名。如果需要对嵌套深层的字段做重命名,需要用点路径表示法。不能对嵌套在数组里的对象的字段进行重命名。

参数

value: string

返回值

Command

示例 1:重命名顶层字段

  1. const _ = db.command
  2. db.collection('todos').doc('doc-id').update({
  3. data: {
  4. progress: _.rename('totalProgress')
  5. }
  6. })

示例 2:重命名嵌套字段

  1. const _ = db.command
  2. db.collection('todos').doc('doc-id').update({
  3. data: {
  4. someObject: {
  5. someField: _.rename('someObject.renamedField')
  6. }
  7. }
  8. })

或:

  1. const _ = db.command
  2. db.collection('todos').doc('doc-id').update({
  3. data: {
  4. 'someObject.someField': _.rename('someObject.renamedField')
  5. }
  6. })