From c73aa444e139ce391b885397a02e67aa2823f131 Mon Sep 17 00:00:00 2001 From: reeb Date: Sat, 23 May 2026 21:37:57 +0300 Subject: [PATCH] RDoc-3839 - Document local temp-file behavior during remote-source restore --- docs/backup/configuration.mdx | 4 ++++ docs/backup/restore.mdx | 15 +++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/docs/backup/configuration.mdx b/docs/backup/configuration.mdx index d5e97bb55b..230988118d 100644 --- a/docs/backup/configuration.mdx +++ b/docs/backup/configuration.mdx @@ -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) - **Type**: `string` diff --git a/docs/backup/restore.mdx b/docs/backup/restore.mdx index 66a26e5331..8a78814d42 100644 --- a/docs/backup/restore.mdx +++ b/docs/backup/restore.mdx @@ -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) + + +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`. + + + **Example: Restore from S3** ```csharp var restoreConfigS3 = new RestoreFromS3Configuration