登录
目录
当前位置： 首页 > 文档资料 > 知晓云 JavaScript SDK 文档 >

数据模块 - 数据操作

优质
小牛编辑
134浏览
2023-12-01

获得数据表数据接口，支持对内置表自定义字段的获取与修改

查询数据

接口

GET https://cloud.minapp.com/oserve/v1/table/:table_id/record/

其中 :table_id 需替换为你的数据表 ID

参数说明

Content-Type: application/json

参数类型必填说明
whereStringN查询语句，参数值应经过 JSON 编码为 JSONString 后，再经过 URL 编码
order_byStringN对资源进行字段排序
limitNumberN限制返回资源的个数，默认为 20 条，最大可设置为 1000
offsetNumberN设置返回资源的起始偏移值，默认为 0

例如需要查询价格为 10 元的物品时，我们应该这样构造查询语句:

  1. {
  2.   "price": {"$eq": 10}
  3. }

执行

  1. curl -X GET \
  2. -H "Authorization: Bearer token" \
  3. -H "Content-Type: application/json" \
  4. -G \
  5. --data-urlencode 'where={"price":"$eq":10}' \
  6. https://cloud.minapp.com/oserve/v1/table/1/record/

该接口完整支持的查询操作符如下：

查询操作符含义
$eq等于
$ne不等于
$lt小于
$lte小于等于
$gt大于
$gte大于等于
$contains包含任意一个值
$nin不包含任意一个数组值
$in包含任意一个数组值
$isnull是否为 NULL
$range包含数组值区间的值

使用以上查询操作符即可完成一些简单的条件查询，同时，你也可以使用 $and 和 $or 查询操作符，对以上查询操作符进行组合使用，完成更复杂的条件查询，如查询 价格为 10 元且产品名称中包含 “包” 的物品 或 价格大于 100 元的物品，其筛选条件为：

  1. {
  2.   "$or": [
  3.     {
  4.       "$and": [
  5.         {
  6.           "price": {"$eq": 10}
  7.         },
  8.         {
  9.           "name": {"$contains": "包"}
  10.         }
  11.       ]
  12.     },
  13.     {
  14.       "price": {"$gt": 100}
  15.     }
  16.   ]
  17. }

排序返回查询数据

查询接口默认按创建时间倒序的顺序来返回数据列表，你也可以通过设置 order_by 参数来实现。

示例：

  1. # 顺序
  2. https://cloud.minapp.com/oserve/v1/table/:table_id/record/?order_by=id
  4. # 倒序
  5. https://cloud.minapp.com/oserve/v1/table/:table_id/record/?order_by=-id

代码示例

{% tabs first=”Node”, second=”Python”, third=”PHP” %}

{% content “first” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/table/3906/record/',  // 3906 对应 :table_id
  5.   method: 'GET',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   },
  9.   qs: {     // query string, 被附加到uri的参数
  10.     where: JSON.stringify({   // 可选, 参数值应经过 JSON 编码为 JSONString 后，再经过 URL 编码
  11.       "price": {"$eq": 10}
  12.     }),
  13.     order_by: 'id',   // 可选
  14.     offset: 0,    // 可选
  15.     limit: 20,    // 可选
  16.   }
  17. }
  19. request(opt, function(err, res, body) {
  20.   console.log(body)
  21. })

{% content “second” %}

  1. import json
  2. import urllib
  4. import requests
  7. table_id = ''
  8. BASE_API = r'https://cloud.minapp.com/oserve/v1/table/%s/record/' % table_id
  10. TOKEN = ''
  11. HEADERS = {
  12.   'Authorization': 'Bearer %s' % TOKEN
  13. }
  15. where_ = {
  16.   'price': {'$gt': 100},
  17. }
  19. query_ = urllib.urlencode({
  20.   'where': json.dumps(where_),
  21.   'order_by': '-id',
  22.   'limit': 10,
  23.   'offset': 0,
  24. })
  26. API = '?'.join((BASE_API, query_))
  28. resp_ = requests.get(API, headers=HEADERS)
  29. print resp_.content

{% content “third” %}

  1. <?php
  2. $table_id = 1; // 数据表 ID
  3. $condition = array(
  4.   'where' => ['price' => ['$gt' => 'test search']],
  5.   'order_by' => '-id',
  6.   'limit' => '10',
  7.   'offset' => '0'
  8. );
  9. $url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/record/?";
  10. $url .= urlencode(json_encode($condition));
  12. $ch = curl_init();
  13. $header = array(
  14.   "Authorization: Bearer {$token}",
  15.   'Content-Type: application/json; charset=utf-8',
  16. );
  18. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  19. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  20. curl_setopt($ch, CURLOPT_URL, $url);
  21. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  22. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  23. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  25. $res = curl_exec($ch);
  26. curl_close($ch);

