Firestore Export JSON Convert google firestore/datastore LevelDB exports to JSON data.
Dependencies
- Python 3.9
- Python Google Appengine
Setup
Method 1 - Direct Install
-
Clone the repository.
$ git clone git@github.com:labbots/firestore-export-json.git $ cd firestore-export-json
-
Create a new virtual environment within the project directory.
$ python -m venv venv
-
Activate the virtual environment in the project.
$ source ./venv/bin/activate
-
Install framework dependencies.
$ pip install -e .
Method 2 - Make
-
Clone the repository.
$ git clone git@github.com:labbots/firestore-export-json.git $ cd firestore-export-json
-
Run the make command
$ make install
Usage
- Export firestore collections using firestore admin tools. Follow the instructions here to backup firestore.
- The exports are stored in google cloud storage. Download the exported data directory from cloud storage.
- Use the below command to convert the exported data to JSON.
Method 1
fs_to_json.py
can be used to convert the firestore/datastore export files to JSON data.
$ python fs_to_json.py [path_to_source_dir] -d [path_to_destination]
- Provide the path to the directory where files such as
output-0
exists as source directory usually this would bekinds_*
directory. - Destination directory can be specified where the json files will be created. If not provided then the json files will be created using
json
folder in source directory.
Method 2
The project exposes console script using setuptools to provide fs_to_json
CLI command which can be used to convert exports to JSON.
$ fs_to_json [path_to_source_dir] -d [path_to_destination]
Inspired By
- Venryx/firestore-leveldb-tools - LevelDB files to JSON converter written in python 2.7.