Firebase Admin icon

Firebase Admin

Interact with Firebase Firestore, Auth, and Storage using Firebase Admin SDK

Firestore → Set

AI-generated

Summary

Set a Firestore document's data at a specified path in a given project, optionally merging with existing data.

Inputs

  • Project Name or ID — Select the Firebase project by name or ID to use for the Firestore operation.
  • Path (required) — Specify the full Firestore document path (collection/documentId and supports nested subcollections).
  • Document Data (required) — Provide the JSON object representing the document's data, supporting Firestore special functions such as serverTimestamp, increment, arrayUnion, etc.
  • Merge — Choose whether to merge the supplied data with the existing document data (true) or overwrite it completely (false, default).

Output shape

a JSON object representing the stored document data or write result from Firestore

The returned data shape depends on Firestore operation response; typically includes the document write result. If merge is true, only specified fields are updated, preserving other fields.

Links

Discussion