How this extension works
Restore previously deleted Firestore documents with ease.
Imagine a Recycle Bin (Windows) or Bin (Mac) for your firestore documents. When you delete a firestore document (or an entire collection/subcollection of documents), the deleted document(s) will all safely be stored in a separate collection called
DeletedRecords (this is configurable) where you can see and most importantly, restore the document back into its original location.
View deleted documents:
To view deleted documents, head to the
DeletedRecords/DeletedRecords document. Deleted documents will all be stored in subcollections with the same path as the original document.
Note: To avoid conflicts on
.collectionGroup() queries, the extension appends
_archived to the end of all collection & subcollection names.
In order to restore a document back to its original location, simply find the document and set the
softDeletes.restored value from
true. The document will then be inserted at its original location.
Remove deleted documents:
Deleting documents contained within the
DeletedRecords collection will delete the document permenantly. If you wish to delete all previously deleted records, simply use the Firestore console to delete the
By default, this extension keeps a copy of every document in every collection when it is deleted. You can specify individual collections if you don’t want to retain deleted documents from every collection in your Firestore database. Note: you will need to add an instance of this extension for each collection if you choose to use this option.
This extension uses other Firebase or Google Cloud services which may have
* Cloud Firestore
* Cloud Functions
When you use Firebase Extensions, you’re only charged for the underlying
resources that you use. A paid-tier billing plan is only required if the
extension uses a service that requires a paid-tier plan, for example calling to
a Google Cloud API or making outbound network requests to non-Google services.
All Firebase services offer a no-cost tier of usage.
[Learn more about Firebase billing.](https://firebase.google.com/pricing)