Cloud Functions sayesinde, tetiklenen etkinlikleri işlemek için Node.js kodunu dağıtabilirsiniz Cloud Firestore veritabanınızdaki değişikliklere göre. Bu sayede, kendi sunucularınızı çalıştırmadan uygulamanıza sunucu tarafı işlevleri kolayca ekleyebilirsiniz.
Kullanım alanı örnekleri için Aşağıdakilerle Ne Yapabilirim?: Cloud Functions? veya Functions Samples GitHub deposu.
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.
Etkinlik Türü | Tetikleyici |
---|---|
onCreate |
Bir doküman ilk kez yazıldığında tetiklenir. |
onUpdate |
Halihazırda mevcut 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 fonksiyonları yazma
İşlev tetikleyicisi tanımlayın
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) => { /* ... */ });
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.
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 });
Joker karakter kullanarak bir doküman grubu belirtin
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"} });
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 belge yolundan ayıklanır ve context.params
içinde 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"} });
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:
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 ... });
Doküman güncellendiğinde bir işlevi tetikleyin
onUpdate()
işlevini joker karakter ile kullanarak bir doküman güncellendiğinde tetiklenecek bir işlev de başlatabilirsiniz. Bu örnek işlevde, updateUser
bir kullanıcı
profilini değiştirir:
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 ... });
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:
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 ... });
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
bir Cloud Firestore dokümanındaki onWrite()
işlevi kullanılarak 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:
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 ... });
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(); });
Mülklere, diğer herhangi bir nesnede olduğu gibi erişebilirsiniz. Alternatif olarak
belirli alanlara erişmek için get
işlevini kullanabilir:
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');
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 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}); });
Tetikleyici etkinliğin 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 tetikleyicilerine yönelik aşağıdaki sınırlamaları göz önünde bulundurun:
- Cloud Functions (1. nesil) için mevcut bir "(varsayılan)" ön koşulu var veritabanını Firestore yerel modunda kullanır. İçermiyor: Cloud Firestore adlandırılmış veritabanlarını veya Datastore modunu destekler. Bu tür durumlarda etkinlikleri yapılandırmak için lütfen Cloud Functions (2. nesil) kullanın.
- 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) CANNOT TRANSLATE 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
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ı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ğerreceiveTimestamp
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) sürümüne taşıyın ve yükseltin
- Dokümanın boyutunu küçült
- Söz konusu Cloud Functions silinsin
- Hariç tutmalar'ı kullanarak günlük kaydını kapatabilirsiniz ancak rahatsız edici etkinliklerin yine de yayınlanmayacağını unutmayın.