Lazy Firestore

Features

• Export data to files
• Restore exported data back to Firestore
• Update document with data in JSON file
• Clean Firestore - delete all documents. Only support Firebase Emulator
• Print tree of collections and its documents
• View detail of documents
• Watch documents for changes

Table of contents

• Table of contents
• Install
• Usage
• Setup projects
  • Real project
  • Firebase Emulator
• Sub commands
  • ⚡️ doctor
  • ⚡️ dump
  • ⚡️ restore
  • ⚡️ update
  • ⚡️ clean
  • ⚡️ tree
  • ⚡️ doc

Install

Install global:

npm i -g lazy-firestore

Usage

After install, use cli app named firestore

firestore/0.1.8

Usage:
  $ firestore

Commands:
  dump [...name]         Dump Firestore to file
  restore [snapshot]     Restore Firestore from exported data
  update <doc>           Update document with data in a JSON file
  clean                  Clean Firestore - delete all documents, only use with Emulator's Firestore
  tree [...collections]  Print Firestore structure
  doc [...docs]          Dump Firestore documents
  doctor                 Diagnose info to connection to Firestore


For more info, run any command with the `--help` flag:
  $ firestore dump --help
  $ firestore restore --help
  $ firestore update --help
  $ firestore clean --help
  $ firestore tree --help
  $ firestore doc --help
  $ firestore doctor --help
  $ firestore --help

Options:
  -h, --help     Display this message
  -v, --version  Display version number

Setup projects

Real project

Set environment:

export GCLOUD_PROJECT=project-name
export GOOGLE_APPLICATION_CREDENTIALS="/absolute/path/to/service/account/key.json"

Firebase Emulator

Set environment:

export GCLOUD_PROJECT=project-name
export FIRESTORE_EMULATOR_HOST=localhost:8080

Sub commands

⚡️ doctor

Diagnose info to connection to Firestore

firestore/0.1.8

Usage:
  $ firestore doctor

Options:
  -h, --help  Display this message

Examples:
firestore doctor

⚡️ dump

Export data to files

firestore/0.1.8

Usage:
  $ firestore dump [...name]

Options:
  --debug     Use debug mode
  -h, --help  Display this message

Examples:
firestore dump
firestore dump case 1
firestore dump base

Examples:

• firestore dump => 2021_08_04 09_45_42/
• firestore dump case 1 => 2021_08_04 09_45_42 - case 1/

⚡️ restore

Restore exported data back to Firestore:

• If not specified snapshot name, then scan working path to find folders, and select from found items
• Select collections to restore

firestore/0.1.8

Usage:
  $ firestore restore [snapshot]

Options:
  --only <collections>    Collections to import, support separate multi collection by comma, Ex: --only user --only=logs,news
  --except <collections>  Collections to exclude, support separate multi collection by comma. Ex: --except=user,logs
  --dump                  Dump tree of selected snapshot
  --debug                 Use debug mode
  --dryRun                Dry-run mode
  -h, --help              Display this message

Examples:
firestore restore
firestore restore "2021_08_04 09_45_42 - case 1"
firestore restore "2021_08_04 09_45_42 - case 1" --only users --only posts,news --excepts=users

⚡️ update

Update document with data in a JSON file

firestore/0.1.8

Usage:
  $ firestore update <doc>

Options:
  --file <file>           Path to update file
  --path <path>           Update path, ex: tags
  --debug                 Use debug mode
  --mode <merge|replace>  Update mode, accept: merge, replace (default: merge)
  -h, --help              Display this message

Examples:
firestore update --path=city --file hanoi.json users/foo

⚡️ clean

Clean Firestore - delete all documents. Only support Firebase Emulator

firestore/0.1.8

Usage:
  $ firestore clean

Options:
  --debug     Use debug mode
  -h, --help  Display this message

Examples:
firestore clean

⚡️ tree

Print tree of collections and its documents

firestore/0.1.8

Usage:
  $ firestore tree [...collections]

Options:
  --debug     Use debug mode
  -h, --help  Display this message

Examples:
firestore tree
firestore tree news users

⚡️ doc

• View detail of documents
• Watch changes

firestore/0.1.8

Usage:
  $ firestore doc <...docs>

Options:
  --debug                          Use debug mode
  --watch                          Watch changes of documents
  --beep                           [Watch mode] Play "beep" when a change found (default: false)
  --diff                           [Watch mode] Print what changed only (default: true)
  --json                           Print data in json format
  --iso                            Print date in ISO 8601 format (default: false)
  --collection <collection-name>   Base collection name
  --inspect-depth <inspect-depth>  Depth of data to inspect (default: 20)
  -h, --help                       Display this message

Examples:
firestore doc user/1
firestore doc user/1 user/2
firestore doc --collection user 1 2 posts/hello
firestore doc --collection user 1 2 posts/hello --watch
firestore doc --collection user 1 2 posts/hello --watch --beep
firestore doc --collection user 1 2 posts/hello --watch --no-diff

Examples:

📝 Print a doc:

firestore doc user/1

📝 Print many docs:

firestore doc user/1 user/2 posts/hello

📝 Print docs use default collection:

firestore doc --collection=user 1 2 posts/hello

📝 Watch docs:

firestore doc user/1 user/2 --watch

📝 Watch docs and play beep sound when has changes found:

firestore doc user/1 user/2 --watch --beep