Cloud Functions ile Cloud Firestore'un Kapsamını Genişletme

Cloud Functions sayesinde, Cloud Firestore veritabanınızdaki değişikliklerin tetiklediği etkinlikleri işlemek için Node.js kodunu dağıtabilirsiniz. Bu, kendi sunucularınızı çalıştırmadan uygulamanıza kolayca sunucu tarafı işlevleri eklemenize olanak tanır.

Kullanım alanlarına ilişkin örnekler için Cloud Functions ile Ne Yapabilirim? başlıklı makaleyi inceleyin. veya Functions Samples GitHub deposunu kullanabilirsiniz.

Cloud Firestore işlev tetikleyicisi

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

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:

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

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

Belge yolları belirli bir dokümana veya 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 etkinlik tetiklemek istiyorsanız 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 belge grubuna (ör. belirli bir koleksiyondaki herhangi bir belge) tetikleyici eklemek istiyorsanız belge kimliği yerine {wildcard} kullanın:

// 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 kapsamındaki herhangi bir dokümandaki 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 belge yolundan ayıklanır ve context.params içinde depolanır. Açık koleksiyon veya doküman kimliklerinin yerine istediğiniz kadar joker karakter tanımlayabilirsiniz. Ö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

Bir koleksiyonda yeni bir doküman oluşturulduğunda joker karakter içeren bir onCreate() işleyici kullanarak bir işlevi tetikleyebilirsiniz. Ş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

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, bir kullanıcı profilini değiştirirse updateUser öğesini çağırır:

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

Joker karakter ile onDelete() işlevini kullanarak bir doküman silindiğinde de bir işlevi tetikleyebilirsiniz. Şu örnek işlev, bir kullanıcı, kullanıcı profilini sildiğinde 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üyle sizin için önemli değilse bir joker karakter ile onWrite() işlevini kullanarak Cloud Firestore dokümanındaki 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:

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 belgeden veri okumak veya dokümana yazmak için bu anlık görüntüyü 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 belgeden veri almak veya güncelleme öncesinde verileri 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 belge anlık görüntü durumunu içerir.

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 de kullanabilirsiniz:

// 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 dokümanla ilişkilendirilir. Bu dokümana, 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'sından gelir ve update(), set() ve remove() gibi yöntemler içerir. Böylece işlevi tetikleyen dokümanı kolayca değiştirebilirsiniz.

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

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ı veya Veri Deposu modu desteklenmez. Bu tür durumlarda etkinlikleri yapılandırmak için lütfen Cloud Functions (2. nesil) hizmetini kullanın.
• Sipariş verme garantisi verilmez. Hızlı değişiklikler, işlev çağrılarını beklenmedik bir sırada tetikleyebilir.
• Etkinlikler en az bir kez teslim edilir 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 ihtiyatlı işlevler yazın.
• Datastore modunda Cloud Firestore için Cloud Functions (2. nesil) gerekir. Cloud Functions (1. nesil) Datastore modunu desteklemiyor.
• Tetikleyiciler tek bir veritabanıyla ilişkilendirilir. Birden fazla 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. Tetikleyici, etkinlikleri yayınlamayı durdurur ancak siz tetikleyici silene kadar var olmaya devam eder.
• Eşleşen bir etkinlik maksimum istek boyutunu aşarsa bu etkinlik Cloud Functions'e (1. nesil) teslim edilmeyebilir.
  • İ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 "Boyut, error önem derecesi olan 1. nesil için sınırı aştığı için etkinlik, Cloud Functions işlevine teslim edilemiyor..." mesajıyla 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 sıklığı önlemek için şunları yapabilirsiniz:
    • Taşıma ve Cloud Functions (2. nesil) cihaza yükseltme
    • Dokümanın boyutunu küçültme
    • Söz konusu Cloud Functions silinsin
  • Hariç tutma özelliğini kullanarak günlüğe kaydetme işlemini kapatabilirsiniz ancak rahatsız edici etkinliklerin yine de teslim edilmeyeceğini unutmayın.