Firestore API Reference
This section documents all Firebase Firestore Blueprint nodes provided by the plugin. These nodes allow you to create, update, read, delete, query, and listen to Firestore documents and collections, as well as perform batched write operations.
Firestore operations use structured data represented by FFirestoreDocument and FFirestoreValue. Understanding these structures is required for effective Firestore usage.
All Firestore nodes require Firebase to be successfully initialized before use.
Document Operations
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set Document | Path (string), Document (FFirestoreDocument) |
On Success (Path): Called when the document is written successfully. On Failure (Path, Error Message, Error Code): Called if the operation fails. |
Writes a Firestore document at the specified path, replacing any existing document. |
| Update Document | Path (string), Document (FFirestoreDocument) |
On Success (Path): Called when the document is updated successfully. On Failure (Path, Error Message, Error Code): Called if the operation fails. |
Updates fields of an existing Firestore document without overwriting the entire document. |
| Get Document | Path (string) |
On Success (Path, Document): Called when the document is retrieved successfully. On Failure (Path, Error Message, Error Code): Called if the operation fails. |
Retrieves a Firestore document asynchronously. |
| Delete Document | Path (string) |
On Success (Path): Called when the document is deleted successfully. On Failure (Path, Error Message, Error Code): Called if the operation fails. |
Deletes a Firestore document at the specified path. |
| Add Document | CollectionPath (string), Document (FFirestoreDocument) |
On Success (Collection, DocumentId, Path): Called when the document is added successfully. On Failure (Collection, Error Message, Error Code): Called if the operation fails. |
Adds a new document with an auto-generated ID to a Firestore collection. |
Queries
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Create Query | CollectionPath (string) |
Return (Handle) | Creates a Firestore query object and returns a query handle used to configure and execute the query. |
| Query Where | Handle (int32), Field (string), Operator (EFirestoreQueryOperator), Value (FFirestoreValue) |
– | Adds a WHERE clause to the specified Firestore query. |
| Query Order By | Handle (int32), Field (string), bDescending (bool) |
– | Adds an ORDER BY clause to the specified Firestore query. |
| Query Limit | Handle (int32), Limit (int) |
– | Limits the maximum number of documents returned by the query. |
| Run Query | Handle (int32) |
On Success (Handle, Documents): Called when the query completes successfully. On Failure (Handle, Error Message, Error Code): Called if the query fails. |
Executes the configured Firestore query asynchronously. |
| Release Query | Handle (int32) |
– | Releases the query object and frees associated resources. |
Listeners
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Listen Document | Path (string) |
Return (Handle). On Snapshot (Handle, Document): Called when the document changes. On Error (Handle, Error Message, Error Code): Called on listener error. |
Listens for realtime changes to a Firestore document. |
| Listen Collection | CollectionPath (string) |
Return (Handle). On Snapshot (Handle, Documents): Called when the collection changes. On Error (Handle, Error Message, Error Code): Called on listener error. |
Listens for realtime changes to a Firestore collection. |
| Stop Listener | Handle (int32) |
– | Stops a previously registered Firestore listener using its handle. |
Batch Operations
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Begin Batch | – | Return (Handle) | Begins a new Firestore write batch and returns a batch handle. |
| Batch Set | Handle (int32), Path (string), Document (FFirestoreDocument) |
– | Adds a SET operation to the specified Firestore batch. |
| Batch Update | Handle (int32), Path (string), Document (FFirestoreDocument) |
– | Adds an UPDATE operation to the specified Firestore batch. |
| Batch Delete | Handle (int32), Path (string) |
– | Adds a DELETE operation to the specified Firestore batch. |
| Commit Batch | Handle (int32) |
On Success (Handle): Called when the batch is committed successfully. On Failure (Handle, Error Message, Error Code): Called if the commit fails. |
Commits all operations added to the Firestore batch atomically. |