ทริกเกอร์ 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

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