Skip to content

RDoc-3839 - Document local temp-file behavior during remote-source restore #2462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reebhub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

RDoc-3839 - Document local temp-file behavior during remote-source restore #2462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/backup/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Use this key to specify the local path where temporary backup files are stored.
- By default, temporary backup files are stored under the server Database directory (or under [Storage.TempPath](../server/configuration/storage-configuration.mdx) if set).
- If `Backup.TempPath` is set, temporary backup files will be stored under the path it specifies.
- If a backup task is configured to store backups in a local folder, `Backup.TempPath` will be ignored and temporary files will be stored alongside the backups.
- `Backup.TempPath` is also used when restoring a database from a remote destination
(Amazon S3, Azure Blob Storage, or Google Cloud Storage): the backup file is first
downloaded to `Backup.TempPath` and then read from there.
[Learn about restoring from a remote destination.](../backup/restore.mdx#restorebackupconfiguration---backup-location-settings)
</Admonition>

- **Type**: `string`
Expand Down
15 changes: 15 additions & 0 deletions docs/backup/restore.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,21 @@ Choose where to restore the backup from by using a restore configuration that ma

[See details in the syntax section.](../backup/restore#restore-configuration-classes)

<Admonition type="note" title="">

When restoring from a remote destination (Amazon S3, Azure Blob Storage, or Google Cloud
Storage), RavenDB downloads the backup file to local disk before reading the file.
The first defined path in this list is used for the download:

- [`Backup.TempPath`](../backup/configuration.mdx#backuptemppath)
- [`Storage.TempPath`](../server/configuration/storage-configuration.mdx#storagetemppath)
- The database directory

Before the download starts, RavenDB checks that the chosen path has enough free space.
If there is not enough space, the restore fails with a `DiskFullException`.

</Admonition>

**Example: Restore from S3**
```csharp
var restoreConfigS3 = new RestoreFromS3Configuration
Expand Down
Loading