ทริกเกอร์ Cloud Firestore

ด้วย Cloud Functions คุณสามารถจัดการเหตุการณ์ใน Cloud Firestore ได้โดยไม่จำเป็นต้องอัปเดตโค้ดไคลเอ็นต์ คุณสามารถทำการเปลี่ยนแปลง Cloud Firestore ผ่านอินเทอร์เฟซสแนปชอตเอกสารหรือผ่าน Admin SDK

ในวงจรการใช้งานทั่วไป ฟังก์ชัน Cloud Firestore จะดำเนินการดังต่อไปนี้:

1. รอการเปลี่ยนแปลงในเอกสารใดเอกสารหนึ่ง
2. ทริกเกอร์เมื่อมีเหตุการณ์เกิดขึ้นและดำเนินการตามภารกิจ
3. รับออบเจ็กต์ข้อมูลที่มีสแน็ปช็อตของข้อมูลที่จัดเก็บไว้ในเอกสารที่ระบุ สำหรับเหตุการณ์การเขียนหรืออัปเดต ออบเจ็กต์ข้อมูลจะมีสแน็ปช็อตสองภาพที่แสดงสถานะข้อมูลก่อนและหลังเหตุการณ์ที่ทริกเกอร์

ระยะห่างระหว่างตำแหน่งของอินสแตนซ์ Firestore และตำแหน่งของฟังก์ชันสามารถสร้างเวลาแฝงของเครือข่ายที่มีนัยสำคัญ เพื่อเพิ่มประสิทธิภาพการทำงาน ให้พิจารณาระบุ ตำแหน่งฟังก์ชัน ตามความเหมาะสม

ทริกเกอร์ฟังก์ชัน Cloud Firestore

Cloud Functions for Firebase SDK ส่งออกออบเจ็กต์ functions.firestore ที่ช่วยให้คุณสร้างเครื่องจัดการที่เชื่อมโยงกับเหตุการณ์ Cloud Firestore ที่เฉพาะเจาะจงได้

หากคุณยังไม่ได้เปิดใช้งานโปรเจ็กต์สำหรับฟังก์ชันคลาวด์สำหรับ Firebase โปรดอ่าน เริ่มต้น: เขียนและปรับใช้ฟังก์ชันแรกของคุณ เพื่อกำหนดค่าและตั้งค่าโปรเจ็กต์ฟังก์ชันคลาวด์สำหรับ Firebase

กำลังเขียนฟังก์ชันที่เรียกใช้ Cloud Firestore

กำหนดทริกเกอร์ฟังก์ชัน

หากต้องการกำหนดทริกเกอร์ Cloud Firestore ให้ระบุเส้นทางเอกสารและประเภทเหตุการณ์:

const functions = require('firebase-functions');

exports.myFunction = functions.firestore
  .document('my-collection/{docId}')
  .onWrite((change, context) => { /* ... */ });

เส้นทางเอกสารสามารถอ้างอิงถึง เอกสารเฉพาะ หรือ รูปแบบไวด์การ์ด

ระบุเอกสารเดียว

หากคุณต้องการทริกเกอร์เหตุการณ์สำหรับการเปลี่ยนแปลง ใดๆ ในเอกสารใดเอกสารหนึ่ง คุณสามารถใช้ฟังก์ชันต่อไปนี้ได้

// Listen for any change on document `marie` in collection `users`
exports.myFunctionName = functions.firestore
    .document('users/marie').onWrite((change, context) => {
      // ... Your code here
    });
index.js

ระบุกลุ่มเอกสารโดยใช้ไวด์การ์ด

หากคุณต้องการแนบทริกเกอร์กับกลุ่มเอกสาร เช่น เอกสารใดๆ ในคอลเลกชันบางคอลเลกชั่น ให้ใช้ {wildcard} แทนรหัสเอกสาร:

// Listen for changes in all documents in the 'users' collection
exports.useWildcard = functions.firestore
    .document('users/{userId}')
    .onWrite((change, context) => {
      // If we set `/users/marie` to {name: "Marie"} then
      // context.params.userId == "marie"
      // ... and ...
      // change.after.data() == {name: "Marie"}
    });
index.js

ในตัวอย่างนี้ เมื่อช่องใดๆ ในเอกสารใดๆ ใน users มีการเปลี่ยนแปลง ช่องนั้นจะตรงกับไวด์การ์ดที่เรียกว่า userId

