Firebase
Firebase is a platform developed by Google for creating mobile and web applications.
Firebase Cloud Firestore is a document-based, flexible, scalable, and NoSQL cloud database, used to store and sync data for client and server-side applications.
This component uses the Firebase Admin SDK to create, read, update, delete, and list documents within a Firebase Cloud Firestore collection.
See more information in the Cloud Firestore section of the Firebase Admin SDK in the Firebase Docs.
Connections¶
Firebase Private Key Connection {#firebaseconnection}¶
Authenticate requests to firebase using values obtained from the Google Cloud Platform.
The Firebase Admin SDK is a set of server libraries that lets you interact with Firebase from privileged environments. To authenticate through the Firebase Admin SDK, follow the instructions to generate a private key located on the Firebase docs This will involve you creating a service account in the Google Cloud Platform and generating credentials for that user. You will receive a JSON file containing many fields including a private key, and client email which you will use to make a new connection. In the new connection, enter the value of the client email, private key, and your GCP project Id.
| Input | Comments | Default |
|---|---|---|
| Project Id | Provide the unique identifier of the project from the Google Cloud Platform. | |
| Private Key | Provide the private key from the Google Cloud Platform. | |
| Provide the client email for the GCP account. |
Actions¶
Bulk Create Documents {#bulkcreatedocuments}¶
Create multiple documents in a Cloud Firestore collection in a single operation
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| Collection | Provide a string value for the collection name. | |
| Documents | An array of documents to be created in the collection. | [ |
Create Document {#createdocument}¶
Create a document in a Cloud Firestore collection
| Input | Comments | Default |
|---|---|---|
| Collection | Provide a string value for the collection name. | |
| Data | Provide a key value pair that represents your data. | |
| Connection |
Delete Document {#deletedocument}¶
Remove a document from a Cloud Firestore collection
| Input | Comments | Default |
|---|---|---|
| Collection | Provide a string value for the collection name. | |
| Document | Provide a string value for the unique identifier of the document. | |
| Connection |
Get Document {#getdocument}¶
Get the contents of a document in a Cloud Firestore collection
| Input | Comments | Default |
|---|---|---|
| Collection | Provide a string value for the collection name. | |
| Document | Provide a string value for the unique identifier of the document. | |
| Connection |
List Collections {#listcollections}¶
List all collections in a Cloud Firestore database
| Input | Comments | Default |
|---|---|---|
| Connection |
List Documents {#listdocuments}¶
List all documents in a Cloud Firestore collection
| Input | Comments | Default |
|---|---|---|
| Collection | Provide a string value for the collection name. | |
| Connection | ||
| Order By | Provide a string value for the field to order by. | |
| Query Operators |
Remove Field {#removefield}¶
Completely removes a field from a given document (may not work on a field with a null value)
| Input | Comments | Default |
|---|---|---|
| Collection | Provide a string value for the collection name. | |
| Document | Provide a string value for the unique identifier of the document. | |
| Field To Remove | Provide a string value for the name of the field you would like to remove from the document. | |
| Connection |
Update Document {#updatedocument}¶
Updates a document in a Cloud Firestore collection
| Input | Comments | Default |
|---|---|---|
| Collection | Provide a string value for the collection name. | |
| Document | Provide a string value for the unique identifier of the document. | |
| Data | Provide a key value pair that represents your data. | |
| Connection |