Cloud Functions ile Cloud Firestore veritabanınızdaki değişikliklerin tetiklediği etkinlikleri işlemek için kod dağıtabilirsiniz. Bu sayede, kendi sunucularınızı çalıştırmadan uygulamanıza sunucu tarafı işlevleri ekleyebilirsiniz.
Cloud Functions (2. nesil)
Cloud Run ve Eventarc tarafından desteklenen Cloud Functions for Firebase (2. nesil), daha güçlü bir altyapı, performans ve ölçeklenebilirlik üzerinde gelişmiş kontrol ve işlevlerin çalışma zamanı üzerinde daha fazla kontrol sağlar. 2. nesil hakkında daha fazla bilgi için Cloud Functions for Firebase (2. nesil) başlıklı makaleyi inceleyin.
Cloud Firestore işlev tetikleyicisi
Cloud Functions for Firebase SDK'sı, belirli Cloud Firestore etkinliklerine bağlı işleyiciler oluşturmanıza olanak tanımak için aşağıdaki Cloud Firestore etkinlik tetikleyicilerini dışa aktarır:
Node.js
| Etkinlik Türü | Tetikleyici |
|---|---|
onDocumentCreated |
Bir dokümana ilk kez yazıldığında tetiklenir. |
onDocumentUpdated |
Bir doküman zaten mevcut olduğunda ve herhangi bir değeri değiştiğinde tetiklenir. |
onDocumentDeleted |
Bir doküman silindiğinde tetiklenir. |
onDocumentWritten |
onDocumentCreated, onDocumentUpdated veya onDocumentDeleted tetiklendiğinde tetiklenir. |
onDocumentCreatedWithAuthContext |
Ek kimlik doğrulama bilgileriyle onDocumentCreated |
onDocumentWrittenWithAuthContext |
Ek kimlik doğrulama bilgileriyle onDocumentWritten |
onDocumentDeletedWithAuthContext |
Ek kimlik doğrulama bilgileriyle onDocumentDeleted |
onDocumentUpdatedWithAuthContext |
Ek kimlik doğrulama bilgileriyle onDocumentUpdated |
Python
| Etkinlik Türü | Tetikleyici |
|---|---|
on_document_created |
Bir dokümana ilk kez yazıldığında tetiklenir. |
on_document_updated |
Bir doküman zaten mevcut olduğunda ve herhangi bir değeri değiştiğinde tetiklenir. |
on_document_deleted |
Bir doküman silindiğinde tetiklenir. |
on_document_written |
on_document_created, on_document_updated veya on_document_deleted tetiklendiğinde tetiklenir. |
on_document_created_with_auth_context |
Ek kimlik doğrulama bilgileriyle on_document_created |
on_document_updated_with_auth_context |
Ek kimlik doğrulama bilgileriyle on_document_updated |
on_document_deleted_with_auth_context |
Ek kimlik doğrulama bilgileriyle on_document_deleted |
on_document_written_with_auth_context |
Ek kimlik doğrulama bilgileriyle on_document_written |
Cloud Firestore etkinlikleri yalnızca doküman değişikliklerinde tetiklenir. Verilerin değişmediği bir Cloud Firestore belgesinde yapılan güncelleme (işlemsiz yazma), güncelleme veya yazma etkinliği oluşturmaz. Belirli alanlara etkinlik eklemek mümkün değildir.
Cloud Functions for Firebase için etkinleştirilmiş bir projeniz yoksa Cloud Functions for Firebase projenizi yapılandırmak ve ayarlamak için Cloud Functions for Firebase (2. nesil) kullanmaya başlama 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 {
onDocumentWritten,
onDocumentCreated,
onDocumentUpdated,
onDocumentDeleted,
Change,
FirestoreEvent
} = require('firebase-functions/v2/firestore');
exports.myfunction = onDocumentWritten("my-collection/{docId}", (event) => {
/* ... */
});
Python
from firebase_functions.firestore_fn import (
on_document_created,
on_document_deleted,
on_document_updated,
on_document_written,
Event,
Change,
DocumentSnapshot,
)
@on_document_created(document="users/{userId}")
def myfunction(event: Event[DocumentSnapshot]) -> None:
Doküman yolları, belirli bir dokümana veya joker karakter kalıbına başvurabilir.
Tek bir doküman belirtme
Belirli bir dokümandaki herhangi bir değişiklik için etkinlik tetiklemek istiyorsanız aşağıdaki işlevi kullanabilirsiniz.
Node.js
const {
onDocumentWritten,
Change,
FirestoreEvent
} = require('firebase-functions/v2/firestore');
exports.myfunction = onDocumentWritten("users/marie", (event) => {
// Your code here
});
Python
from firebase_functions.firestore_fn import (
on_document_written,
Event,
Change,
DocumentSnapshot,
)
@on_document_written(document="users/marie")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
Joker karakterleri kullanarak bir doküman grubu belirtme
Belirli bir koleksiyondaki tüm dokümanlar gibi bir doküman grubuna tetikleyici eklemek istiyorsanız doküman kimliği yerine {wildcard} kullanın:
Node.js
const {
onDocumentWritten,
Change,
FirestoreEvent
} = require('firebase-functions/v2/firestore');
exports.myfunction = onDocumentWritten("users/{userId}", (event) => {
// If we set `/users/marie` to {name: "Marie"} then
// event.params.userId == "marie"
// ... and ...
// event.data.after.data() == {name: "Marie"}
});
Python
from firebase_functions.firestore_fn import (
on_document_written,
Event,
Change,
DocumentSnapshot,
)
@on_document_written(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
# If we set `/users/marie` to {name: "Marie"} then
event.params["userId"] == "marie" # True
# ... and ...
event.data.after.to_dict() == {"name": "Marie"} # True
Bu örnekte, users içindeki herhangi bir belgede herhangi bir alan değiştirildiğinde userId adlı joker karakterle eşleşir.
Joker karakter eşleşmeleri, doküman yolundan ayıklanır ve event.params içinde depolanır.
Joker karakter kullansanız bile tetikleyiciniz her zaman bir dokümanı işaret etmelidir.
Etkinlik Tetikleyicileri
Yeni bir doküman oluşturulduğunda işlevi tetikleme
Bir koleksiyonda yeni bir doküman oluşturulduğunda tetiklenecek bir işlev oluşturabilirsiniz. Bu örnek işlev, her yeni kullanıcı profili eklendiğinde tetiklenir:
Node.js
const {
onDocumentCreated,
Change,
FirestoreEvent
} = require('firebase-functions/v2/firestore');
exports.createuser = onDocumentCreated("users/{userId}", (event) => {
// Get an object representing the document
// e.g. {'name': 'Marie', 'age': 66}
const snapshot = event.data;
if (!snapshot) {
console.log("No data associated with the event");
return;
}
const data = snapshot.data();
// access a particular field as you would any JS property
const name = data.name;
// perform more operations ...
});
Ek kimlik doğrulama bilgileri için onDocumentCreatedWithAuthContext kullanın.
Python
from firebase_functions.firestore_fn import (
on_document_created,
Event,
DocumentSnapshot,
)
@on_document_created(document="users/{userId}")
def myfunction(event: Event[DocumentSnapshot]) -> None:
# Get a dictionary representing the document
# e.g. {'name': 'Marie', 'age': 66}
new_value = event.data.to_dict()
# Access a particular field as you would any dictionary
name = new_value["name"]
# Perform more operations ...
Bir doküman güncellendiğinde işlevi tetikleme
Bir doküman güncellendiğinde tetiklenecek bir işlev de oluşturabilirsiniz. Bu örnek işlev, kullanıcı profilini değiştirdiğinde tetiklenir:
Node.js
const {
onDocumentUpdated,
Change,
FirestoreEvent
} = require('firebase-functions/v2/firestore');
exports.updateuser = onDocumentUpdated("users/{userId}", (event) => {
// Get an object representing the document
// e.g. {'name': 'Marie', 'age': 66}
const newValue = event.data.after.data();
// access a particular field as you would any JS property
const name = newValue.name;
// perform more operations ...
});
Ek kimlik doğrulama bilgileri için onDocumentUpdatedWithAuthContext kullanın.
Python
from firebase_functions.firestore_fn import (
on_document_updated,
Event,
Change,
DocumentSnapshot,
)
@on_document_updated(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
# Get a dictionary representing the document
# e.g. {'name': 'Marie', 'age': 66}
new_value = event.data.after.to_dict()
# Access a particular field as you would any dictionary
name = new_value["name"]
# Perform more operations ...
Bir doküman silindiğinde işlev tetikleme
Bir doküman silindiğinde de işlev tetikleyebilirsiniz. Bu örnek işlev, kullanıcı kendi kullanıcı profilini sildiğinde tetiklenir:
Node.js
const {
onDocumentDeleted,
Change,
FirestoreEvent
} = require('firebase-functions/v2/firestore');
exports.deleteuser = onDocumentDeleted("users/{userId}", (event) => {
// Get an object representing the document
// e.g. {'name': 'Marie', 'age': 66}
const snap = event.data;
const data = snap.data();
// perform more operations ...
});
Ek kimlik doğrulama bilgileri için onDocumentDeletedWithAuthContext kullanın.
Python
from firebase_functions.firestore_fn import (
on_document_deleted,
Event,
DocumentSnapshot,
)
@on_document_deleted(document="users/{userId}")
def myfunction(event: Event[DocumentSnapshot|None]) -> None:
# Perform more operations ...
Bir dokümandaki tüm değişiklikler için işlev tetikleme
Tetiklenen etkinliğin türü sizin için önemli değilse "belge yazıldı" etkinlik tetikleyicisini kullanarak bir Cloud Firestore belgesindeki tüm değişiklikleri dinleyebilirsiniz. Bu örnek işlev, bir kullanıcı oluşturulduğunda, güncellendiğinde veya silindiğinde tetiklenir:
Node.js
const {
onDocumentWritten,
Change,
FirestoreEvent
} = require('firebase-functions/v2/firestore');
exports.modifyuser = onDocumentWritten("users/{userId}", (event) => {
// Get an object with the current document values.
// If the document does not exist, it was deleted
const document = event.data.after.data();
// Get an object with the previous document values
const previousValues = event.data.before.data();
// perform more operations ...
});
Ek kimlik doğrulama bilgileri için onDocumentWrittenWithAuthContext kullanın.
Python
from firebase_functions.firestore_fn import (
on_document_written,
Event,
Change,
DocumentSnapshot,
)
@on_document_written(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot | None]]) -> None:
# Get an object with the current document values.
# If the document does not exist, it was deleted.
document = (event.data.after.to_dict()
if event.data.after is not None else None)
# Get an object with the previous document values.
# If the document does not exist, it was newly created.
previous_values = (event.data.before.to_dict()
if event.data.before is not None else None)
# Perform more operations ...
Veri Okuma ve Yazma
Bir işlev tetiklendiğinde, etkinlikle ilgili verilerin anlık görüntüsünü sağlar. Bu anlık görüntüyü, etkinliği tetikleyen dokümanı okumak veya dokümana yazmak için kullanabilirsiniz. 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üncellenen bir dokümandan veri almak veya güncellemeden önceki verileri almak isteyebilirsiniz. Güncellemeden önceki belge anlık görüntüsünü içeren event.data.before kullanarak önceki verileri alabilirsiniz.
Benzer şekilde, event.data.after, güncellemeden sonraki belge anlık görüntü durumunu içerir.
Node.js
exports.updateuser2 = onDocumentUpdated("users/{userId}", (event) => {
// Get an object with the current document values.
// If the document does not exist, it was deleted
const newValues = event.data.after.data();
// Get an object with the previous document values
const previousValues = event.data.before.data();
});
Python
@on_document_updated(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
# Get an object with the current document values.
new_value = event.data.after.to_dict()
# Get an object with the previous document values.
prev_value = event.data.before.to_dict()
Özelliklere 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 = event.data.after.data().age;
const name = event.data.after.data()['name'];
// Fetch data using built in accessor
const experience = event.data.after.data.get('experience');
Python
# Get the value of a single document field.
age = event.data.after.get("age")
# Convert the document to a dictionary.
age = event.data.after.to_dict()["age"]
Yazma Verileri
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üden erişebilirsiniz.
Doküman referansı, işlevi tetikleyen dokümanı değiştirebilmeniz için update(), set() ve remove() gibi yöntemler içerir.
Node.js
const {onDocumentUpdated} = require('firebase-functions/v2/firestore');
exports.countnamechanges = onDocumentUpdated('users/{userId}', (event) => {
// Retrieve the current and previous value
const data = event.data.after.data();
const previousData = event.data.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 event.data.after.ref.set({
name_change_count: count + 1
}, {merge: true});
});
Python
@on_document_updated(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
# Get the current and previous document values.
new_value = event.data.after
prev_value = event.data.before
# We'll only update if the name has changed.
# This is crucial to prevent infinite loops.
if new_value.get("name") == prev_value.get("name"):
return
# Retrieve the current count of name changes
count = new_value.to_dict().get("name_change_count", 0)
# Update the count
new_value.reference.update({"name_change_count": count + 1})
Kullanıcı kimlik doğrulama bilgilerine erişme
Aşağıdaki etkinlik türlerinden birini kullanıyorsanız etkinliği tetikleyen asıl kullanıcıyla ilgili kullanıcı kimlik doğrulama bilgilerine erişebilirsiniz. Bu bilgiler, temel etkinlikte döndürülen bilgilere ek olarak sağlanır.
Node.js
onDocumentCreatedWithAuthContextonDocumentWrittenWithAuthContextonDocumentDeletedWithAuthContextonDocumentUpdatedWithAuthContext
Python
on_document_created_with_auth_contexton_document_updated_with_auth_contexton_document_deleted_with_auth_contexton_document_written_with_auth_context
Kimlik doğrulama bağlamında kullanılabilen veriler hakkında bilgi edinmek için Kimlik Doğrulama Bağlamı başlıklı makaleyi inceleyin. Aşağıdaki örnekte, kimlik doğrulama bilgilerinin nasıl alınacağı gösterilmektedir:
Node.js
const {onDocumentWrittenWithAuthContext} = require('firebase-functions/v2/firestore');
exports.syncUser = onDocumentWrittenWithAuthContext("users/{userId}", (event) => {
const snapshot = event.data.after;
if (!snapshot) {
console.log("No data associated with the event");
return;
}
const data = snapshot.data();
// retrieve auth context from event
const { authType, authId } = event;
let verified = false;
if (authType === "system") {
// system-generated users are automatically verified
verified = true;
} else if (authType === "unknown" || authType === "unauthenticated") {
// admin users from a specific domain are verified
if (authId.endsWith("@example.com")) {
verified = true;
}
}
return data.after.ref.set({
created_by: authId,
verified,
}, {merge: true});
});
Python
@on_document_updated_with_auth_context(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
# Get the current and previous document values.
new_value = event.data.after
prev_value = event.data.before
# Get the auth context from the event
user_auth_type = event.auth_type
user_auth_id = event.auth_id
Tetikleyici etkinliğin dışındaki veriler
Cloud Functions güvenilir bir ortamda yürütülür. Bu işlevler, projenizde hizmet hesabı olarak yetkilendirilir. Firebase Admin SDK'yı kullanarak okuma ve yazma işlemleri gerçekleştirebilirsiniz:
Node.js
const { initializeApp } = require('firebase-admin/app');
const { getFirestore, Timestamp, FieldValue } = require('firebase-admin/firestore');
initializeApp();
const db = getFirestore();
exports.writetofirestore = onDocumentWritten("some/doc", (event) => {
db.doc('some/otherdoc').set({ ... });
});
exports.writetofirestore = onDocumentWritten('users/{userId}', (event) => {
db.doc('some/otherdoc').set({
// Update otherdoc
});
});
Python
from firebase_admin import firestore, initialize_app
import google.cloud.firestore
initialize_app()
@on_document_written(document="some/doc")
def myfunction(event: Event[Change[DocumentSnapshot | None]]) -> None:
firestore_client: google.cloud.firestore.Client = firestore.client()
firestore_client.document("another/doc").set({
# ...
})
Sınırlamalar
- Sıralama garanti edilmez. Hızlı değişiklikler, işlev çağrılarının beklenmedik bir sırada tetiklenmesine neden olabilir.
- 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 mekaniğine bağlı kalmaktan kaçının ve idempotent işlevler yazın.
- Tetikleyici tek bir veritabanıyla ilişkilendirilir. Birden fazla veritabanıyla eşleşen bir tetikleyici oluşturamazsınız.
- Bir veritabanını sildiğinizde, o veritabanının tetikleyicileri otomatik olarak silinmez. Tetikleyici, etkinlikleri yayınlamayı durdurur ancak siz tetikleyiciyi silene kadar var olmaya devam eder.
- 10 MiB'den büyük belgeler etkinlik yüküne dahil edilmez. Sürümü oluşturulmuş dokümanı almak için belirli bir noktadan önceyi kurtarma okuma zamanını kullanın.