Cloud Firestore tetikleyicileri


Cloud Functions ile istemci kodunu güncellemenize gerek kalmadan Cloud Firestore'daki etkinlikleri yönetebilirsiniz. Cloud Firestore değişikliklerinizi belge anlık görüntü arayüzü veya Admin SDK aracılığıyla yapabilirsiniz.

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

  1. Belirli bir dokümanda değişiklik yapılmasını bekler.
  2. Bir etkinlik meydana geldiğinde ve etkinliklerini gerçekleştirdiğinde tetiklenir.
  3. Belirtilen belgede depolanan verilerin anlık görüntüsünü içeren bir veri nesnesi alır. Yazma veya güncelleme etkinlikleri için veri nesnesi, tetikleme etkinliğinden ö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ğ gecikmesine neden olabilir. Performansı optimize etmek için uygun olduğu durumlarda işlev konumunu belirtin.

Cloud Firestore işlev tetikleyicileri

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

Etkinlik Türü Tetikleyici
onCreate Bir doküman kendisine ilk kez yazıldığında tetiklenir.
onUpdate Bir doküman zaten mevcut olduğunda 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ştirilen bir projeniz yoksa Cloud Functions for Firebase projenizi yapılandırmak ve ayarlamak için Başlayın: İlk İşlevlerinizi Yazma ve Dağıtma başlıklı makaleyi okuyun.

Cloud Firestore tarafından tetiklenen işlevler yazma

İşlev tetikleyicisi tanımlama

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 belgeye veya bir joker karakter kalıbına başvurabilir.

Tek bir doküman belirtin

Belirli bir dokümanda yapılan herhangi bir değişiklik için bir etkinliği 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 karakterler kullanarak bir doküman grubu belirtme

Belirli bir koleksiyondaki herhangi bir belge gibi bir belge grubuna tetikleyici eklemek istiyorsanız doküman 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çinde herhangi bir dokümanda yapılan herhangi bir alan değiştirildiğinde userId adlı joker karakterle eşleşir.

users içindeki bir dokümanın alt koleksiyonları varsa ve bu alt koleksiyonların dokümanlarından birindeki bir alan değiştirilirse userId joker karakteri tetiklenmez.

Joker karakter eşleşmeleri belge yolundan ayıklanır ve context.params klasörüne depolanır. Açık 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

Bir koleksiyonda her yeni belge oluşturulduğunda etkinleşmesi için joker karakter içeren bir onCreate() işleyici kullanabilirsiniz. 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 bir işlevi tetikleme

Ayrıca onUpdate() işlevini bir joker karakter ile kullanarak bir doküman güncellendiğinde etkinleşecek bir işlevi de tetikleyebilirsiniz. Bu örnek işlev, bir 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şlevi tetikleme

Bir doküman silindiğinde joker karakter ile onDelete() işlevini kullanarak da bir işlevi tetikleyebilirsiniz. Bu örnek işlev, bir 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

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 onWrite() işlevini bir joker karakter ile kullanarak Cloud Firestore belgesindeki tüm değişiklikleri dinleyebilirsiniz. Bu örnek işlev, bir kullanıcı oluşturulursa, güncellenirse veya silinirse modifyUser öğesini ç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 belgeyi okumak veya 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'yı kullanabilirsiniz.

Etkinlik Verileri

Verileri Okuma

Bir işlev tetiklendiğinde, güncellenmiş bir belgedeki verileri almak veya verileri güncellenmeden önce almak isteyebilirsiniz. Güncellemeden önceki belge anlık görüntüsünü içeren change.before.data() özelliğini kullanarak önceki verileri alabilirsiniz. Benzer şekilde change.after.data(), güncellemeden sonraki belge anlık görüntüsü 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

Özelliklere, diğer nesnelerde olduğu gibi erişebilirsiniz. Alternatif olarak, belirli alanlara erişmek için get işlevini de 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şkilidir. Bu belgeye, işlevinize döndürülen anlık görüntünün ref özelliğinde DocumentReference olarak erişebilirsiniz.

Bu DocumentReference, Cloud Firestore Node.js SDK'dan gelir ve update(), set() ile remove() gibi yöntemler içerir. Böylece işlevi tetikleyen belgeyi kolayca değiştirebilirsiniz.

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

Cloud Functions, güvenilir bir ortamda yürütülür. Bu, projenizde hizmet hesabı olarak yetkilendirildikleri anlamına gelir. Firebase Admin SDK'yı kullanarak okuma ve yazma işlemleri gerçekleştirebilirsiniz:

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

  • Sipariş verileceği garanti edilmez. Hızlı değişiklikler işlev çağrılarını beklenmedik bir sırayla tetikleyebilir.
  • Etkinlikler en az bir kez gönderilir ancak tek bir etkinlik birden fazla işlev çağrısına neden olabilir. Tam olarak bir kez gerçekleşen mekaniklere bağlı kalmaktan kaçının ve aktif işlevler yazın.
  • Datastore modunda Cloud Firestore için Cloud Functions (2. nesil) gerekir. Cloud Functions (1. nesil), Datastore modunu desteklemez.
  • Cloud Functions (1. nesil) yalnızca "(varsayılan)" veritabanıyla çalışır ve Cloud Firestore adlandırılmış veritabanlarını desteklemez. Adlandırılmış veritabanlarıyla ilgili etkinlikleri yapılandırmak için lütfen Cloud Functions'ı (2. nesil) kullanın.
  • Bir tetikleyici tek bir veritabanıyla ilişkilendirilir. Birden fazla veritabanıyla eşleşen bir tetikleyici oluşturamazsınız.
  • Bir veritabanı silindiğinde, söz konusu veritabanı için tetikleyiciler otomatik olarak silinmez. Tetikleyici, etkinlikleri yayınlamayı durdurur ancak siz tetikleyiciyi silene kadar etkin durumda kalır.
  • Eşleşen bir etkinlik maksimum istek boyutunu aşarsa etkinlik Cloud Functions'a (1. nesil) yayınlanmayabilir.
    • İstek boyutu nedeniyle teslim edilmeyen 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 error önem derecesine sahip "Boyut 1. nesil için sınırı aştığından Cloud Functions işlevine yayınlanamıyor..." mesajıyla bulabilirsiniz. İşlev adını functionName alanının altında bulabilirsiniz. receiveTimestamp alanı şu andan itibaren hâlâ bir saat içindeyse, zaman damgasından önceki ve sonraki bir anlık görüntüyle birlikte söz konusu dokümanı okuyarak gerçek etkinlik içeriğini tahmin edebilirsiniz.
    • Bu tür durumlarla karşılaşmamak için şunları yapabilirsiniz:
      • Cloud Functions'a (2. nesil) taşıma ve yükseltme
      • Dokümanın boyutunu küçültme
      • Söz konusu Cloud Functions'ı silin
    • Hariç tutma özelliğini kullanarak günlük kaydını devre dışı bırakabilirsiniz ancak rahatsız edici etkinliklerin yine de yayınlanmayacağını unutmayın.