You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,9 @@ Engine to Backup, Clean, Restore. Work for Firebase.Firestore, Firebase.Storage,
22
22
| path | p | Path to service account JSON file |
23
23
| services | s | firestore (f), storage (s), auth (a), can be separated by commas. Default: all |
24
24
| backup | b | Path to backup or restore file. Default: ./{$PROJECT_ID + $TIMESTAMP}.backup |
25
-
| --nocompress | -nc | Do not use data compression |
26
25
| collections | coll | Apply to Collections (in Firestore service). Default: all, if it is not set |
27
26
| buckets | buck | Apply to Buckets (in Storage service). Default: all, if it is not set |
27
+
| --nocompress | -nc | Do not use data compression |
28
28
29
29
- collections - the rule also applies to all nested collections and documents
30
30
@@ -84,6 +84,13 @@ Or from the FIREBASE project
84
84
85
85
Firebase API also returns the passwordSalt and passwordHash hashed by the Firebase Auth backend for password users if the user/service account used to generate the request OAuth access token has the firebaseauth.configs.getHashConfig permission. Otherwise the passwordHash and passwordSalt will not be set.
86
86
[Open official firebase docs](https://firebase.google.com/docs/auth/admin/manage-users#password_hashes_of_listed_users)
87
+
88
+
### WARNING (restoration of subcollections)
89
+
I recommend using only the top collection level in the collections parameter. Because you can get shadow document by restoring a subcollection in a non-existent document.
90
+
To a full database cleanup, including shadow documents, use the command in firebase tools
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/jobs/backup/auth.ts#L23">jobs/backup/auth.ts:23</a></li>
193
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/jobs/backup/auth.ts#L23">jobs/backup/auth.ts:23</a></li>
194
194
</ul>
195
195
</aside>
196
196
<divclass="tsd-comment tsd-typography">
@@ -206,7 +206,7 @@ <h3>counter</h3>
206
206
<asideclass="tsd-sources">
207
207
<p>Inherited from <ahref="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<ahref="_utils_template_.joboneservicetemplate.html#counter">counter</a></p>
208
208
<ul>
209
-
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/utils/template.ts#L89">utils/template.ts:89</a></li>
209
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/utils/template.ts#L89">utils/template.ts:89</a></li>
210
210
</ul>
211
211
</aside>
212
212
<divclass="tsd-comment tsd-typography">
@@ -222,7 +222,7 @@ <h3>settings</h3>
222
222
<asideclass="tsd-sources">
223
223
<p>Inherited from <ahref="_utils_template_.jobtemplate.html">JobTemplate</a>.<ahref="_utils_template_.jobtemplate.html#settings">settings</a></p>
224
224
<ul>
225
-
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/utils/template.ts#L27">utils/template.ts:27</a></li>
225
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/utils/template.ts#L27">utils/template.ts:27</a></li>
226
226
</ul>
227
227
</aside>
228
228
<divclass="tsd-comment tsd-typography">
@@ -238,7 +238,7 @@ <h3>start<wbr>Timestamp</h3>
238
238
<asideclass="tsd-sources">
239
239
<p>Inherited from <ahref="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<ahref="_utils_template_.joboneservicetemplate.html#starttimestamp">startTimestamp</a></p>
240
240
<ul>
241
-
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/utils/template.ts#L104">utils/template.ts:104</a></li>
241
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/utils/template.ts#L104">utils/template.ts:104</a></li>
242
242
</ul>
243
243
</aside>
244
244
<divclass="tsd-comment tsd-typography">
@@ -254,7 +254,7 @@ <h3>store</h3>
254
254
<asideclass="tsd-sources">
255
255
<p>Inherited from <ahref="_utils_template_.jobtemplate.html">JobTemplate</a>.<ahref="_utils_template_.jobtemplate.html#store">store</a></p>
256
256
<ul>
257
-
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/utils/template.ts#L35">utils/template.ts:35</a></li>
257
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/utils/template.ts#L35">utils/template.ts:35</a></li>
<p>Inherited from <ahref="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<ahref="_utils_template_.jobbackupservicetemplate.html#stringiferstream">stringiferStream</a></p>
272
272
<ul>
273
-
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/utils/template.ts#L138">utils/template.ts:138</a></li>
273
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/utils/template.ts#L138">utils/template.ts:138</a></li>
274
274
</ul>
275
275
</aside>
276
276
<divclass="tsd-comment tsd-typography">
@@ -286,7 +286,7 @@ <h3>writer</h3>
286
286
<asideclass="tsd-sources">
287
287
<p>Inherited from <ahref="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<ahref="_utils_template_.jobbackupservicetemplate.html#writer">writer</a></p>
288
288
<ul>
289
-
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/utils/template.ts#L134">utils/template.ts:134</a></li>
289
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/utils/template.ts#L134">utils/template.ts:134</a></li>
<p>Inherited from <ahref="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<ahref="_utils_template_.joboneservicetemplate.html#getworktime">getWorkTime</a></p>
311
311
<ul>
312
-
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/f877f1e/src/utils/template.ts#L93">utils/template.ts:93</a></li>
312
+
<li>Defined in <ahref="https://github.com/siarheidudko/firebase-engine/blob/300cf65/src/utils/template.ts#L93">utils/template.ts:93</a></li>
0 commit comments