Cloud Functions'ı (2. nesil) kullanarak Cloud Firestore'u genişletin

Cloud Functions ile Cloud Firestore veritabanınızdaki değişikliklerin tetiklediği etkinlikleri işlemek için kod dağıtabilirsiniz. Böylece kendi sunucularınızı çalıştırmadan uygulamanıza kolayca sunucu tarafı işlevi ekleyebilirsiniz.

Cloud Functions (2. nesil)

Cloud Run ve Eventarc tarafından desteklenen Cloud Functions for Firebase (2. nesil), size daha güçlü altyapı, performans ve ölçeklenebilirlik üzerinde gelişmiş kontrol ve işlevlerin çalışma zamanı üzerinde daha fazla kontrol sunar. 2. nesil hakkında daha fazla bilgi için Cloud Functions for Firebase (2. nesil) sayfasına göz atın. Bunun yerine 1. nesil hakkında daha fazla bilgi edinmek için Cloud Firestore'u Cloud Functions ile Genişletme sayfasını inceleyin.

Cloud Firestore işlev tetikleyicileri

Cloud Functions for Firebase SDK'sı, belirli Cloud Firestore etkinliklerine bağlı işleyiciler oluşturabilmeniz için aşağıdaki Cloud Firestore etkinlik tetikleyicilerini dışa aktarır:

Node.js

Etkinlik Türü Tetikleyici
onDocumentCreated Bir doküman kendisine ilk kez yazıldığında tetiklenir.
onDocumentUpdated Bir doküman zaten mevcut olduğunda ve herhangi bir değeri değiştirildiğinde tetiklenir.
onDocumentDeleted Bir doküman silindiğinde tetiklenir.
onDocumentWritten onDocumentCreated, onDocumentUpdated veya onDocumentDeleted tetiklendiğinde tetiklenir.
onDocumentCreatedWithAuthContext Ek kimlik doğrulama bilgilerine sahip onDocumentCreated
onDocumentWrittenWithAuthContext Ek kimlik doğrulama bilgilerine sahip onDocumentWritten
onDocumentDeletedWithAuthContext Ek kimlik doğrulama bilgilerine sahip onDocumentDeleted
onDocumentUpdatedWithAuthContext Ek kimlik doğrulama bilgilerine sahip onDocumentUpdated

Python (önizleme)

Etkinlik Türü Tetikleyici
on_document_created Bir doküman kendisine ilk kez yazıldığında tetiklenir.
on_document_updated Bir doküman zaten mevcut olduğunda ve herhangi bir değeri değiştirildiğ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 bilgilerine sahip on_document_created
on_document_updated_with_auth_context Ek kimlik doğrulama bilgilerine sahip on_document_updated
on_document_deleted_with_auth_context Ek kimlik doğrulama bilgilerine sahip on_document_deleted
on_document_written_with_auth_context Ek kimlik doğrulama bilgilerine sahip on_document_written

Cloud Firestore etkinlikleri yalnızca belge değişiklikleri yapıldığında tetiklenir. Verilerin değişmediği bir Cloud Firestore belgesi güncellemesi (işlemsiz yazma), güncelleme veya yazma etkinliği oluşturmaz. Belirli alanlara etkinlik eklenemez.

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 Cloud Functions for Firebase'i kullanmaya başlama (2. nesil) 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

import {
  onDocumentWritten,
  onDocumentCreated,
  onDocumentUpdated,
  onDocumentDeleted,
  Change,
  FirestoreEvent
} from "firebase-functions/v2/firestore";

exports.myfunction = onDocumentWritten("my-collection/{docId}", (event) => {
   /* ... */ 
});

Python (önizleme)

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:

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

import {
  onDocumentWritten,
  Change,
  FirestoreEvent
} from "firebase-functions/v2/firestore";

exports.myfunction = onDocumentWritten("users/marie", (event) => {
  // Your code here
});

Python (önizleme)

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

import {
  onDocumentWritten,
  Change,
  FirestoreEvent
} from "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 (önizleme)

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ç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 alan değiştirilirse userId joker karakteri tetiklenmez.

Joker karakter eşleşmeleri belge yolundan ayıklanır ve event.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

import {
  onDocumentWritten,
  Change,
  FirestoreEvent
} from "firebase-functions/v2/firestore";

