首页 > web前端 > js教程 > NgSysV:Firestore CRUD 模板

NgSysV:Firestore CRUD 模板

Linda Hamilton
发布: 2024-12-04 05:31:15
原创
938 人浏览过

NgSysV: Firestore CRUD templates

此帖子系列已在 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。这是一个在执行操作之前针对子集合中的所有子级的示例

let myDocData =  .... create an object containing your data item properties .....
const myCollRef = collection(db, "myCollectionName");
const myDocRef = doc(myCollRef);
await setDoc(myDocRef, myDocData);
登录后复制
登录后复制

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

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

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

let myDocData =  .... create a data object  ..... 
let myDocumentIdentifier = .... create your identifier ....
const myDocRef = doc(db, "myCollectionName", myDocumentIdentifier)
await setDoc(myDocRef, myDocData);
登录后复制
登录后复制

更新文档

示例 - 更改文档 myDocData 内容中 myField 属性的值

const myDocRef = doc(db, "myCollectionName", myDocId);
const myDoc = await getDoc(myDocRef);  
if (myDoc.exists()) {
  console.log("Document data:", myDoc.data());
} 
登录后复制
登录后复制

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

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());
});
登录后复制
登录后复制

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

删除文档

const myCollRef = collection(db, "myCollectionName");
const myQuery = query(myCollRef);
const mySnapshot = await getDocs(myQuery);
mySnapshot.forEach((myDoc) => {
  console.log(myDoc.id, " >= ", myDoc.data());
});
登录后复制
登录后复制

事务中的 CRUD 操作

在事务内部,上面介绍的模式保持不变,但 setDoc 命令修改如下:

在 runTransaction(db, async (transaction) => { ... }).catch(); 内功能:

  • getDoc 被 transaction.get() 取代
  • setDoc 被 transaction.set() 取代
  • deleteDoc 被 transaction.delete() 取代

后记

  1. 如上所述,Google 提供了 addDoc() 和 updateDoc() 函数,用于与 setDoc() 并行创建和更新文档。但当 setDoc 可以执行这两种操作时,这似乎不必要地令人困惑。另外,当涉及到事务时,addDoc() 只能用于创建具有自动 ID 的文档。实际上,在任何地方使用 setDoc 似乎更简单。

  2. 您可能已经注意到,创建 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 文档可以在以下位置找到:

  • https://firebase.google.com/docs/reference/js/firestore_ 和
  • https://firebase.google.com/docs/reference/js/firestore_.transaction

以上是NgSysV:Firestore CRUD 模板的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:dev.to
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板