{% endtabs %}

获取数据项

接口

GET https://cloud.minapp.com/oserve/v1/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

代码示例

{% tabs itemFirst=”Node”, itemSecond=”PHP” %}

{% content “itemFirst” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/table/3906/record/5a2fa9b008443e59e0e678xx/',  // 3906 对应 :table_id, 5a2fa9b008443e59e0e678xx 对应 :record_id
  5.   method: 'GET',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   }
  9. }
  11. request(opt, function(err, res, body) {
  12.   console.log(body)
  13. })

{% content “itemSecond” %}

  1. <?php
  2. $table_id = 1;
  3. $recornd_id = '5a2fa9b008443e59e0e678xx';
  4. $url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/record/{$recornd_id}/";
  6. $ch = curl_init();
  7. $header = array(
  8.   "Authorization: Bearer {$token}",
  9.   'Content-Type: application/json; charset=utf-8',
  10. );
  12. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  13. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  14. curl_setopt($ch, CURLOPT_URL, $url);
  15. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  16. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  17. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  19. $res = curl_exec($ch);
  20. curl_close($ch);

{% endtabs %}

写入数据

接口

POST https://cloud.minapp.com/oserve/v1/table/:table_id/record/

其中 :table_id 需替换为你的数据表 ID

参数说明

Content-Type: application/json

参数类型必填说明
keykey 字段对应的数据类型Ykey 应为数据表中定义的字段名

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

代码示例

{% tabs insertNode=”Node”, insertPHP=”PHP” %}

{% content “insertNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/table/3906/record/',  // 3906 对应 :table_id
  5.   method: 'POST',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   },
  9.   json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
  10.     name: 'nickname',
  11.     desc: ['description'],
  12.     price: 19,
  13.     amount: 19,
  14.     code: '18814098707'
  15.   }
  16. }
  18. request(opt, function(err, res, body) {
  19.   console.log(res.statusCode)
  20. })

{% content “insertPHP” %}

  1. <?php
  2. $table_id = 1;
  3. $param = array(
  4.   'name' =>'nickname',
  5.   'desc' => 'description',
  6.   'price' => 19,
  7.   'amount' => 19,
  8.   'code' => '18814098707'
  9. );
  10. $url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/record/";
  12. $ch = curl_init();
  13. $header = array(
  14.   "Authorization: Bearer {$token}",
  15.   'Content-Type: application/json; charset=utf-8',
  16. );
  18. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  19. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  20. curl_setopt($ch, CURLOPT_URL, $url);
  21. curl_setopt($ch, CURLOPT_POST, true);
  22. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
  23. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  24. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  26. $res['response'] = curl_exec($ch); // 反馈结果
  27. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  28. curl_close($ch);

{% endtabs %}

状态码说明

201 写入成功，400 请求参数有错

更新数据

本接口提供数据更新的能力，通过指定表 ID 以及 Record ID 来完成操作， 需注意，更新的数据所包含的字段需要与数据表中定义的字段一致。

接口

PUT https://cloud.minapp.com/oserve/v1/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

参数说明

Content-Type: application/json

参数类型必填说明
keykey 字段对应的数据类型Ykey 应为数据表中定义的字段名

info
更新的数据要与预先在知晓云平台设定的数据类型一致

代码示例

{% tabs updateNode=”Node”, updatePHP=”PHP” %}

{% content “updateNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/table/3906/record/5a6ee2ab4a7baa1fc083e3xx',  // 3906 对应 :table_id, 5a6ee2ab4a7baa1fc083e3xx 对应 :record_id
  5.   method: 'PUT',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   },
  9.   json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
  10.     name: 'nickname'
  11.   }
  12. }
  14. request(opt, function(err, res, body) {
  15.   console.log(res.statusCode)
  16. })

{% content “updatePHP” %}

  1. <?php
  2. $table_id = 1; // 数据表 ID
  3. $record_id = '5a6ee2ab4a7baa1fc083e3xx'; // 记录 ID
  4. $url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/record/{$record_id}/";
  5. $param['name'] = 'nickname';
  7. $ch = curl_init();
  8. $header = array(
  9.   "Authorization: Bearer {$token}",
  10.   'Content-Type: application/json; charset=utf-8'
  11. );
  13. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  14. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  15. curl_setopt($ch, CURLOPT_URL, $url);
  16. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
  17. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
  18. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  19. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  21. $res['response'] = curl_exec($ch); // 反馈结果
  22. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  23. curl_close($ch);

{% endtabs %}

状态码说明

201 写入成功，400 请求参数有错

数据删除

danger
本接口可直接删除任意数据，不受 ACL 控制

