Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
firestore-export-import
Advanced tools
NPM package for backup and restore Firebase Firestore
You can export and import data from firestore with sub collection.
Install using npm.
npm install firestore-export-import
You can Generate New Private Key from Project Settings from Firebase Console.
After that you need to copy the databaseURL for initiating the App.
You have to import this package in a JavaScript file and work from there.
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.
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));
})
This code will help you to import data from a JSON file to firestore. You have two options:
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>>
// 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.date3'], ['location1', 'location2']);
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"
}
}
}
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!
[0.3.0] - 2019-11-11
FAQs
NPM package for backup and restore Firebase Firestore
The npm package firestore-export-import receives a total of 4,478 weekly downloads. As such, firestore-export-import popularity was classified as popular.
We found that firestore-export-import demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.