Firebase Resource
Access Firebase Real-time Database (opens in a new tab): Query or update hierarchical, JSON-like data in a NoSQL database.
Please note: The Firebase resource currently only works with the Firebase real-time database. It does not work with either Firestore or Storage.
Configuration Steps
- Open or create the Firebase project you'd like to connect to in the Firebase Console (opens in a new tab).
- Click on the gear icon ⚙️ in the top left corner of the the project overview page followed by "Project Settings".
- Copy the Project ID and Web API Key from the Your Project section and paste them into the appropriate fields in Dynaboard.
- Secret fields (e.g. passwords or certificates) require clicking the ✓ to the right of the field to save the input.
- Return to the project overview page and click on "Real-time Database" in the side panel.
- Copy the real-time database URL from the dashboard and paste it into Dynaboard.
- Real-time database URLs generally follow the format:
https://project-id-default-rtdb.firebaseio.com/
- Real-time database URLs generally follow the format:
- (Optional) If you only want to access public data, you do not need to provide a user email and password. However, if you'd like to access private data, return to the project overview page and click on "Authentication" in the side panel.
- To provide authenticated access to Dynaboard you'll need to have email/password based authentication enabled.
- Once enabled you can create a dedicated user for Dynaboard and copy over the credentials.
- Note: Filling in the Storage Bucket Name in Dynaboard is not currently supported.
- Once you're done, click "Test Connection" at the bottom of the panel in Dynaboard to verify everything works!
Common Configuration Errors
- A secret may be unsaved (e.g. passwords or certificates). Click the ✓ to the right of the field to save it. The text will disappear after a successful save.
- Depending on your setup ensure that either the appropriate account or public users have the ability to access the data you're trying to query / update / insert.
Properties
Environment Profiles
| Prop | profiles |
|---|---|
| Type | array |
| Default | [ { 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
| Prop | profiles[] |
|---|---|
| Type | object |
| Default | undefined |
A profile of this resource for an environment
Database URL
| Prop | profiles[].databaseUrl |
|---|---|
| Type | string |
| Default | undefined |
Full database URL, region-dependent.
Project ID
| Prop | profiles[].firebaseProjectId |
|---|---|
| Type | string |
| Default | undefined |
"Project ID" in Google's project settings.
Web API Key
| Prop | profiles[].webApiKey |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
"Web API key" in Google's project settings.
User Email
| Prop | profiles[].email |
|---|---|
| Type | string |
| Default | undefined |
Email of the authorized user.
User Password
| Prop | profiles[].password |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
Password of the authorized user.
Environment
| Prop | profiles[].environment |
|---|---|
| Type | string |
| Default | undefined |
The name of the environment with which this profile is associated
Actions
Query Data
Fetches data from Firebase according to conditions.
| Parameter | Type | Default |
|---|---|---|
path | string | undefined |
Insert or Update Data
Inserts or updates a subtree at a given path.
| Parameter | Type | Default |
|---|---|---|
path | string | undefined |
value | unknown | undefined |
Delete Data
Deletes a subtree at a given path.
| Parameter | Type | Default |
|---|---|---|
path | string | undefined |