Firestore new database - How do I backup

Question

Does the google firestore database service provides a backup? If so, how do I backup the database and how do I restore in case of an error?

Answer 1

Update: It is now possible to backup and restore Firebase Firestore using Cloud Firestore managed export and import service

You do it by:

1. Create a Cloud Storage bucket for your project - Make sure it's a regional in us-central1 or 2 / multi regional type of bucket

2. Set up gcloud for your project using gcloud config set project [PROJECT_ID]

EXPORT

Export all by calling gcloud firestore export gs://[BUCKET_NAME] Or Export a specific collection using gcloud firestore export gs://[BUCKET_NAME] --collection-ids='[COLLECTION_ID_1]','[COLLECTION_ID_2]'

IMPORT

Import all by calling gcloud firestore import gs://[BUCKET_NAME]/[EXPORT_PREFIX]/ where [BUCKET_NAME] and [EXPORT_PREFIX] point to the location of your export files. For example - gcloud firestore import gs://exports-bucket/2017-05-25T23:54:39_76544/

Import a specific collection by calling: gcloud firestore import --collection-ids='[COLLECTION_ID_1]','[COLLECTION_ID_2]' gs://[BUCKET_NAME]/[EXPORT_PREFIX]/

Full instructions are available here: https://firebase.google.com/docs/firestore/manage-data/export-import

Answer 2

Update July 2018: Cloud Firestore now supports managed import and export of data. See the documentation for more details:

https://firebase.google.com/docs/firestore/manage-data/export-import

---

[Googler here] No, right now we do not offer a managed backup or import/export service. This is something we will definitely offer in the future, we just did not get it ready for the initial Beta release.

The best way to back up right now is to write your own script using our Java/Python/Node.js/Go server SDKs, it should be fairly straightforward to download all documents from each collection and write them back if you need to.

Answer 3

https://www.npmjs.com/package/firestore-backup

Is a tool that has been created to do just this.

(I did not create it, just adding it here as people will find this question)

Answer 4

Local backups

1. firestore-import-export

This is the one I use for "one-off", local backups, and what I generally recommend. (most straight-forward if you want a single JSON file)

2. firestore-backup-restore

Drawbacks:

1. Hasn't been updated in a long time.

---

Additional options: (not recommended)

3. python-firebase-admin-firestore-backup

Drawbacks:

1. Backup only; cannot restore from the backups it creates.
2. Hasn't been updated in a long time.

4. firestore-backup

Drawbacks:

1. Backup only; cannot restore from the backups it creates.

Cloud backups

1. The official gcloud backup commands.

Drawbacks:

1. The backup files are difficult/infeasible to parse. (update: how to convert to a json file)
2. You have to set up the gcloud cli. (update: or use the cloud shell to run the commands)
3. It doesn't backup locally; instead, it backs up to the cloud, which you can then download. (could also be considered an advantage, depending on what you want)

Note that for the gcloud backup commands, you have multiple options on how to schedule them to run automatically. A few options are shown here.

Answer 5

I am using the following work-around in order to have daily firestore backups:

I installed this globally: https://www.npmjs.com/package/firestore-backup-restore

I have a cron job that looks like this:

0 12 * * *  cd ~/my/backup/script/folder && ./backup-script.sh

And my backup-script.sh looks like this:

#!/bin/sh

. ~/.bash_profile

export PATH=/usr/local/bin/

dt=$(/bin/date '+%d-%m-%Y %H:%M:%S');
echo "starting backup for $dt"
firestore-backup-restore -a ~/path/to/account/credentials/file.json -B ./backups/"$dt"

Answer 6

I've written a tool that traverses the collections/documents of the database and exports everything into a single json file. Plus, it will import the same structure as well (helpful for cloning/moving Firestore databases). It's published as an NPM package. Feel free to try it and give some feedback.

https://www.npmjs.com/package/node-firestore-import-export

Answer 7

I had the same issue and created a small npm package which allows you to create a scheduled backup with Cloud Functions. It uses the new import/export feature of Firestore.

const firestoreBackup = require('simple-firestore-backup')
exports.firestore_backup = functions.pubsub.schedule('every 24 hours').onRun(firestoreBackup.createBackupHandler())

