Skip to content

codeomnitrix/firestore-explorer

 
 

Repository files navigation

Firestore Studio

A simple Visual Studio Code Extension for listing, viewing, creating/deleting and editing Firebase Firestore Database collections and documents using JSON syntax.

Have some feedback or feature suggesitons?

Please share your thoughts at Firestore Feature Request and I will review those requests to make the extension better over time.

Liked this extension?

Buy me a coffee!

Be careful: this is not an official Firebase product. This extension relies on the Firebase Admin SDK and its usage will generate reads and writes that may impact your Firebase billing.

Demo Video

How to use

To use this extension you will need to generate a Firebase service account from your Firebase console, as explained in the Firebase Admin SDK documentation.

Provide a path to the service account JSON file in the serviceAccountKeyPath setting. You can also use the "Firestore Studio: Initialize" command from the Command Palette to quickly reach the setting field.

Features

After configuring the extension with your service account, open the Firestore Studio View in the activity bar to:

  • navigate all the collections and documents of your project (items will be loaded only when needed and paged to minimize the number of API requests);

  • sort documents in a collection by a specified field and direction;

  • view and edit the content of any document as a simple JSON file, taking advantage of the full power of vscode editor. Just save the file it to immediately update the document in the database.

  • view documents in paginated manner in a tabular format and search documents using keywords.

  • export documents in json format.

  • create new documents and delete existing documents.

Extension Settings

  • serviceAccountKeyPath: path to the service account JSON file
  • projectId: the project ID of your Firebase project

Known Issues

  • Special field types such as geopoint and timestamp are not correctly handled due to the JSON conversion.

About

A simple Visual Studio Code Extension for listing, viewing and editing Firebase Firestore Database collections and documents using JSON syntax

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 96.2%
  • JavaScript 3.8%