Firebase Firestore
This page provides an overview of the Firebase Firestore connection, which enables you to access Firebase projects from within your Uiflow application.
This page outlines the following aspects of the Firebase Firestore connection:
This table outlines the required information to configure a Firebase Firestore connection:
Configuration field | Description |
|---|---|
Connection Name | Name of your connection. This appears as a title for your connection tile in the Connect tab. |
apiKey | Code used to identify and authenticate Firebase users. |
authDomain | Authentication domain for your Firebase project ID. |
projectID | ID of your Firebase project. |
This section provides an overview of each available action for the Firebase Firestore connection:
The
add action enables you to add data from your app to your Firestore database. This table outlines its parameters:Parameter | Type | Description |
|---|---|---|
collectionPath | string | Path to the collection where you want to add data. |
data | object | Data you want to add to the collection. |
The
set action enables you to set document data within a collection. This table outlines its parameters:Parameter | Type | Description |
|---|---|---|
collectionPath | string | Path to the collection where you want to set the document data. |
documentPath | string | Path to the document that contains the data you want to set. |
data | object | Document data you want to set in the collection. |
The
get action enables you to retrieve data from your Firestore database. This table outlines its parameters:Parameter | Type | Description |
|---|---|---|
collectionPath | string | Path to the collection want to retrieve. |
documentPath | string | Path to the document you want to retrieve. |
The
delete action enables you to delete data from your Firestore database. This table outlines its parameters:Parameter | Type | Description |
|---|---|---|
collectionPath | string | Path to the collection you want to delete. |
documentPath | string | Path to the document you want to delete. |
The
query action enables you to retrieve a range of information from your Firestore database. This table outlines its parameters:Parameter | Type(s) | Description |
|---|---|---|
collectionPath | string | Path to the collection you want to query. |
orderBy | string | Column that will be sorted. |
orderDir | string | Determines the order of the indicated column. Can be set as either:
* asc: Ascending
* desc: Descending |
startAt | number | Index start point for the query. Includes the start point. |
startAfter | number | Index start point for the query. Excludes the start point. |
limit | number, string | Maximum number of entries returned in a query. |
where | array | Filters returned entries by a user-set condition. For example:
[fieldPath: "field", opStr: "==", value: "hello"] |
The component preview shows how your connection component appears in the Logic view of your Uiflow application.
This section outlines how to:
To change the component name, navigate to the Edit Action section and adjust the Action Name field.
To display parameters on your connection component, click Expose above the parameter fields. Any selected parameters appear on the left of the connection component.
Last modified 1mo ago