ทริกเกอร์ Cloud Firestore

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

ในวงจรทั่วไป ฟังก์ชัน Cloud Firestore ทำสิ่งต่อไปนี้

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

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

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

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

หากยังไม่ได้เปิดใช้โปรเจ็กต์สำหรับ Cloud Functions for Firebase โปรดอ่านเริ่มต้นใช้งาน: เขียนและติดตั้งใช้งานฟังก์ชันแรกเพื่อกำหนดค่าและตั้งค่าโปรเจ็กต์ Cloud Functions for 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

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

Cloud Functions จะทำงานในสภาพแวดล้อมที่เชื่อถือได้ ซึ่งหมายความว่าได้รับสิทธิ์ในฐานะบัญชีบริการในโปรเจ็กต์ของคุณ คุณอ่านและเขียนโดยใช้ 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 สำหรับ Cloud Functions

• ไม่รับประกันการสั่งซื้อ การเปลี่ยนแปลงอย่างรวดเร็วจะทริกเกอร์การเรียกใช้ฟังก์ชันตามลำดับที่ไม่คาดคิดได้
• และมีการส่งเหตุการณ์อย่างน้อย 1 ครั้ง แต่เหตุการณ์เดียวอาจทำให้เกิดการเรียกใช้ฟังก์ชันหลายรายการ หลีกเลี่ยงการขึ้นอยู่กับกลไกที่เกิดขึ้นเพียงครั้งเดียว ให้เขียนฟังก์ชันid
• Cloud Firestore ในโหมด Datastore ต้องใช้ Cloud Functions (รุ่นที่ 2) Cloud Functions (รุ่นที่ 1) ไม่รองรับโหมด Datastore
• Cloud Functions (รุ่นที่ 1) จะใช้ได้กับฐานข้อมูล "(ค่าเริ่มต้น)" เท่านั้นและไม่รองรับฐานข้อมูลที่มีชื่อใน Cloud Firestore โปรดใช้ Cloud Functions (รุ่นที่ 2) เพื่อกำหนดค่าเหตุการณ์สำหรับฐานข้อมูลที่มีชื่อ
• ทริกเกอร์เชื่อมโยงกับฐานข้อมูลเดียว คุณสร้างทริกเกอร์ที่ตรงกับฐานข้อมูลหลายแห่งไม่ได้
• การลบฐานข้อมูลจะไม่ลบทริกเกอร์ใดๆ สำหรับฐานข้อมูลนั้นโดยอัตโนมัติ ทริกเกอร์จะหยุดแสดงเหตุการณ์และยังคงมีอยู่จนกว่าคุณจะลบทริกเกอร์
• หากเหตุการณ์ที่ตรงกันเกินขนาดคําขอสูงสุด ระบบอาจไม่นําส่งเหตุการณ์ไปยัง Cloud Functions (รุ่นที่ 1)
  • เหตุการณ์ที่ไม่ได้ส่งเนื่องจากขนาดคำขอจะได้รับการบันทึกไว้ในบันทึกแพลตฟอร์มและนับรวมกับการใช้บันทึกสำหรับโครงการ
  • คุณสามารถค้นหาบันทึกเหล่านี้ได้ในเครื่องมือสำรวจบันทึกที่มีข้อความ "เหตุการณ์ไม่สามารถส่งไปยังฟังก์ชันระบบคลาวด์เนื่องจากมีขนาดเกินขีดจำกัดสำหรับรุ่นที่ 1..." ของความรุนแรงerror ชื่อฟังก์ชันจะอยู่ในช่อง functionName หากช่อง receiveTimestamp ยังคงอยู่ภายใน 1 ชั่วโมงจากนี้ คุณจะอนุมานเนื้อหาเหตุการณ์จริงได้โดยอ่านเอกสารที่เป็นปัญหาพร้อมสแนปชอตก่อนและหลังการประทับเวลา
  • หากต้องการหลีกเลี่ยงความถี่ดังกล่าว ให้ทําดังนี้
    • ย้ายข้อมูลและอัปเกรดเป็น Cloud Functions (รุ่นที่ 2)
    • ลดขนาดเอกสาร
    • ลบ Cloud Functions ที่เป็นปัญหา
  • คุณปิดการบันทึกได้โดยใช้การยกเว้น แต่โปรดทราบว่าระบบจะไม่ส่งเหตุการณ์ที่ไม่เหมาะสมต่อไป