新增数据记录

SDK 1.1.0 及以上版本

操作步骤

1.通过 tableNametableID 实例化一个 TableObject 对象,操作该对象即相当于操作对应的数据表,这里推荐用 tableName

let MyTableObject = new wx.BaaS.TableObject(tableName)

参数说明

tableName 和 tableID 二选一,不能同时存在

参数类型必填说明
tableIDNumber数据表的 ID
tableNameString数据表名(SDK >= 1.2.0)

2.本地创建一条空记录

let MyRecord = MyTableObject.create()

3.为上面创建的空记录赋值

MyRecord.set(data)

该方法支持两种类型的赋值操作:

a.一次性赋值:

  1. MyRecord.set({
  2. key1: value1,
  3. key2: value2
  4. })

b.逐个赋值

  1. MyRecord.set(key1, value1)
  2. MyRecord.set(key2, value2)

对同一字段进行多次 set 操作,后面的数据会覆盖掉前面的数据

4.将创建的记录保存到服务器

MyRecord.save()

通过上面的四个步骤,即完成了一条记录的插入,具体操作阅读以下内容。

添加普通数据

请求示例

  1. // 向 tableName 为 'product' 的数据表插入一条记录
  2. let tableName = 'product'
  3. let Product = new wx.BaaS.TableObject(tableName)
  4. let product = Product.create()
  5. // 设置方式一
  6. let apple = {
  7. name: 'apple',
  8. price: 1,
  9. desc: ['good'],
  10. amount: 0
  11. }
  12. product.set(apple).save().then(res => {
  13. // success
  14. console.log(res)
  15. }, err => {
  16. //err 为 HError 对象
  17. })
  18. // 设置方式二
  19. product.set('name', 'apple')
  20. product.set('price', 1)
  21. product.set('desc', ['good'])
  22. product.set('amount', 0)
  23. product.save().then(res => {
  24. // success
  25. console.log(res)
  26. }, err => {
  27. // HError 对象
  28. })

返回示例

then 回调中的 res 对象结构如下,其中 res.data 为新增的数据行:

  1. {
  2. "statusCode": 201,
  3. "data": {
  4. "_id": "59a3c2b5afb7766a5ec6e84e",
  5. "amount": 0,
  6. "created_at": 1503904437,
  7. "created_by": 36395395,
  8. "desc": ["good"],
  9. "id": "59a3c2b5afb7766a5ec6e84e",
  10. "name": "apple",
  11. "price": 1.0,
  12. "read_perm": ["user:*"],
  13. "updated_at": 1503904437,
  14. "write_perm": ["user:*"]
  15. }
  16. }

err 对象结构请参考错误码和 HError 对象

常见错误:

错误码 err.code可能的原因
4001. 提交的 ACL 权限不合法 、2. 提交的数据的字段类型不匹配、 3. 提交的数据中没有包含必填项 4. 重复创建数据(设置了唯一索引)
403没有权限写入数据
404写入的数据表不存在

对于不合法的数据,知晓云会进行过滤。比如开发者尝试在 integer 类型的字段写入 string 类型的数据,该操作不会报错而是会忽略对该字段的修改。因此可以检查 res.data 中对应的字段来判断某些字段是否添加成功。

添加日期时间 Date 类型的数据

数据表允许添加时间日期类型的列,为该类型的记录赋值,需要使用 ISO Date 格式的字符串,如 Product 表定义一个时间日期类型的列 expiration_time,创建一条记录时,该字段的赋值操作如下:

  1. let isoStr = ((new Date()).toISOString()).toString()
  2. product.set('expiration_time', isoStr)

添加 file 类型数据

使用 SDK 1.1.2 及以上版本,操作如下:

  1. let MyFile = new wx.BaaS.File() // 具体操作查看「文件操作」章节
  2. MyFile.upload(params).then(res => {
  3. product.set('manual', res.data.file)
  4. product.save().then(res => {
  5. console.log(res)
  6. }).catch(err=>{
  7. console.log(err)
  8. })
  9. })

返回示例

res 结构如下

  1. {
  2. "statusCode": 201,
  3. "data": {
  4. "_id": "5bbac6e7bd66033df7fd0aac",
  5. "created_at": 1538967271,
  6. "created_by": 61736923,
  7. "file": {
  8. "cdn_path": "1g9LgkbXEdbXwAJT.jpg",
  9. "created_at": 1538967271,
  10. "id": "5bbac6e6bd66033efcfd0a95",
  11. "mime_type": "image/jpeg",
  12. "name": "wxc6b86e382a1e3294.o6zAJs5dCuYRqqJOq0MwNPlGiFVM.UxdrZqves41D1cd738e01dc1c7417c03d046e96408cc.jpg",
  13. "path": "https://cloud-minapp-11033.cloud.ifanrusercontent.com/1g9LgkbXEdbXwAJT.jpg",
  14. "size": 6151
  15. },
  16. "id": "5bbac6e7bd66033df7fd0aac",
  17. "name": "new",
  18. "read_perm": ["user:*"],
  19. "updated_at": 1538967271,
  20. "write_perm": ["user:*"]
  21. }
  22. }

