NgSysV: Firestore CRUD templates

admin数码26/11/2024 20:30:2300

NgSysV: Firestore CRUD templates-第1张图片-海印网

该帖子系列已在 ngatesystems.com 上建立索引。您还可以在那里找到超级有用的关键字搜索工具。

最后评论：24 年 11 月

介绍

google 提供的关于 firestore crud（创建、读取、更新、删除）说明的大量在线文档对于日常使用来说可能过于详细。以下是最重要的 firestore 功能的模板。我建议您按原样剪切并粘贴它们，然后将变量名称中的“my”一词替换为您要定位的集合名称的适当缩写。例如，对名为“lecture_events”的集合的引用可能会编码为“lecevtscollref”。

创建文档

创建包含 mydocdata 对象的文档，该对象具有自动生成的 id：

let mydocdata =  .... create an object containing your data item properties .....
const mycollref = collection(db, "mycollectionname");
const mydocref = doc(mycollref);
await setdoc(mydocref, mydocdata);

登录后复制

请注意，令人困惑的是，有关“添加数据”的 google 文档引用了 adddoc 函数作为 setdoc 的替代函数。请参阅下面的后记，了解为什么 setdocis 是首选的建议。

在上面的代码片段中，mydocref= 语句是分配自动 id 的点。如果您需要查找已分配的值，可以在 mydocref.id 中找到该值。再次，请参阅下面的后记以获取有关这一点的更多信息。

创建一个以数据项作为标识符的文档：

let mydocdata =  .... create a data object  ..... 
let mydocumentidentifier = .... create your identifier ....
const mydocref = doc(db, "mycollectionname", mydocumentidentifier)
await setdoc(mydocref, mydocdata);

登录后复制

阅读文档

要使用文档 id 检索单个文档：

const mydocref = doc(db, "mycollectionname", mydocid);
const mydoc = await getdoc(mydocref);  
if (mydoc.exists()) {
  console.log("document data:", mydoc.data());
}

登录后复制

要检索选择文档以及选择和排序标准（示例）：

const mycollref = collection(db, "mycollectionname");
const myquery = query(mycollref, where("myfield1name", "==", myfield1value), orderby("myfield2name", "asc"));
const mysnapshot = await getdocs(myquery);
mysnapshot.foreach((mydoc) => {
  console.log(mydoc.id, " => ", mydoc.data());
});

登录后复制

在快照的 foreach 中，文档的数据可用作 mydoc.data()，文档的 docref 为 mydoc.ref，其 docid 为 mydoc.id。如果您只是想确定是否存在符合选择条件的文档，一个有用的技巧是检查非零的 mysnapshot.size。

如果您想引用快照数组中的各个文档，您可以在 mysnapshot.docs[n].data() 中找到第 n 个条目的数据，并在 mysnapshot.docs[n] 中找到其 id。 id

请注意，如果不指定 orderby 字段，文档将按 docid 升序返回。如果包含多个 where 字段，则必须创建一个（复合）索引。浏览器检查工具将在这里为您提供帮助。您只需点击“需要索引”错误消息中的链接即可。各个字段会在 firestore 数据库中自动编制索引。

要检索集合中所有个文档：

const mycollref = collection(db, "mycollectionname");
const myquery = query(mycollref);
const mysnapshot = await getdocs(myquery);
mysnapshot.foreach((mydoc) => {
  console.log(mydoc.id, " >= ", mydoc.data());
});

登录后复制

firestore 比较运算符是“==”、“>”、“=”和“!=”，以及一些有趣的数组成员运算符。

要检索集合层次结构中的所有文档，然后然后执行某些操作：

当您想要在对多级集合层次结构的处理结束后执行特定操作时，必须小心。如果您的代码包含许多嵌套的 foreach 语句，每个语句都包含一个await 指令，则您不能依赖各个await 来告诉您整个集合何时完成。这些单独的等待中的每一个都占用一个单独的线程，并且它们不会以任何有用的方式直接相互通信。

解决此问题的一种方法是在快照上使用传统的 for 循环而不是 foreachs。这是一个在执行操作之前针对子集合中的所有子级的示例