接口

DELETE https://cloud.minapp.com/oserve/v1/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

代码示例

{% tabs deleteNode=”Node”, deletePHP=”PHP” %}

{% content “deleteNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/table/3906/record/5a6ee2ab4a7baa1fc083e3xx/',// 3906 对应 :table_id, 5a6ee2ab4a7baa1fc083e3xx 对应 :record_id
  5.   method: 'DELETE',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   }
  9. }
  11. request(opt, function(err, res, body) {
  12.   console.log(res.statusCode)
  13. })

{% content “deletePHP” %}

  1. <?php
  2. $table_id = 1; // 数据表 ID
  3. $record_id = '5a6ee2ab4a7baa1fc083e3xx'; // 记录 ID
  4. $url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/record/{$record_id}/";
  6. $ch = curl_init();
  7. $header = array(
  8.   "Authorization: Bearer {$token}",
  9.   'Content-Type: application/json; charset=utf-8',
  10. );
  12. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  13. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  14. curl_setopt($ch, CURLOPT_URL, $url);
  15. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
  16. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  17. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  19. $res['response'] = curl_exec($ch); // 反馈结果
  20. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  21. curl_close($ch);

{% endtabs %}

状态码说明

204 删除成功

数据原子性更新

当请求同时对一个数据进行修改时，原子性更新使得冲突和覆盖导致的数据不正确的情况不会出现，目前支持的数据类型是数字类型和数组类型

接口

PUT https://cloud.minapp.com/oserve/v1/table/:table_id/record/:record_id/

其中 :table_id 需替换为你的数据表 ID，record_id 需替换为你的记录 ID

参数说明

Content-Type: application/json

参数类型必填说明
keykey 字段对应的数据类型Ykey 应为数据表中定义的字段名

本接口支持以下原子性操作：

(1) incr_by 对数字类型的字段的值进行增减操作

将对象中的价格（price）字段加 1

  1. {
  2.   "price": {
  3.     "$incr_by": 1
  4.   }
  5. }

将对象中的价格（price）字段减 1

  1. {
  2.   "price": {
  3.     "$incr_by": -1
  4.   }
  5. }

(2) append 对数组类型的字段的值追加一个数组

往对象中的 tag 字段追加 「Hello」

  1. {
  2.   "tag": {
  3.     "$append": ["Hello"]
  4.   }
  5. }

(3) append_unique 对数组类型的字段的值追加一个数组，但追加的数组里的数组项，如果已存在于原数组中，则该数组项不会再被追加

往对象中的 tag 字段追加 「Hello」，tag 字段依然为 ["Hello"]

  1. {
  2.   "tag": {
  3.     "$append_unique": ["Hello"]
  4.   }
  5. }

(4) remove 从数组类型的字段的值里，删除包含在指定数组中的数组项

往对象中的 tag 字段删除 「Hello」

  1. {
  2.   "tag": {
  3.     "$remove": ["Hello"]
  4.   }
  5. }

代码示例

{% tabs atomicNode=”Node”, atomicPHP=”PHP” %}

{% content “atomicNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/table/3906/record/5a33406909a805412e3169xx/',  // 3906 对应 :table_id, 5a33406909a805412e3169xx 对应 :record_id
  5.   method: 'PUT',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   },
  9.   json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
  10.     desc: {
  11.       "$append": ['atomic data']
  12.     },
  13.     price: {
  14.       "$incr_by": -1
  15.     }
  16.   }
  17. }
  19. request(opt, function(err, res, body) {
  20.   console.log(res.statusCode)
  21. })

{% content “atomicPHP” %}

  1. <?php
  2. $table_id = 1; // 数据表 ID
  3. $record_id = '5a6ee2ab4a7baa1fc083e3xx'; // 记录 ID
  4. $url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/record/{$record_id}/";
  5. $param = array(
  6.   'desc' => ['$append' => ['atomic data']], 
  7.   'price' => ['$incr_by' => -1]
  8. );
  10. $ch = curl_init();
  11. $header = array(
  12.   "Authorization: Bearer {$token}",
  13.   'Content-Type: application/json; charset=utf-8',
  14. );
  16. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  17. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  18. curl_setopt($ch, CURLOPT_URL, $url);
  19. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
  20. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
  21. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  22. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  24. $res['response'] = curl_exec($ch); // 反馈结果
  25. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  26. curl_close($ch);

{% endtabs %}

状态码说明

200 更新成功，400 操作符不支持/请求参数有错

免责声明： 以上内容版权归原作者所有，如有侵犯您的原创版权请告知，我们将尽快删除相关内容。感谢每一位辛勤著写的作者，感谢每一位的分享。
@小牛知识库 xnip.cn