Node-RED nodes to communicate with Firebase Realtime Databases

Report Bug · Request Feature · Discussion

Caution

BREAKING CHANGES: v0.7.0: the required version of Node.js is now >=18

Caution

BREAKING CHANGES: If you are updating to v0.6, please read the migration procedure.

What is it?

This package is used to communicate with Firebase Realtime Databases. It allows to add, modify and fetch data from your databases aswell as subscribing to data at the paths you specify which yields a payload whenever a value changes.

The Nodes

There are 4 nodes included with this contrib:

Node	Purpose
Firebase in	Subscribes to data at the specified path, which yields a payload whenever a value changes.
Firebase get	Fetches data from the specified path. Query constraints can be used to sort and order your data.
Firebase out	SET, PUSH, UPDATE, REMOVE, SET PRIORITY or SET WITH PRIORITY data at the target Database.
On Disconnect	SET, CANCEL, UPDATE, REMOVE or SET WITH PRIORITY data at the target Database when the Client disconnects.

Features

• Autocomplete the Path field

  

• Editable List for Query Constraints

  You can statically define your Query Constraints with an Editable List, which is used to sort and order your data as required.

  

• Error message for incorrect input

  The field tells you if the input is incorrect and gives you a reason.

  

• Drag and drop JSON file

  Automatically populates the fields with the content of the JSON file you provide.

  

How to use?

• From Manage Palette

Find this package @gogovega/node-red-contrib-firebase-realtime-database and click install.

• Install Manually
  .node-red is usually relative to the users home directory that is running Node RED.

cd ~/.node-red
npm install @gogovega/node-red-contrib-firebase-realtime-database --omit=dev

Remember to restart Node RED after using either method.

Authentication Methods

• Anonymous
• Email
• Private Key (Firebase Admin Node.js SDK)
• Custom Token (Generated with Private Key)

Read more about the different ways to authenticate here.

Getting Started Link

• Installing: System requirements and install instructions
• Migrate to v0.6: The migration procedure to update to v0.6
• Build Database: How to build a Firebase database?
• Authentication Methods: Which method used to connect?
• Firestore Nodes: You search for the Google Cloud Firestore Nodes?
• Wiki: Just about everything
• Firebase Site: What is Firebase?
• Change Log: Whats changed?

Feature Request

If you have any other suggestions, please let me know here.

License

MIT License

Copyright (c) 2022-2024 Gauthier Dandele

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.