exports.myfunction = onDocumentWritten("users/{userId}/{messageCollectionId}/{messageId}", (event) => {
    // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
    // event.params.userId == "marie";
    // event.params.messageCollectionId == "incoming_messages";
    // event.params.messageId == "134";
    // ... and ...
    // event.data.after.data() == {body: "Hello"}
});

Python (önizleme)

from firebase_functions.firestore_fn import (
  on_document_written,
  Event,
  Change,
  DocumentSnapshot,
)

@on_document_written(document="users/{userId}/{messageCollectionId}/{messageId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
  # If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
  event.params["userId"] == "marie"  # True
  event.params["messageCollectionId"] == "incoming_messages"  # True
  event.params["messageId"] == "134"  # True
  # ... and ...
  event.data.after.to_dict() == {"body": "Hello"}

Joker karakter kullansanız bile tetikleyiciniz her zaman bir dokümanı işaret etmelidir. Örneğin, {messageCollectionId} bir koleksiyon olduğundan users/{userId}/{messageCollectionId} geçerli değildir. Ancak, {messageId} her zaman bir dokümana işaret edeceğinden, users/{userId}/{messageCollectionId}/{messageId} geçerlidir.

Etkinlik Tetikleyicileri

Yeni bir doküman oluşturulduğunda bir işlevi tetikleme

Koleksiyonda her yeni doküman oluşturulduğunda etkinleşmesi için bir işlevi tetikleyebilirsiniz. Aşağıdaki örnek işlev, her yeni kullanıcı profili eklendiğinde tetiklenir:

Node.js

import {
  onDocumentCreated,
  Change,
  FirestoreEvent
} from "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 (önizleme)

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 bir işlevi tetikleme

Ayrıca, bir doküman güncellendiğinde etkinleşecek bir işlevi de tetikleyebilirsiniz. Şu örnek işlev, bir kullanıcı profilini değiştirirse tetiklenir:

Node.js

import {
  onDocumentUpdated,
  Change,
  FirestoreEvent
} from "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 (önizleme)

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şlevi tetikleme

Bir doküman silindiğinde de bir işlevi tetikleyebilirsiniz. Şu örnek işlev, bir kullanıcı, kullanıcı profilini sildiğinde tetiklenir:

Node.js

import {
  onDocumentDeleted,
  Change,
  FirestoreEvent
} from "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 (önizleme)

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

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 "belge yazıldı" etkinlik tetikleyicisini kullanarak bir Cloud Firestore dokümanındaki 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

import {
  onDocumentWritten,
  Change,
  FirestoreEvent
} from "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 (önizleme)

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

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 event.data.before özelliğini kullanarak önceki verileri alabilirsiniz. Benzer şekilde event.data.after, güncellemeden sonraki belge anlık görüntüsü 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 (önizleme)

@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 de 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 (önizleme)

# 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"]

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üde erişebilirsiniz.

Doküman referansı update(), set() ve remove() gibi yöntemler içerir. Böylece işlevi tetikleyen dokümanda değişiklik yapabilirsiniz.

Node.js

import { onDocumentUpdated } from "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 data.after.ref.set({
    name_change_count: count + 1
  }, {merge: true});

});

Python (önizleme)

@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 ana hesap hakkındaki kullanıcı kimlik doğrulama bilgilerine erişebilirsiniz. Bu bilgiler, temel etkinlikte döndürülen bilgilere ek olarak sunulur.

Node.js

  • onDocumentCreatedWithAuthContext
  • onDocumentWrittenWithAuthContext
  • onDocumentDeletedWithAuthContext
  • onDocumentUpdatedWithAuthContext

Python (önizleme)

  • on_document_created_with_auth_context
  • on_document_updated_with_auth_context
  • on_document_deleted_with_auth_context
  • on_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ı bölümüne bakın. Aşağıdaki örnekte kimlik doğrulama bilgilerinin nasıl alınacağı gösterilmektedir:

Node.js

import { onDocumentWrittenWithAuthContext } from "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 (önizleme)

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

Cloud Functions, güvenilir bir ortamda yürütülür. Bu hesaplar, projenizde hizmet hesabı olarak yetkilendirilir ve 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 (önizleme)

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

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.