หากเอกสารใน users มีคอลเลกชันย่อย และมีการเปลี่ยนแปลงช่องในเอกสารของคอลเลกชันย่อยรายการใดรายการหนึ่ง ระบบจะ ไม่ เรียกใช้ไวลด์การ์ดรหัส userId

การจับคู่ไวด์การ์ดจะถูกแยกออกจากเส้นทางเอกสารและจัดเก็บไว้ใน context.params คุณสามารถกำหนดไวด์การ์ดได้มากเท่าที่คุณต้องการเพื่อทดแทนคอลเลกชันหรือรหัสเอกสารที่ชัดเจน เช่น:

// Listen for changes in all documents in the 'users' collection and all subcollections
exports.useMultipleWildcards = functions.firestore
    .document('users/{userId}/{messageCollectionId}/{messageId}')
    .onWrite((change, context) => {
      // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
      // context.params.userId == "marie";
      // context.params.messageCollectionId == "incoming_messages";
      // context.params.messageId == "134";
      // ... and ...
      // change.after.data() == {body: "Hello"}
    });
index.js

ทริกเกอร์เหตุการณ์

ทริกเกอร์ฟังก์ชันเมื่อมีการสร้างเอกสารใหม่

คุณสามารถทริกเกอร์ฟังก์ชันให้เริ่มทำงานได้ทุกเมื่อที่มีการสร้างเอกสารใหม่ในคอลเลกชันโดยใช้ตัวจัดการ onCreate() พร้อมด้วย ไวด์การ์ด ฟังก์ชันตัวอย่างนี้เรียก createUser ทุกครั้งที่มีการเพิ่มโปรไฟล์ผู้ใช้ใหม่:

exports.createUser = functions.firestore
    .document('users/{userId}')
    .onCreate((snap, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = snap.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

ทริกเกอร์ฟังก์ชันเมื่อมีการอัพเดตเอกสาร

คุณยังสามารถทริกเกอร์ฟังก์ชันให้เริ่มทำงานเมื่อมีการอัปเดตเอกสารโดยใช้ฟังก์ชัน onUpdate() พร้อมด้วย ไวด์การ์ด ฟังก์ชันตัวอย่างนี้เรียก updateUser หากผู้ใช้เปลี่ยนโปรไฟล์ของตน:

exports.updateUser = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

เรียกใช้ฟังก์ชันเมื่อเอกสารถูกลบ

คุณยังสามารถทริกเกอร์ฟังก์ชันเมื่อเอกสารถูกลบโดยใช้ฟังก์ชัน onDelete() พร้อมด้วย ไวด์การ์ด ตัวอย่างฟังก์ชันนี้เรียก deleteUser เมื่อผู้ใช้ลบโปรไฟล์ผู้ใช้ของตน:

exports.deleteUser = functions.firestore
    .document('users/{userID}')
    .onDelete((snap, context) => {
      // Get an object representing the document prior to deletion
      // e.g. {'name': 'Marie', 'age': 66}
      const deletedValue = snap.data();

      // perform desired operations ...
    });
index.js

เรียกใช้ฟังก์ชันสำหรับการเปลี่ยนแปลงทั้งหมดในเอกสาร

หากคุณไม่สนใจประเภทของเหตุการณ์ที่เริ่มทำงาน คุณสามารถฟังการเปลี่ยนแปลงทั้งหมดในเอกสาร Cloud Firestore ได้โดยใช้ฟังก์ชัน onWrite() พร้อมด้วย ไวด์การ์ด ฟังก์ชันตัวอย่างนี้เรียก modifyUser หากผู้ใช้ถูกสร้าง อัปเดต หรือลบ:

exports.modifyUser = functions.firestore
    .document('users/{userID}')
    .onWrite((change, context) => {
      // Get an object with the current document value.
      // If the document does not exist, it has been deleted.
      const document = change.after.exists ? change.after.data() : null;

      // Get an object with the previous document value (for update or delete)
      const oldDocument = change.before.data();

      // perform desired operations ...
    });
index.js

การอ่านและการเขียนข้อมูล

เมื่อฟังก์ชันถูกทริกเกอร์ ฟังก์ชันจะแสดงสแน็ปช็อตของข้อมูลที่เกี่ยวข้องกับเหตุการณ์ คุณสามารถใช้สแนปชอตนี้เพื่ออ่านหรือเขียนลงในเอกสารที่ทำให้เกิดเหตุการณ์ หรือใช้ Firebase Admin SDK เพื่อเข้าถึงส่วนอื่นๆ ของฐานข้อมูลของคุณ

ข้อมูลเหตุการณ์

การอ่านข้อมูล

เมื่อฟังก์ชันถูกทริกเกอร์ คุณอาจต้องการรับข้อมูลจากเอกสารที่อัปเดต หรือรับข้อมูลก่อนอัปเดต คุณสามารถรับข้อมูลก่อนหน้าได้โดยใช้ change.before.data() ซึ่งมีสแน็ปช็อตเอกสารก่อนการอัปเดต ในทำนองเดียวกัน change.after.data() มีสถานะสแน็ปช็อตเอกสารหลังจากการอัพเดต

exports.updateUser2 = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the current document
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();
    });