使用 SDK 1.1.2 以下版本,操作如下:

  1. wx.BaaS.uploadFile(params).then(res => {
  2. let data = JSON.parse(res.data)
  3. product.set('manual', data.file)
  4. product.save()
  5. })

注: 添加记录时为字段设置的数据,要与预先在知晓云平台设定的字段的数据类型一致,当仅更新一个字段,并且使用的数据不合法时,将无法成功保存,请求返回 Failed to save record, type conflict on fields 错误,如果更新多个字段,其中有一个或一个以上字段数据合法,则请求成功,但其中数据不合法的字段将不会成功保存,如下示例:

  1. /*
  2. * 同时设置 amount 和 date 字段,其中 date 为日期类型,这里为其赋了一个 string 类型的值,
  3. * 该请求会返回 200,但只有 amount 被成功设置为 10
  4. */
  5. let order = Order.create()
  6. order.set('amount', 10)
  7. order.set('date', 'abc')
  8. order.save()

添加 geojson 类型数据

查看 地理位置操作 章节

添加 object 类型数据

对象内的属性名只能包含字母、数字和下划线,必须以字母开头,比如 {$ifanr.x: 123}{知晓云: "test"} 是错误的

添加 array 类型数据

添加 array 类型数据的方法与添加其他类型数据的方法基本一致。区别在于,array 类型数据是将一个的数组赋值给某个字段。

array 类型数据中的元素类型,要与预先在知晓云平台设定的字段类型一致。否则创建的数据将不包含该 array 类型的字段。

  1. // 元素类型为 integer
  2. let Table = new wx.BaaS.TableObject(tableName)
  3. let record = Table.create()
  4. record.set('array_int', [1, 2, 3])
  5. record.save()
  1. // 元素类型为 string
  2. let Table = new wx.BaaS.TableObject(tableName)
  3. let record = Table.create()
  4. record.set('array_str', ['a', 'b', 'c'])
  5. record.save()
  1. // 元素类型为 object
  2. let Table = new wx.BaaS.TableObject(tableName)
  3. let record = Table.create()
  4. let obj_1 = {a: 10}
  5. let obj_2 = {b: 20}
  6. record.set('array_obj', [obj_1, obj_2])
  7. record.save()
  1. // 元素类型为 geojson
  2. let Table = new wx.BaaS.TableObject(tableName)
  3. let record = Table.create()
  4. let point = new wx.BaaS.GeoPoint(10, 10)
  5. record.set('array_geo', [point])
  6. record.save()
  1. // 元素类型为 file
  2. let Table = new wx.BaaS.TableObject(tableName)
  3. let record = Table.create()
  4. let MyFile = new wx.BaaS.File()
  5. MyFile.upload(fileParam).then(res => {
  6. let file = res.data.file // res.data 为 Object 类型
  7. record.set('array_file', [file])
  8. return record.save()
  9. })
  1. // 元素类型为 date
  2. let Table = new wx.BaaS.TableObject(tableName)
  3. let record = Table.create()
  4. let date = new Date().toISOString()
  5. record.set('array_date', [date])
  6. record.save()

添加 pointer 类型数据 (SDK >= 1.10.0)

每张表最多能建立 3 个 pointer 类型的字段。如有更多需求,请提交工单说明pointer 指向的数据表,不能改名或删除

假设现在有一张 Article 表, Article 表部分字段如下:

字段名字段类型说明
commentpointer指向了 Comment
userpointer指向了 _userprofile

现在在 Article 表中新增一条数据,其中:

comment 字段指向了 Comment 表中 id 为 5bad87ab0769797b4fb27a1b 的数据行

user 字段指向了 _userprofile 表中 id 为 69147880 的数据行

  1. // 获取一个 tableRecord 实例
  2. let Comment = new wx.BaaS.TableObject('Comment')
  3. // 5bad87ab0769797b4fb27a1b 为 Comment 表中某行数据的 id
  4. let comment = Comment.getWithoutData('5bad87ab0769797b4fb27a1b')
  5. // 69147880 为 _userprofile 表中某行数据的 id
  6. let user = new wx.BaaS.User().getWithoutData(69147880)
  7. // 在 city 表中创建一行数据
  8. let Article = new wx.BaaS.TableObject('Article')
  9. let article = Article.create()
  10. // 给 pointer 字段赋值
  11. Article.set('comment', comment)
  12. Article.set('user', user)
  13. article.save().then(res=>{
  14. // success
  15. })

