:bullettrain_side: A CLI utility for moving data to and from Cloud Firestore
👀 Firestore now has an official import/export process. Consider that your first option if it suits your needs. If it does not, continue reading...
CLI tool for moving data in-n-out of Cloud Firestore.
Watch the screencast
npm install
credentials.jsonin the project root.
npm run buildand you're off and running.
import|i [options] [collections...]
Options: ``` -i, --id [field] Field to use for Document IDs. (default: doc_id) -a, --auto-id [str] Document ID token specifying auto generated Document ID. (default: Auto-ID) -m, --merge Merge Firestore documents. Default is Replace. -k, --chunk [size] Split upload into batches. Max 500 by Firestore constraints. (default: 500) -p, --coll-prefix prefixCollection prefix. (default: collection)
-s, --sheet [#] Single mode XLSX Sheet # to import.
-T, --truncate Delete all documents from target collections before import.
-d, --dry-run Perform a dry run, without committing data. Implies --verbose. -v, --verbose Output document insert paths -h, --help output usage information ```
Examples:
fire-migrate import --dry-run test.json myCollection fire-migrate import --merge test.INDEX.csv myCollection fire-migrate i -m --id docid test.xlsx myCollection
export|e [options] [collections...]
Options: ```
-n, --no-subcolls Do not export sub-collections. -p, --coll-prefix [prefix] Collection prefix (default: collection) -i, --id-field [id] Field name to use for document IDs (default: doc_id)
-v, --verbose Output traversed document paths -h, --help output usage information ```
Examples:
fire-migrate export --verbose --no-subcolls myCollectionRootLevel.json myCollection fire-migrate export users-posts.json users posts fire-migrate e -v firestore-dump.xlsx