index.js

คุณสามารถเข้าถึงคุณสมบัติได้เช่นเดียวกับที่คุณทำในออบเจ็กต์อื่น หรือคุณสามารถใช้ฟังก์ชัน get เพื่อเข้าถึงฟิลด์เฉพาะได้:

// Fetch data using standard accessors
const age = snap.data().age;
const name = snap.data()['name'];

// Fetch data using built in accessor
const experience = snap.get('experience');
index.js

การเขียนข้อมูล

การเรียกใช้ฟังก์ชันแต่ละรายการเชื่อมโยงกับเอกสารเฉพาะในฐานข้อมูล Cloud Firestore ของคุณ คุณสามารถเข้าถึงเอกสารนั้นเป็น DocumentReference ได้ในคุณสมบัติ ref ของสแน็ปช็อตที่ส่งคืนไปยังฟังก์ชันของคุณ

DocumentReference นี้มาจาก Cloud Firestore Node.js SDK และมีวิธีการต่างๆ เช่น update() , set() และ remove() เพื่อให้คุณสามารถแก้ไขเอกสารที่เรียกใช้ฟังก์ชันนี้ได้อย่างง่ายดาย

// Listen for updates to any `user` document.
exports.countNameChanges = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Retrieve the current and previous value
      const data = change.after.data();
      const previousData = change.before.data();

      // We'll only update if the name has changed.
      // This is crucial to prevent infinite loops.
      if (data.name == previousData.name) {
        return null;
      }

      // Retrieve the current count of name changes
      let count = data.name_change_count;
      if (!count) {
        count = 0;
      }

      // Then return a promise of a set operation to update the count
      return change.after.ref.set({
        name_change_count: count + 1
      }, {merge: true});
    });
index.js

ข้อมูลนอกเหตุการณ์ทริกเกอร์

ฟังก์ชันคลาวด์ดำเนินการในสภาพแวดล้อมที่เชื่อถือได้ ซึ่งหมายความว่าฟังก์ชันดังกล่าวได้รับอนุญาตเป็นบัญชีบริการในโปรเจ็กต์ของคุณ คุณสามารถอ่านและเขียนได้โดยใช้ Firebase Admin SDK :

const admin = require('firebase-admin');
admin.initializeApp();

const db = admin.firestore();

exports.writeToFirestore = functions.firestore
  .document('some/doc')
  .onWrite((change, context) => {
    db.doc('some/otherdoc').set({ ... });
  });

ข้อจำกัด

สังเกตข้อจำกัดต่อไปนี้สำหรับทริกเกอร์ Cloud Firestore สำหรับฟังก์ชันคลาวด์:

• ไม่รับประกันการสั่งซื้อ การเปลี่ยนแปลงอย่างรวดเร็วสามารถทริกเกอร์การเรียกใช้ฟังก์ชันในลำดับที่ไม่คาดคิดได้
• มีการจัดกิจกรรมอย่างน้อยหนึ่งครั้ง แต่เหตุการณ์เดียวอาจส่งผลให้เกิดการเรียกใช้ฟังก์ชันหลายรายการ หลีกเลี่ยงการขึ้นอยู่กับกลไกเพียงครั้งเดียว และเขียน ฟังก์ชัน idempotent
• Cloud Firestore ในโหมด Datastore ต้องใช้ฟังก์ชันคลาวด์ (รุ่นที่ 2) ฟังก์ชันคลาวด์ (รุ่นที่ 1) ไม่รองรับโหมด Datastore