Firestore data import and export
Firestore data import and export
Firestore data importing, exporting, and data clearing tool. Export a Firestore database, including collections and documents, while keeping the structure intact.
Exports a json file with the following format:
…where __collections__ holds the collections for a given document (or the root of the database).
Imports need to be from a file with the same structure (e.g. from an exported file).
Be careful! This can easily overwrite or mess up your data if you import to the wrong location.
Three types of data are serialized in the export:
They each are serialized in the following format:
{
"__datatype__": "timestamp|geopoint|documentReference",
"value": "The serialized value"
}Install using npm.
npm install -g node-firestore-import-exportor yarn
yarn global add node-firestore-import-exportAlternatively download the source.
git clone https://github.com/jloosli/node-firestore-import-export.gitThis downloaded json file contains the proper credentials needed for node-firestore-import-export to authenticate.
If using Firebase Emulators, all commands
(Export, Import, and Clear) will override the account credentials
setting if the FIRESTORE_EMULATOR_HOST environment variable is set.
The path to the account credentials can either be passed with the -a/--accountCredentials flag, or placed in the
GOOGLE_APPLICATION_CREDENTIALS environment variable. For example:
export GOOGLE_APPLICATION_CREDENTIALS=path/to/my/credentials.json
firestore-export -p-a, --accountCredentials `` - path to Google Cloud account credentials JSON file.
If missing, will look at the GOOGLE_APPLICATION_CREDENTIALS environment variable for the path. -b, --backupFile ``- Filename to store backup. (e.g. backups/full-backup.json).
Defaults to firestore-export.json if missing.-n, --nodePath ``- Path to database node to start (e.g. collectionA/docB/collectionC).
Backs up full database if empty or missing.-p, --prettyPrint - JSON backups done with pretty-printing.firestore-export --accountCredentials path/to/credentials/file.json --backupFile /backups/myDatabase.jsonfirestore-export --accountCredentials path/to/credentials/file.json --backupFile /backups/myDatabase.json --prettyPrintfirestore-export --accountCredentials path/to/credentials/file.json --backupFile /backups/myDatabase.json --nodePath collectionA/document1/collectionCC-a, --accountCredentials `` - path to Google Cloud account credentials JSON file.
If missing, will look at the GOOGLE_APPLICATION_CREDENTIALS environment variable for the path. -b, --backupFile ``- Filename with backup data. (e.g. backups/full-backup.json).-n, --nodePath ``- Path to database node to start (e.g. collectionA/docB/collectionC).-y, --yes - Unattended import without confirmation (like hitting "y" from the command line).firestore-import --accountCredentials path/to/credentials/file.json --backupFile /backups/myDatabase.jsonfirestore-import --accountCredentials path/to/credentials/file.json --backupFile /backups/myDatabase.json --nodePath collectionA/document1/collectionCC-a, --accountCredentials `` - path to Google Cloud account credentials JSON file.
If missing, will look at the GOOGLE_APPLICATION_CREDENTIALS environment variable for the path. -n, --nodePath ``- Path to database node to start (e.g. collectionA/docB/collectionC).-y, --yes - Unattended clear without confirmation (like hitting "y" from the command line). Command will wait 5
seconds so you can Ctrl-C to stop.-w, --noWait - Combine this with the --yes confirmation to not wait 5 secondsfirestore-clear --accountCredentials path/to/credentials/file.json --yesThe underlying library can be used in a node or web application for importing and exporting data in a similar fashion
import {firestoreExport} from 'node-firestore-import-export';
import * as firebase from 'firebase-admin';
firebase.initializeApp({
apiKey: "AIza....",
authDomain: "YOUR_APP.firebaseapp.com",
databaseURL: "https://YOUR_APP.firebaseio.com",
storageBucket: "YOUR_APP.appspot.com",
messagingSenderId: "123456789"
});
const collectionRef = firebase.firestore().collection('collectionA/docB/collectionC');
firestoreExport(collectionRef)
.then(data=>console.log(data));……Feel free to report bugs and make feature requests in the Issue Tracker, fork and create pull requests!
The command line was inspired heavily by SteadyEquipment's node-firestore-backup
No open issues yet, or sync has not completed.