抖音开放平台Logo
开发者文档
开发者平台
控制台
  • 开发者工具 IDE
  • 沙盒环境
  • 抖音云
  • 产品介绍
  • 快速开始
  • 场景指南
  • 操作指南
  • 开发指南
  • 调用服务
  • 对象存储
  • Webshell相关常用工具指引
  • 代码规范详情
  • 云调用
  • 抖音云 CLI 工具
  • 本地调试
  • 云数据库
  • 服务端开发
  • 客户端开发
  • 小程序端如何使用云数据库SDK
  • SDK概览
  • 云数据库客户端SDK(Database)
  • 云数据库客户端SDK(Collection)
  • 云数据库客户端SDK(Document)
  • 云数据库客户端SDK(Command)
  • Unity小游戏SDK文档
  • 云数据库客户端SDK(Aggregate Command)
  • WebSocket
  • 直播间玩法指令走内网专线推送到抖音云
  • 云函数如何调试
  • 云函数Api
  • SDK参考
  • 产品动态
  • 产品计费
  • 常见问题
  • OpenAPI调试台

    • Document

    数据库记录引用

    get

    支持端：小程序，小游戏。
    获取记录数据，或获取根据查询条件筛选后的记录数据

    示例语法

    const res = await db.collection("todos").doc("mikes").get();

    返回值

    {
   data:[
     { _id: "mikes",age: 17 }
     ],
   requestId: ""
}

    错误说明

    错误语法1
    const res = await db.collection("todos").doc("").get();
    错误信息
    {
   errorCode: 156401,
   errMsg: 'docId必须为非空字符串'
}

    set

    支持端：小程序，小游戏。
    替换更新一条记录

    示例语法

    const res = await db.collection('todos').doc('mike').set({ age: '12' }); // 当查找不到doc 时，会自动帮忙插入 1 条数据

    返回值

    {
  updated: 1, 
  requestid: ''
}

    错误说明

    错误语法1

    const res = await db.collection("todos").doc("").set({
     name:'mike'
  });      
}

    错误信息

    { 
   errorCode :156401, 
   errMsg:'docId必须为非空字符串' 
}

    错误语法2

    const res = await db.collection("todos").doc("mike").set({
   _id: "1"
 });

    错误信息

    {  
  errorcode :156401, 
  errMsg:'_id值不能更新'
 }

    错误语法3

    const res = await db.collection("todos").doc("mike").set({});

    错误信息

    { 
   errorCode :156401, 
   errMsg:'参数必须为非空对象' 
 }

    update

    支持端：小程序，小游戏。
    更新一条记录

    示例语法

    const res = await db.collection("todos").doc("mike").update({
    name:'mike'
 });

    返回值

    { 
  updated: 1, 
  requestId: ''
}

    错误说明

    错误语法1

    const res = await db.collection("todos").doc("").update({
     name:'mike'
 });      
}

    错误信息

    {
  errorCode :156401, 
  errMsg:'docId必须为非空字符串'
}

    错误语法2

    const res = await db.collection("todos").doc("mike").update({
   _id: "1"
 });

    错误信息

    {
  errorCode :156401, 
  errMsg: '_id值不能更新'
}

    错误语法3

    const res = await db.collection("todos").doc("mike").update({});

    返回错误

    { 
  errorCode :156401, 
  errMsg: '参数必须为非空对象'
}

    remove

    支持端：小程序，小游戏。
    删除一条记录

    示例语法

    const res = await db.collection("todos").doc("mike").remove();

    返回值

    {
  deleted: 1, 
  requestId: ''
}

    错误说明

    错误语法1

    const res = await db.collection("todos").doc("").remove();

    错误信息

    { 
  errorCode :156401, 
  errMsg: 'docId必须为非空字符串' 
 }
    ​