Skip to content

Commit 287491d

Browse files
reeceyangConvex, Inc.
authored andcommitted
docs: add include storage option to cloud backup docs (#42938)
GitOrigin-RevId: 582f19e893bf5f88a7225a05c474b8588c8faed0
1 parent e53582a commit 287491d

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

npm-packages/docs/docs/database/backup-restore.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Convex supports Backup & Restore of data via the
1111

1212
# Backups
1313

14-
A backup is a consistent snapshot of your table data and file storage made at
15-
the time of your request.
14+
A backup is a consistent snapshot of your table data made at the time of your
15+
request. Backups can be configured to include file storage.
1616

1717
Take a manual backup by pressing the "Backup Now" button. This may take a few
1818
seconds to a few hours, depending on how much data is in your deployment.
@@ -27,7 +27,7 @@ functions, etc.) will not be included.
2727

2828
Schedule a periodic daily or weekly backup by checking the "Backup
2929
automatically" box. You can select what time of day / day of week to have the
30-
backup occur.
30+
backup occur and whether to include file storage or not.
3131

3232
Daily backups are stored for 7 days. Weekly backups are stored for 14 days.
3333

@@ -45,6 +45,10 @@ Note that restoring is a destructive operation that wipes your existing data and
4545
replaces it with that from the backup. It's recommended that you generate an
4646
additional backup before doing a restore.
4747

48+
Existing files in the deployment will not be deleted when restoring from a
49+
backup, but any files in the backup that do not currently exist in the
50+
deployment will be uploaded to the deployment.
51+
4852
### Restoring in an emergency
4953

5054
If your production deployment ends up in a bad state, you may want to consider
@@ -79,8 +83,8 @@ The ZIP file's name has the format `snapshot_{ts}.zip` where `ts` is a UNIX
7983
timestamp of the snapshot in nanoseconds. The export ZIP file contains documents
8084
for each table at `<table_name>/documents.jsonl`, with one document per line.
8185

82-
Exported ZIP files also contain data from [file storage](/file-storage) in a
83-
`_storage` folder, with metadata like IDs and checksums in
86+
Exported ZIP files that include [file storage](/file-storage) will contain
87+
storage data in a `_storage` folder, with metadata like IDs and checksums in
8488
`_storage/documents.jsonl` and each file as `_storage/<id>`.
8589

8690
### Using the downloaded backup.

0 commit comments

Comments
 (0)