@firebase/database-compat

What is @firebase/database-compat?

The @firebase/database-compat package is a compatibility layer for the Firebase Realtime Database, allowing developers to use the Firebase Realtime Database with legacy code that was written for older versions of Firebase. It provides an easy way to interact with Firebase Realtime Database using JavaScript, enabling real-time data synchronization and offline capabilities.

What are @firebase/database-compat's main functionalities?

Real-time Data Synchronization

This feature allows you to synchronize data in real-time. Any changes in the database are automatically and instantly reflected to all connected clients.

const { initializeApp } = require('firebase/app');
const { getDatabase, ref, onValue } = require('@firebase/database-compat');

const app = initializeApp({ /* your config */ });
const db = getDatabase(app);
const dbRef = ref(db, 'path/to/data');
onValue(dbRef, (snapshot) => {
  console.log(snapshot.val());
});

Data Retrieval

This feature allows you to retrieve data once without setting up a continuous listener. It's useful for fetching data at a specific moment.

const { getDatabase, ref, get } = require('@firebase/database-compat');

const db = getDatabase();
const dbRef = ref(db, 'path/to/data');
get(dbRef).then((snapshot) => {
  if (snapshot.exists()) {
    console.log(snapshot.val());
  } else {
    console.log('No data available');
  }
}).catch((error) => {
  console.error(error);
});

Write and Update Data

This feature allows you to write new data or update existing data at a specified path in the database.

const { getDatabase, ref, set, update } = require('@firebase/database-compat');

const db = getDatabase();
const dbRef = ref(db, 'path/to/data');
set(dbRef, { key: 'value' });
update(dbRef, { updatedKey: 'updatedValue' });

Other packages similar to @firebase/database-compat

@firebase/database

This is the modern version of Firebase Realtime Database package. It offers similar functionalities but with a more modular and tree-shakable approach compared to @firebase/database-compat, which is designed for backward compatibility with older Firebase versions.

README

@firebase/database-compat

This is the compatibility layer for the Firebase Realtime Database component of the Firebase JS SDK.

This package is not intended for direct usage, and should only be used via the officially supported firebase package.