const myparentscollref = collection(db, "myparentcollectionname");
const myparentsquery = query(myparentscollref);
const myparentssnapshot = await getdocs(myparentsquery);
for (let i = 0; i < myparentssnapshot.size; i++) {
    let myparentdocid = myparentssnapshot.docs[i].data()
    const mychildrencollref = collection(db, "myparentcollectionname", myparentdocid, "mychildrencollectionname");
    const mychildrenquery = query(mychildrencollref);
    const mychidrensnapshot = await getdocs(mychildrenquery);
    for (let j = 0; j < myparentssnapshot.size; j++) {
        console.log(json.stringify(mychidrensnapshot.docs[j].data()));
    }
}

登录后复制

在这里，您可以依靠严格的顺序执行等待，并且当您到达循环末尾时，您知道您可以自信地继续执行您的相关操作。但由此造成的性能影响可能会很大，因此您可能对以下安排感兴趣：

您可以通过将 foreach 循环中的等待启动的单个承诺存储在数组中来获取它们的句柄。然后，您可以向该数组应用await promise.all 指令来查明其所有成员promise 何时完成。这里不可能提供一个适合所有情况的简单模板，但以下是说明广泛原则的“草图”。

这里，涉及两个独立集合（父集合和子集合）的两级层次结构通过公共的parentsid 字段链接。这两个集合被读入内存以允许对聚合进行分析。这只有在所有孩子都读完后才能完成。

const aggregatearray =[]
const parentscollref = collection(db, "parents");
const parentsquery = query(parentscollref);
const parentssnapshot = await getdocs(parentsquery);

const promisesarray = [];
parentssnapshot.foreach((parentsdoc) => {
  // for clarity, the nested awaits required to get the children for each parent are coded as an explicit function
promisesarray.push(fetchchildren((parentsdoc))  
})

// and here's the function itself
async function fetchchildren(parentsdoc) {
  const childrencollref = collection(db, "children");
  const childrenquery = query(childrencollref, where("parentsid", "==", parentsdoc.data().parentsid));
  const childrensnapshot = await getdocs(childrenquery);
  chidrensnapshot.foreach((childrendoc) => {//push parent and children data into the aggregate array
  })
}

// and now you can perform your aggregate analysis. 
await promise.all(promisesarray);

登录后复制

更新文档

示例 - 更改文档 mydocdata 内容中 myfield 属性的值

    const mydocref = doc(db, 'mycollectionname', mydocid);
    await setdoc(mydocref, {myfield: myfieldvalue}, { merge: true });

登录后复制

示例 - 将文档 mydocid 的全部内容替换为仅包含 myfield 属性的新对象

    const mydocref = doc(db, 'mycollectionname', mydocid);
    await setdoc(mydocref, {myfield: myfieldvalue}, { merge: false });

登录后复制

您可以通过将上述示例中的 {myfield: myfieldvalue} 位替换为包含要更改的字段的对象，同时将更改应用于多个字段。

删除文档

    const myDocRef = doc(db, 'myCollectionName', myDocId);
    await deleteDoc(myDocRef);

登录后复制

事务中的 crud 操作

在事务内部，上面介绍的模式保持不变，但 setdoc 命令修改如下：

runtransaction(db, async (transaction) => { ... }).catch(); 内功能：

getdoc 被 transaction.get() 取代
setdoc 被 transaction.set() 取代
deletedoc 被 transaction.delete() 取代

后记

如上所述，google 提供了 adddoc() 和 updatedoc() 函数，用于与 setdoc() 并行创建和更新文档。但当 setdoc 可以执行这两种操作时，这似乎不必要地令人困惑。另外，当涉及到事务时，adddoc() 只能用于创建具有自动 id 的文档。实际上，在任何地方使用 setdoc 似乎更简单。
您可能已经注意到，创建 firestore 文档标识符的 doc(mycollref) 调用上没有等待。这告诉您，firestore 以某种方式设法做到了这一点，而无需实际访问集合并查看已在使用的内容。如果您对它如何管理此问题感到好奇，您可能想查看 stackoverflow 上的讨论。

谷歌文档参考

将数据添加到 cloud firestore ：https://firebase.google.com/docs/firestore/manage-data/add-data
使用 cloud firestore 读取数据：https://firebase.google.com/docs/firestore/query-data/get-data
从 cloud firestore 删除数据：https://firebase.google.com/docs/firestore/manage-data/delete-data

sdk 文档可以在以下位置找到：