Cloud Firestore tetikleyicileri


Cloud Functions ile, istemci kodunu güncellemenize gerek kalmadan Cloud Firestore'daki etkinlikleri yönetebilirsiniz. Cloud Firestore değişikliklerini doküman anlık görüntüsü arayüzü veya Admin SDK üzerinden yapabilirsiniz.

Cloud Firestore işlevleri, tipik bir yaşam döngüsünde aşağıdakileri 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. Belirtilen dokümanda depolanan verilerin anlık görüntüsünü içeren bir veri nesnesi alır. 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 işlevin konumu arasındaki mesafe önemli ölçüde ağ gecikmesi oluşturabilir. 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 objesi dışa aktarır.

Etkinlik Türü Tetikleyici
onCreate Bir dokümana ilk kez yazıldığı zaman tetiklenir.
onUpdate Halihazırda mevcut olan bir dokümanda herhangi bir değer 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

Cloud Firestore tetikleyicisi tanımlamak için bir doküman yolu ve etkinlik türü belirtin:

Node.js

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

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

Doküman yolları, belirli bir dokümana veya joker karakter kalıbına referans verebilir.

Tek bir doküman belirtme

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

Belirli bir koleksiyondaki herhangi bir doküman gibi bir doküman grubuna tetikleyici eklemek istiyorsanız belge kimliği yerine {wildcard} kullanın:

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 içindeki bir dokümanın alt koleksiyonları varsa ve bu alt koleksiyonlardaki dokümanlardan birinde bir alan değiştirilirse userId joker karakteri tetiklenmez.

Joker karakter eşleşmeleri, doküman yolundan ayıklanır ve context.params içine depolanır. Belirli koleksiyon veya belge kimliklerini değiştirmek için istediğiniz kadar joker karakter tanımlayabilirsiniz. Ö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

Joker karakter içeren bir onCreate() işleyicisi kullanarak bir koleksiyonda her yeni doküman oluşturulduğunda tetiklenecek bir işlev oluşturabilirsiniz. Bu örnek işlev, her yeni kullanıcı profili eklendiğinde createUser işlevini ç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

onUpdate() işlevini joker karakter ile 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

Bir doküman silindiğinde işlev tetikleme

Bir doküman silindiğinde onDelete() işlevini joker karakter ile kullanarak da bir işlevi tetikleyebilirsiniz. Bu örnek işlev, kullanıcı kullanıcı profilini sildiğinde deleteUser işlevini ç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 içeren 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, etkinlikle ilgili verilerin anlık görüntüsünü sağlar. Etkinliği tetikleyen dokümanı okumak veya bu dokümana yazmak için bu anlık görüntüyü kullanabilir ya da veritabanınızın diğer bölümlerine erişmek için Firebase Admin SDK'sını kullanabilirsiniz.

Etkinlik Verileri

Verileri Okuma

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

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, işlevinize döndürülen anlık görüntünün ref mülkünde DocumentReference olarak erişebilirsiniz.

Bu DocumentReference, Cloud Firestore Node.js SDK'sından gelir ve işlevi tetikleyen dokümanı kolayca değiştirebilmeniz için update(), set() ve remove() gibi yöntemler içerir.

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. Firebase Admin SDK'sını kullanarak okuma ve yazma işlemleri yapabilirsiniz:

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 Firestore yerel modunda mevcut bir "(varsayılan)" veritabanı gereklidir. Cloud Firestore adlı veritabanlarını veya Veri Deposu modunu desteklemez. Bu tür durumlarda etkinlikleri yapılandırmak için lütfen Cloud Functions (2. nesil) kullanın.
  • Sıralama garanti edilmez. Hızlı değişiklikler, işlev çağrılarını beklenmedik bir sırada tetikleyebilir.
  • Etkinlikler en az bir kez yayınlanır ancak tek bir etkinlik birden fazla işlev çağrısına neden olabilir. Tam olarak bir kez mekanizmalarına bağlı olmaktan kaçının ve idempotent işlevler yazın.
  • Datastore modunda Cloud Firestore için Cloud Functions (2. nesil) gerekir. Cloud Functions (1. nesil), Datastore modunu desteklemez.
  • Tetikleyiciler 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ı korur.
  • Eşleşen bir etkinlik maksimum istek boyutunu aşarsa etkinlik Cloud Functions'e (1. nesil) yayınlanmayabilir.
    • İ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 birlikte bulabilirsiniz. İşlev adını functionName alanının altında bulabilirsiniz. receiveTimestamp alanı şu andan itibaren bir saat içindeyse söz konusu dokümanı, zaman damgasından önce ve sonra alınan bir anlık görüntüyle okuyarak gerçek etkinlik içeriğini anlayabilirsiniz.
    • Bu tür bir ritim oluşturmamak için:
      • Taşıma ve Cloud Functions (2. nesil) cihaza yükseltme
      • Dokümanın boyutunu küçültme
      • Söz konusu Cloud Functions'yi silin
    • Hariç tutmalar'ı kullanarak günlük kaydını devre dışı bırakabilirsiniz ancak rahatsız edici etkinliklerin yine de yayınlanmayacağını unutmayın.