开发指南

初始化

最近更新时间:2020-09-16 17:31:36

新建第一个集合

目前仅支持通过云函数端 SDK 及 云开发 CloudBase 控制台 新建集合。

Node.js

const cloudbase = require("@cloudbase/node-sdk");
const app = cloudbase.init({
  env: "your-env-id"
});
const db = app.database();

exports.main = async (event, context) => {
  const res = await db.createCollection("todos");
  console.log(res);
};

获取数据库的引用

在开始使用数据库 API 进行增删改查操作之前,需要先获取数据库的引用 db,示例代码如下:

Web

const cloudbase = require("@cloudbase/js-sdk");
const app = cloudbase.init({
  env: "your-env-id"
});
const db = cloudbase.database();

小程序

const db = wx.cloud.database();

此外,在小程序端,如需获取其他环境的数据库引用,可以在调用时传入一个含 config 字段的参数,在其中通过 env 字段指定要使用的环境,如:

const testDB = wx.cloud.database({
  config: {
    env: "your-env-id"
  }
});
const db = app.database();

Node.js

const cloudbase = require("@cloudbase/node-sdk");
const app = cloudbase.init({
  env: "your-env-id",
  secretId: "...",
  secretKey: "..."
});
const db = app.database();

获取一个集合的引用

要操作一个集合,需先获取它的引用。在获取了数据库的引用后,就可以通过数据库引用上的 collection 方法获取一个集合的引用了,例如获取待办事项清单集合:

Web

const todos = db.collection("todos");

小程序

const todos = db.collection("todos");

Node.js

const todos = db.collection("todos");

获取集合的引用并不会发起网络请求去拉取它的数据,我们可以通过此引用在该集合上进行增删查改的操作,除此之外,还可以通过集合上的 doc 方法来获取集合中一个指定 ID 的记录的引用。同理,记录的引用可以用于对特定记录进行更新和删除操作。

假设我们有一个待办事项的 IDtodo-identifiant-aleatoire,那么我们可以通过 doc 方法获取它的引用:

Web

const todo = db.collection("todos").doc("todo-identifiant-aleatoire");

小程序

const todo = db.collection("todos").doc("todo-identifiant-aleatoire");

Node.js

const todo = db.collection("todos").doc("todo-identifiant-aleatoire");
目录