@crapougnax/firestore-export-import
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.0 • Public • Published

    firestore-export-import

    GitHub version Build Status David badge

    NPM package for backup and restore Firebase Firestore

    You can export and import data from firestore with sub collection.

    Installation

    Install using npm.

    npm install firestore-export-import

    Get Google Cloud Account Credentials from Firebase

    You can Generate New Private Key from Project Settings from Firebase Console.

    After that you need to copy the databaseURL for initiating the App.

    Usage

    You have to import this package in a JavaScript file and work from there.

    Export data from firestore

    You can export collection and sub collection from your data. The sub collection is optional.

    // In your index.js
     
    const firestoreService = require('firestore-export-import');
    const serviceAccount = require('./serviceAccountKey.json');
     
    // Initiate Firebase App
    firestoreService.initializeApp(serviceAccount, databaseURL);
     
    // Start exporting your data
    firestoreService
      .backup('collection-name', 'sub-collection-optional')
      .then(data => console.log(JSON.stringify(data)))

    If the sub collection exists, it will be saved under subCollection.

    Get all collections data

    This is a suggestion from jcummings2 and leningsv

    The ['collectionName1', 'collectionName2'] is OPTIONAL, you can remove this parameter to get all of the current collections in your firestore.

    The result is an object of collection's data.

    firestoreService
      .backups(['collectionName1', 'collectionName2']) // Array of collection's name is OPTIONAL
      .then(collections => {
        // You can do whatever you want with collections
        console.log(JSON.stringify(collections));
      })
     

    Import data to firestore

    This code will help you to import data from a JSON file to firestore. You have two options:

    • Restore from a JSON file from your local machine
    • Restore from a JSON from a HTTP request

    This will return a Promise<{status: boolean, message: string}>

    Remember that, this action doesn't remove the collection. It will override or add new data to the collection. If you want to remove the current collection, you should do it from firebase console or using firebase firestore:delete

    firebase firestore:delete [options] <<path>>

    For local JSON

    // In your index.js
     
    const firestoreService = require('firestore-export-import');
    const serviceAccount = require('./serviceAccountKey.json');
     
    // Initiate Firebase App
    firestoreService.initializeApp(serviceAccount, databaseURL);
     
    // Start importing your data
    // The array of date and location fields are optional
    firestoreService.restore('your-file-path.json', ['date1', 'date2'], ['location1', 'location2']);

    For HTTP Request

    import request from 'request-promise';
    ...
    const backupData = await request('JSON-URL');
    const status = await firestoreService.restore(JSON.parse(backupData), ['date'], ['location']);

    The JSON is formated as below. The collection name is test. first-key and second-key are document ids.

    {
      "test": {
        "first-key": {
          "website": "dalenguyen.me",
          "date": {
            "_seconds": 1534046400,
            "_nanoseconds": 0
          },
          "custom": {
            "lastName": "Nguyen",
            "firstName": "Dale"
          },
          "location": {
            "_latitude": 49.290683,
            "_longitude": -123.133956
          },
          "email": "dungnq@itbox4vn.com",
          "subCollection": {
            "test/first-key/details": {
              "33J2A10u5902CXagoBP6": {
                "dogId": "2",
                "dogName": "hello"
              },
              "MSZTWEP7Lewx0Qr1Mu5s": {
                "dogName": "lala",
                "dogId": "2"
              }
            }
          }
        },
        "second-key": {
          "website": "google.com",
          "date": {
            "_seconds": 1534262435,
            "_nanoseconds": 0
          },
          "custom": {
            "lastName": "Potter",
            "firstName": "Harry"
          },
          "location": {
            "_latitude": 49.290683,
            "_longitude": -123.133956
          },
          "email": "test@dalenguyen.me"
        }
      }
    }

    Contributions

    This project is based on firestore-import-export, feel free to report bugs and make feature requests in the Issue Tracker, fork and create pull requests!

    Install

    npm i @crapougnax/firestore-export-import

    DownloadsWeekly Downloads

    1,163

    Version

    0.3.0

    License

    ISC

    Unpacked Size

    42.5 kB

    Total Files

    20

    Last publish

    Collaborators

    • crapougnax