Cloud Firestore tetikleyicileri

Cloud Functions ile etkinlikleri İ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 yerine getirir.
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 etkinlikleri için veri nesnesi, önceki veri durumunu temsil eden iki anlık görüntü içerir ve tetikleyici etkinlikten sonra gösterilir.

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

Cloud Firestore işlev tetikleyicileri

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

Henüz Firebase için Cloud Functions için etkinleştirilmiş bir projeniz yoksa Başlarken: İlk İşlevlerinizi Yazma ve Dağıtma Firebase için Cloud Functions projenizi yapılandırıp ayarlayın.

Cloud Firestore tarafından tetiklenen işlevler yazma

İşlev tetikleyicisi tanımlayın

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

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 etkinlik tetiklemek isterseniz: aşağıdaki işlevi kullanabilirsiniz.

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

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

// 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 alanındaki herhangi bir dokümanda yer alan herhangi bir alan değiştirildiğinde userId adlı bir joker karakter.

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:

// 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 doküman oluşturulduğunda bir işlevi tetikle

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:

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

Doküman güncellendiğinde bir işlevi tetikleyin

Ayrıca, Joker karakter içeren onUpdate() işlevi. Bu örnek işlev, bir kullanıcıupdateUser profilini değiştirir:

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 de bir işlevi tetiklemek için Joker karakter içeren onDelete() işlevi. Bu örnek işlevi, kullanıcı, kullanıcı profilini silerse deleteUser öğesini çağırır:

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

Dokümanda yapılan tüm değişikliklerde bir işlevi tetikleme

Tetiklenen etkinliğin türü sizin için önemli değilse tüm etkinlikleri dinleyebilirsiniz onWrite() işlevi kullanılarak Cloud Firestore dokümanında yapılan değişiklikler joker karakter kullanarak. Bu örnek işlevde modifyUser çağrısı Kullanıcı oluşturulduğunda, güncellendiğinde veya silindiğinde:

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 fonksiyon tetiklendiğinde, düzgün çalışan bir dokümandan veya güncellemeden önce verileri alın. Ö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.

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ülklere, diğer herhangi bir nesnede olduğu gibi erişebilirsiniz. Alternatif olarak belirli alanlara erişmek için get işlevini kullanabilir:

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

// 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 etkinliğin dışındaki veriler

Cloud Functions, güvenilir bir ortamda yürütülür. Yani şu anda bir hizmet hesabı olarak yetkilendirilmelidir. Okuma ve yazma işlemleri gerçekleştirebilirsiniz Firebase Admin SDK'sını kullanarak:

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ırlamaları göz önünde bulundurun:

• Cloud Functions (1. nesil) için mevcut bir "(varsayılan)" ön koşulu bulunur veritabanını Firestore yerel modunda kullanır. İçermiyor: Cloud Firestore adlı veritabanlarını veya Datastore modunu desteklemelidir. 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 teslim edilir ancak tek bir etkinlik sonucunda birden çok işlev çağrısında bulunur. Ş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 Cloud Functions (2. nesil) gerektirir. Cloud Functions (1. nesil) Datastore modunu desteklemeli.
• Tetikleyici, tek bir veritabanıyla ilişkilendirilir. Birden çok veritabanıyla eşleşen bir tetikleyici oluşturamazsınız.
• Veritabanının silinmesi, o veritabanına ait tetikleyicilerin otomatik olarak silinmesine neden olmaz. İlgili içeriği oluşturmak için kullanılan tetikleyici etkinlikleri yayınlamayı durdurur ancak siz tetikleyici silene kadar var olmaya devam eder.
• Eşleşen bir etkinlik maksimum istek boyutunu aşarsa etkinliği Cloud Functions'a (1. nesil) teslim edilemeyebilir.
  • İstek boyutu nedeniyle yayınlanmayan etkinlikler platform günlüklerine kaydedilir ve projenin günlük kullanımına dahil edilir.
  • Bu günlükleri, Günlük Gezgini'nde "Etkinlik hedefine teslim edilemiyor" mesajıyla bulabilirsiniz 1. nesil sınırı aşması nedeniyle bulut işlevi..." / error önem derecesi. İş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 sıklığı önlemek için şunları yapabilirsiniz:
    • Cloud Functions'ı (2. nesil) taşıyın ve yükseltin
    • Dokümanın boyutunu küçült
    • İlgili Cloud Functions işlevlerini silin
  • Hariç tutma özelliğini kullanarak günlük kaydını kapatabilirsiniz. ancak rahatsız edici etkinliklerin yine de teslim edilmeyeceğini unutmayın.