Firebase

How to use Firebase Cloud Functions to clean up orphaned data?

Discover powerful techniques to clean up and handle orphaned data with Firebase Cloud functions! Keep your app running smoothly and enhance the user experience .

Developer profile skeleton
a developer thinking

Overview

Firebase Cloud Functions offer a serverless solution for managing backend work like data processing and cleanup. This part zeroes in on using these functions to eliminate orphaned or unused data in a Firebase database. Tidying up this data can boost performance and trim down on wasted storage space. The process includes spotting unused references, data nodes, and other stray items, then getting rid of them efficiently without messing up active data and operations. Before diving into the steps, it's good to grasp the basics of Firebase functions, Node.js, and how to use promises in Firebase.

Get a Free No-Code Consultation
Meet with Will, CEO at Bootstrapped to get a Free No-Code Consultation
Book a Call
Will Hawkins
CEO at Bootstrapped

How to use Firebase Cloud Functions to clean up orphaned data?

Setting Up Firebase Cloud Functions

Alright, let's get started with Firebase Cloud Functions. First things first, you need to set up your Firebase project. To do that, you'll want to install the Firebase CLI globally using npm. This way, you can run firebase commands from anywhere on your computer. Just pop open your terminal and run:

npm install -g firebase-tools

If you've already got the Firebase CLI installed, make sure it's up-to-date. You can check the version by running:

firebase --version

Next, log into Firebase using your Google Account:

firebase login

To kick off a new project, run firebase init functions. This will walk you through the setup. Just make sure you've already created a Firebase project in your Firebase console. Once your project is all set up and initialized, head into your functions directory and install Cloud Firestore:

cd functions && npm install @google-cloud/firestore

Writing the Cloud Function

Now, let's dive into writing the Cloud Function. Open up the index.js file in your functions directory. You'll need to import both 'firebase-functions' and '@google-cloud/firestore'. Then, create a new Firestore instance:

const functions = require('firebase-functions');
const Firestore = require('@google-cloud/firestore');
const firestore = new Firestore({
  projectId: 'YOUR_PROJECT_ID',
  timestampsInSnapshots: true,
});

Don't forget to replace 'YOUR_PROJECT_ID' with your actual Firebase project’s ID. You can find this in the Project Overview section of the Firebase console.

Next up, let's build a function to clean up orphaned data. This function will listen for deletion events in a specific collection and then find and delete all related data in another collection.

exports.cleanUp = functions.firestore
  .document('/mainCollection/{docId}')
  .onDelete((snap, context) => {
    const deletedDocId = context.params.docId;

    return firestore
      .collection('associatedCollection')
      .where('mainDocId', '==', deletedDocId)
      .get()
      .then((snapshot) => {
        const deletionPromises = [];
        snapshot.forEach((doc) => {
          deletionPromises.push(doc.ref.delete());
        });
        return Promise.all(deletionPromises);
      })
      .catch((err) => {
        console.log(err);
        return false;
      });
  });

In this function, mainCollection is the collection where the deletion triggers the Cloud Function. associatedCollection is the collection with orphaned documents you want to delete. The mainDocId field in associatedCollection links to the deleted document in mainCollection.

Deploying the Cloud Function

Alright, now that we've written the function, it's time to deploy it. Run:

firebase deploy --only functions:cleanUp

This command deploys just the cleanUp function from your index.js file, leaving any other functions untouched.

Now, whenever a document is deleted in mainCollection, the Cloud Function will trigger and clean up all related documents in associatedCollection.

Remember, Cloud Functions are serverless, so they run in the cloud and you only pay for the compute time you use. You can create some pretty complex chains of Cloud Functions based on Firestore events, turning your Cloud Firestore into a real-time, reactive database.

Explore more Firebase tutorials

Complete Guide to Firebase: Tutorials, Tips, and Best Practices

Explore our Firebase tutorials directory - an essential resource for learning how to create, deploy and manage robust server-side applications with ease and efficiency.

Why are companies choosing Bootstrapped?

40-60%

Faster with no-code

Nocode tools allow us to develop and deploy your new application 40-60% faster than regular app development methods.

90 days

From idea to MVP

Save time, money, and energy with an optimized hiring process. Access a pool of experts who are sourced, vetted, and matched to meet your precise requirements.

1 283 apps

built by our developers

With the Bootstrapped platform, managing projects and developers has never been easier.

hero graphic

Our capabilities

Bootstrapped offers a comprehensive suite of capabilities tailored for startups. Our expertise spans web and mobile app development, utilizing the latest technologies to ensure high performance and scalability. The team excels in creating intuitive user interfaces and seamless user experiences. We employ agile methodologies for flexible and efficient project management, ensuring timely delivery and adaptability to changing requirements. Additionally, Bootstrapped provides continuous support and maintenance, helping startups grow and evolve their digital products. Our services are designed to be affordable and high-quality, making them an ideal partner for new ventures.

Engineered for you

1

Fast Development: Bootstrapped specializes in helping startup founders build web and mobile apps quickly, ensuring a fast go-to-market strategy.

2

Tailored Solutions: The company offers customized app development, adapting to specific business needs and goals, which ensures your app stands out in the competitive market.

3

Expert Team: With a team of experienced developers and designers, Bootstrapped ensures high-quality, reliable, and scalable app solutions.

4

Affordable Pricing: Ideal for startups, Bootstrapped offers cost-effective development services without compromising on quality.

5

Supportive Partnership: Beyond development, Bootstrapped provides ongoing support and consultation, fostering long-term success for your startup.

6

Agile Methodology: Utilizing agile development practices, Bootstrapped ensures flexibility, iterative progress, and swift adaptation to changes, enhancing project success.

Yes, if you can dream it, we can build it.