Cloud Firestore tetikleyicileri


Cloud Functions ile etkinlikleri şurada düzenleyebilirsiniz: İstemci kodunun güncellenmesine gerek kalmadan Cloud Firestore. Cloud Firestore'da değişiklik yapmak için şu dosyayı kullanabilirsiniz: arayüzü üzerinden veya Yönetici SDK'si.

Cloud Firestore işlevi, tipik bir yaşam döngüsünde şunları yapar:

  1. Belirli bir dokümanda değişiklik yapılmasını bekler.
  2. Bir etkinlik gerçekleştiğinde tetiklenir ve görevlerini gerçekleştirir.
  3. Depolanan verilerin anlık görüntüsünü içeren bir veri nesnesi alır belirtilen dokümanda olması gerekir. Yazma veya güncelleme etkinliklerinde veri nesnesi, tetikleyici etkinlikten önceki ve sonraki veri durumunu temsil eden iki anlık görüntü içerir.

Firestore örneğinin konumu ile konum arasındaki mesafe çok önemli bir ağ gecikmesine neden olabilir. Performansı optimize etmek için geçerli olduğu durumlarda işlev konumunu belirtebilirsiniz.

Cloud Firestore işlev tetikleyicileri

Cloud Functions for Firebase SDK, belirli Cloud Firestore etkinliklerine bağlı işleyiciler oluşturmanıza olanak tanıyan bir functions.firestore nesnesi dışa aktarır.

Etkinlik Türü Tetikleyici
onCreate Bir dokümana ilk kez yazıldığı zaman tetiklenir.
onUpdate Zaten bir doküman varsa ve herhangi bir değeri değiştirildiğinde tetiklenir.
onDelete Veri içeren bir doküman silindiğinde tetiklenir.
onWrite onCreate, onUpdate veya onDelete tetiklendiğinde tetiklenir.

Henüz Cloud Functions for Firebase için etkinleştirilmiş bir projeniz yoksa Cloud Functions for Firebase projenizi yapılandırmak ve ayarlamak için Başlayın: İlk İşlevlerinizi Yazma ve Yayınlama başlıklı makaleyi okuyun.

Cloud Firestore tarafından tetiklenen işlevler yazma

İşlev tetikleyicisi tanımlama

Bir Cloud Firestore tetikleyicisi tanımlamak için belge yolu ve etkinlik türü belirtin:

Node.js

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

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

Belge yolları, belirli bir dokümana başvurabilir veya joker karakter kalıbı kullanabilirsiniz.

Tek bir doküman belirtin

Belirli bir dokümanda herhangi bir değişiklik için bir etkinlik tetiklemek istiyorsanız aşağıdaki işlevi kullanabilirsiniz.

Node.js

// 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

Joker karakter kullanarak bir doküman grubu belirtme

Bir doküman grubuna tetikleyici eklemek istiyorsanız, yerine bir {wildcard} kullanın belge kimliği:

Node.js

// 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

Bu örnekte, users içindeki herhangi bir dokümanda herhangi bir alan değiştirildiğinde userId adlı bir joker karakterle eşleşir.

users alan adındaki bir dokümanda alt koleksiyonlar varsa ve bu alt koleksiyonlardan birinde bir alan doküman değiştirildiğinde, userId joker karakteri tetiklenmez.

Joker karakter eşleşmeleri belge yolundan ayıklanır ve context.params içinde depolanır. Uygunsuz toplama işlemi yerine istediğiniz kadar joker karakter tanımlayabilirsiniz veya doküman kimlikleri, örneğin:

Node.js

// 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

Etkinlik Tetikleyicileri

Yeni bir doküman oluşturulduğunda bir işlevi tetikleme

Koleksiyonda yeni bir doküman oluşturulduğunda bir işlevi tetikleyebilirsiniz. joker karakter içeren bir onCreate() işleyici kullanarak. Şu örnek işlev, eklenen her yeni kullanıcı profili için createUser yöntemini çağırır:

Node.js

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

Bir doküman güncellendiğinde işlevi tetikleme

Joker karakter içeren onUpdate() işlevini kullanarak bir doküman güncellendiğinde tetiklenecek bir işlev de başlatabilirsiniz. Bu örnek işlev, kullanıcı profilini değiştirirse updateUser işlevini çağırır:

Node.js

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

Doküman silindiğinde bir işlevi tetikle

Bir doküman silindiğinde onDelete() işlevini joker karakter ile kullanarak da bir işlevi tetikleyebilirsiniz. Bu örnek işlevi, kullanıcı, kullanıcı profilini silerse deleteUser öğesini çağırır:

Node.js

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

Bir dokümanda yapılan tüm değişiklikler için bir işlevi tetikleme

Tetiklenen etkinliğin türü sizin için önemli değilse joker karakter ile onWrite() işlevini kullanarak bir Cloud Firestore belgesindeki tüm değişiklikleri dinleyebilirsiniz. Bu örnek işlev, kullanıcı oluşturulduğunda, güncellendiğinde veya silindiğinde modifyUser işlevini çağırır:

