-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GitOrigin-RevId: 3cd61353c04c33c3a9230115f50e26a9a97dd62b
- Loading branch information
1 parent
2ad0ef4
commit efc23ce
Showing
5 changed files
with
109 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
--- | ||
title: "Backup & Restore" | ||
sidebar_position: 85 | ||
--- | ||
|
||
Convex supports Backup & Restore of data via the | ||
[dashboard](https://dashboard.convex.dev/deployment/settings/backups). | ||
|
||
![Backups Page](/screenshots/backups.png) | ||
|
||
# Backups | ||
|
||
A backup is a consistent snapshot of your table data and file storage made at | ||
the time of your request. | ||
|
||
Take a backup by pressing the "Backup Now" button. This may take a few seconds | ||
or a few minutes, depending on how much data is in your deployment. | ||
|
||
Backups are stored for 7 days. You can download or delete backups via this page. | ||
|
||
Deployment configuration and other data (code, environment variables, scheduled | ||
functions, etc.) will not be included. | ||
|
||
### Periodic Backups | ||
|
||
Schedule a periodic daily backup by checking the "Backup automatically" box. You | ||
can select what time of day to have the backup occur. | ||
|
||
<ProFeatureUpsell feature="Periodic backups" verb="require" /> | ||
|
||
### Restoring from backup | ||
|
||
Restore from a backup by selecting restore from the submenu of an individual. | ||
You can restore from backups in the same deployment or from other deployments on | ||
the same team by using the deployment selector on the backups page. Restores may | ||
take a few seconds to a few minutes depending on how much data is in your | ||
backup. | ||
|
||
Note that restoring is a destructive operation that wipes your existing data and | ||
replaces it with that from the backup. It's recommended that you generate an | ||
additional backup before doing a restore. | ||
|
||
# Downloading a backup | ||
|
||
You can download your manual and periodic backups from the dashboard via the | ||
download button in the menu. | ||
|
||
Alternatively, you can generate an export in the same format with the | ||
[command line](/docs/cli.md#export-data-to-a-file): | ||
|
||
```sh | ||
npx convex export --path ~/Downloads | ||
``` | ||
|
||
The backup comes as a generated a ZIP file with all documents in all Convex | ||
tables in your deployment. | ||
|
||
The ZIP file's name has the format `snapshot_{ts}.zip` where `ts` is a UNIX | ||
timestamp of the snapshot in nanoseconds. The export ZIP file contains documents | ||
for each table at `<table_name>/documents.jsonl`, with one document per line. | ||
|
||
Exported ZIP files also contain data from [file storage](/file-storage) in a | ||
`_storage` folder, with metadata like IDs and checksums in | ||
`_storage/documents.jsonl` and each file as `_storage/<id>`. | ||
|
||
### Using the downloaded backup. | ||
|
||
Downloaded ZIP files can be imported into the same deployment or a different | ||
deployment with the | ||
[CLI](/docs/database/import-export/import.mdx#import-data-from-a-snapshot-zip-file). | ||
|
||
## FAQ | ||
|
||
### Are there any limitations? | ||
|
||
Each backup is accessible for up to 7 days. | ||
|
||
On the Starter plan, only one backup is stored per deployment. Paid plan | ||
deployments can have many backups with standard usage based pricing. | ||
|
||
### How are they priced? | ||
|
||
Backups uses database bandwidth to read all documents, and file bandwidth to | ||
include user files. The generation and storage of the backup itself is billed | ||
with the same bandwidth and storage pricing as user file storage. You can | ||
observe this bandwidth and storage cost in the | ||
[usage dashboard](https://dashboard.convex.dev/team/settings/usage). Check the | ||
[limits docs](/production/state/limits#database) for pricing details. | ||
|
||
### What does the backup not contain? | ||
|
||
The backup only contains the documents for your tables and files in file | ||
storage. In particular it lacks: | ||
|
||
1. Your deployment's code and configuration. Convex functions, crons.ts, | ||
auth.config.js, schema.ts, etc. are configured in your source code. | ||
2. Pending scheduled functions. You can access pending scheduled functions in | ||
the [`_scheduled_functions`](/docs/database/advanced/system-tables.mdx) | ||
system table. | ||
3. Environment variables. Environment variables can be copied from Settings in | ||
the Convex dashboard. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.