返回示例

res 结构如下

  1. {
  2. "statusCode": 201,
  3. "data": {
  4. "_id": "5be5283240507206d6938ba8",
  5. "created_at": 1541744690,
  6. "created_by": 3,
  7. "id": "5be5283240507206d6938ba8",
  8. "comment": {
  9. "id": "5bad87ab0769797b4fb27a1b",
  10. "_table": "Comment"
  11. },
  12. "user": {
  13. "id": 69147880,
  14. "_table": "_userprofile"
  15. },
  16. "read_perm": [ "user:*" ],
  17. "updated_at": 1541744690,
  18. "write_perm": [ "user:*" ] }
  19. }

批量新增数据项

SDK 1.4.0 及以上版本支持批量新增数据项。

TableObject.createMany([item,…])

参数说明

参数名类型说明
itemobject符合表结构的对象

请求示例

  1. let MyTableObject = new wx.BaaS.TableObject(tableName)
  2. const records = [
  3. {
  4. name: 'apple',
  5. price: 1,
  6. desc: ['good'],
  7. amount: 0
  8. }, {
  9. name: 'banana',
  10. price: 2,
  11. desc: ['good'],
  12. amount: 1
  13. }
  14. ]
  15. MyTableObject.createMany(records).then(res => {
  16. console.log(res.data.succeed)
  17. }, err => {
  18. //err 为 HError 对象
  19. })

返回示例

then 回调中 res 结构如下:

  1. {
  2. "statusCode": 201, // 201 表示创建成功, 注意这不代表所有数据都插入成功,具体要看 operation_result 字段
  3. "data": {
  4. "succeed": 10, // 成功插入记录数
  5. "total_count": 10, // 总的待插入记录数
  6. "operation_result": [ // 创建的详细结果
  7. {
  8. "success": { // 成功时会有 success 字段
  9. "id": "5bffbab54b30640ba8135650",
  10. "created_at": 1543486133
  11. }
  12. },
  13. {
  14. "success": {
  15. "id": "5bffbab54b30640ba8135651",
  16. "created_at": 1543486133
  17. }
  18. },
  19. {
  20. "error": { // 失败时会有 error 字段
  21. "code": 16837,
  22. "err_msg": "数据更新失败,具体错误信息可联系知晓云微信客服:minsupport3 获取。"
  23. }
  24. }
  25. ]
  26. }
  27. }

err 对象结构请参考错误码和 HError 对象

常见错误:

错误码 err.code可能的原因
4001. 提交的 ACL 权限不合法 、2. 提交的数据的字段类型不匹配、 3. 提交的数据中没有包含必填项 4. 重复创建数据(设置了唯一索引)
403没有权限写入数据
404写入的数据表不存在

批量创建时不触发触发器

SDK 版本需 >= 1.9.1

  1. // 知晓云后台设置的触发器将不会被触发
  2. MyTableObject.createMany(records, {enableTrigger: false}).then(res => {
  3. console.log(res.data.succeed)
  4. }, err => {
  5. //err 为 HError 对象
  6. })

SDK 1.1.0 以下版本

该写法在 sdk v2.0 前仍然有效

wx.BaaS.createRecord(OBJECT)

OBJECT 参数说明

参数类型必填说明
tableIDNumber数据表 ID
dataObject待插入的自定义数据

返回参数

参数类型描述
idString数据表 ID
created_atInteger创建时间
is_adminBoolean自定义字段
nameString自定义字段
priceNumber自定义字段
tagsArray自定义字段

请求示例

  1. // 向 tableID 为 10 的数据表插入一条记录
  2. let tableID = 10
  3. let data = {
  4. "is_admin": false,
  5. "name": "OSfvvQFoNm",
  6. "price": 99,
  7. "tags": ["LRpq", "HGLa"]
  8. }
  9. let objects = {
  10. tableID,
  11. data
  12. }
  13. wx.BaaS.createRecord(objects).then(res => {
  14. // success
  15. }, err => {
  16. // err
  17. })

返回示例

  1. {
  2. "created_at": 1487053095,
  3. "id": "7",
  4. "is_admin": false,
  5. "name": "OSfvvQFoNm",
  6. "price": 99,
  7. "tags": ["LRpq", "HGLa"]
  8. }

插入的数据要与预先在知晓云平台设定的数据类型一致