Checkout the full readme on how to set it up, it's super simple!

Answer 8

A solution using Python 2.

Fork it on https://github.com/RobinManoli/python-firebase-admin-firestore-backup

First install and setup Firebase Admin Python SDK: https://firebase.google.com/docs/admin/setup

Then install it in your python environment:

pip install firebase-admin

Install the Firestore module:

pip install google-cloud-core
pip install google-cloud-firestore

(from ImportError: Failed to import the Cloud Firestore library for Python)

Python Code

# -*- coding: UTF-8 -*-

import firebase_admin
from firebase_admin import credentials, firestore
import json

cred = credentials.Certificate('xxxxx-adminsdk-xxxxx-xxxxxxx.json') # from firebase project settings
default_app = firebase_admin.initialize_app(cred, {
    'databaseURL' : 'https://xxxxx.firebaseio.com'
})

db = firebase_admin.firestore.client()

# add your collections manually
collection_names = ['myFirstCollection', 'mySecondCollection']
collections = dict()
dict4json = dict()
n_documents = 0

for collection in collection_names:
    collections[collection] = db.collection(collection).get()
    dict4json[collection] = {}
    for document in collections[collection]:
        docdict = document.to_dict()
        dict4json[collection][document.id] = docdict
        n_documents += 1

jsonfromdict = json.dumps(dict4json)

path_filename = "/mypath/databases/firestore.json"
print "Downloaded %d collections, %d documents and now writing %d json characters to %s" % ( len(collection_names), n_documents, len(jsonfromdict), path_filename )
with open(path_filename, 'w') as the_file:
    the_file.write(jsonfromdict)

Answer 9

Here is my Android Java code for get backup easily for any fire store data collection

First use this method to read the collection data and store in it to serialized file in the mobile device storage

private void readCollection(){
        ServerSide.db.collection("Collection_name")
                .get()
                .addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() {
                    @Override
                    public void onComplete(@NonNull Task<QuerySnapshot> task) {
                        if (task.isSuccessful()) {
                            HashMap alldata = new HashMap();
                            for (QueryDocumentSnapshot document : task.getResult()) {
                                alldata.put(document.getId(),document.getData());
//                                ServerSide.db.collection("A_Sentences_test").document(document.getId())
//                                        .set(document.getData());
                            }
                            try {
                                FileOutputStream fos = openFileOutput("filename.txt", Context.MODE_PRIVATE);
                                ObjectOutputStream os = new ObjectOutputStream(fos);
                                os.writeObject(alldata);
                                os.close();
                                fos.close();
                                Toast.makeText(MainActivity.this, "Stored", Toast.LENGTH_SHORT).show();

                                FileInputStream fis = openFileInput("filename.txt");
                                ObjectInputStream is = new ObjectInputStream(fis);
                                HashMap ad = (HashMap) is.readObject();
                                is.close();
                                fis.close();
                                Log.w("All data",ad+" ");

                            }catch (Exception e){
                                Log.w("errrrrrrrr",e+"");
                            }
                        } else {
                            Log.d("Colllllllllll", "Error getting documents: ", task.getException());
                        }
                    }
                });
    }

After that you can check the logcat whether the data is serialized correctly. and here is the restore code

private void writeData(){
        try {
            FileInputStream fis = openFileInput("filename.txt");
            ObjectInputStream is = new ObjectInputStream(fis);
            HashMap ad = (HashMap) is.readObject();
            is.close();
            fis.close();
            for (Object s : ad.keySet()){
                ServerSide.db.collection("Collection_name").document(s.toString())
                        .set(ad.get(s));
            }
            Log.w("ddddddddd",ad+" ");
        }catch (Exception e){
            e.printStackTrace();
        }
    }

Hope this would help

Answer 10

Question is old, projects are nice but I have some concerns about the backup.

1-For blaze plan users (free) official solution is off-limit.

2-Since Free users have 50k read quota per day that limit could be a problem in live and large databases.

3-As far as I examined most of the projects does not have a time limit or so, downloading same data every time it is run.

4-Wouldn't it be better to save collections as folders and every document as seperate file and and fetch only updated documents and replace file directly.

I will probably implement my own solution but just wondering your thoughts :)