Node.js

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

Verileri Okuma ve Yazma

Bir işlev tetiklendiğinde, her bir işlevle alakalı verilerin bir unutmayın. Bu anlık görüntüyü, yazınızı okumak veya dokümana yazmak için kullanabilirsiniz etkinliği tetikleyebilir veya Firebase Admin SDK'sını kullanarak diğer bölümlere erişebilir yeniden değerlendirmenizi sağlar.

Etkinlik Verileri

Verileri Okuma

Bir işlev tetiklendiğinde, güncellenen bir dokümandan veri almak veya verileri güncellemeden önce almak isteyebilirsiniz. Önceki verileri almak için change.before.data(), güncellemeden önceki dokümanın anlık görüntüsünü içerir. Benzer şekilde, change.after.data() etiketinden sonraki güncelleyin.

Node.js

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

Mülke diğer nesnelerde olduğu gibi erişebilirsiniz. Alternatif olarak, belirli alanlara erişmek için get işlevini kullanabilirsiniz:

Node.js

// 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

Veri Yazma

Her işlev çağrısı, Cloud Firestore veritabanınızdaki belirli bir belgeyle ilişkilendirilir. Bu dokümana bir Anlık görüntünün ref özelliğindeki DocumentReference değeri, işlevinize döndürüldü.

Bu DocumentReference şuradan geliyor: Cloud Firestore Node.js SDK'sı ve update(), set() ve remove() gibi yöntemleri içerir. Böylece bunları kolayca işlevi tetikleyen dokümanı değiştirebilir.

Node.js

// 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

Tetikleyici etkinlik dışındaki veriler

Cloud Functions güvenilir bir ortamda çalıştırılmalıdır. Yani projenizde hizmet hesabı olarak yetkilendirilmiş olmalıdır. Okuma ve yazma işlemleri gerçekleştirebilirsiniz Firebase Admin SDK'sını kullanarak:

Node.js

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({ ... });
  });

Sınırlamalar

Cloud Functions için Cloud Firestore tetikleyicileriyle ilgili aşağıdaki sınırlamalara dikkat edin:

  • Cloud Functions (1. nesil) için mevcut bir "(varsayılan)" ön koşulu var veritabanını Firestore yerel modunda kullanır. Cloud Firestore adlı veritabanlarını veya Veri Deposu modunu desteklemez. Lütfen Cloud Functions kullanın (2. nesil) teknolojisinden yararlanabilirsiniz.
  • Sipariş verme garantisi verilmez. Hızlı değişiklikler beklenmedik bir durum var.
  • Etkinlikler en az bir kez yayınlanır ancak tek bir etkinlik birden fazla işlev çağrısına neden olabilir. Şuna bağlı olarak kullanmaktan kaçının: bilgisayar korsanlığı içeren bir oyun ihtiyatlı işlevler hakkında daha fazla bilgi edinin.
  • Datastore modunda Cloud Firestore için Cloud Functions (2. nesil) gerekir. Cloud Functions (1. nesil), Datastore modunu desteklemez.
  • Tetikleyici, tek bir veritabanıyla ilişkilendirilir. Birden fazla veritabanıyla eşleşen bir tetikleyici oluşturamazsınız.
  • Bir veritabanı silindiğinde, ilgili veritabanı için tüm tetikleyiciler otomatik olarak silinmez. Tetikleyici, etkinlik yayınlamayı durdurur ancak silnene kadar varlığını sürdürür.
  • Eşleşen bir etkinlik maksimum istek boyutunu aşarsa etkinlik Cloud Functions (1. nesil) hedefine teslim edilemeyebilir.
    • İstek boyutu nedeniyle yayınlanmayan etkinlikler platform günlüklerine kaydedilir ve projenin günlük kullanımı için sayılır.
    • Bu günlükleri Günlük Gezgini'nde, error önem derecesine sahip "1. nesil için boyut sınırını aştığından etkinlik Cloud işlevine gönderilemiyor..." mesajıyla bulabilirsiniz. İşlev adını functionName alanının altında bulabilirsiniz. Eğer receiveTimestamp alanına şu andan itibaren bir saat daha var: söz konusu dokümanı bir sorguyla okuyarak gerçek etkinlik içeriğini ve zaman damgasından önceki ve sonraki anlık görüntülere yer verir.
    • Bu tür bir ritim oluşturmamak için:
      • Cloud Functions (2. nesil) sürümüne taşıyın ve yükseltin
      • Dokümanın boyutunu küçült
      • Söz konusu Cloud Functions'yi silin
    • Hariç tutma özelliğini kullanarak günlük kaydını kapatabilirsiniz. ancak rahatsız edici etkinliklerin yine de teslim edilmeyeceğini unutmayın.