docs: Add --workdir flag documentation to restore sections
Enhanced documentation for --workdir flag: - Added to Cluster Restore command reference section - Added example to restore examples with clear "special case" comment - Explained use case: VMs with small system disk but large NFS mounts - Clarified it's NOT needed for standard deployments - Prevents confusion about when to use this flag
This commit is contained in:
20
README.md
20
README.md
@@ -536,6 +536,19 @@ Restore entire PostgreSQL cluster from archive:
|
|||||||
./dbbackup restore cluster ARCHIVE_FILE [OPTIONS]
|
./dbbackup restore cluster ARCHIVE_FILE [OPTIONS]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Special case - Limited system disk space:**
|
||||||
|
|
||||||
|
If your system disk (where PostgreSQL data resides) is small but you have large NFS mounts or additional partitions, use `--workdir` to extract on the larger storage:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Extract to alternative location with more space
|
||||||
|
./dbbackup restore cluster cluster_backup.tar.gz \
|
||||||
|
--workdir /u01/dba/restore_tmp \
|
||||||
|
--confirm
|
||||||
|
```
|
||||||
|
|
||||||
|
This prevents "insufficient disk space" errors on VMs with limited root partitions but large mounted storage.
|
||||||
|
|
||||||
### Verification & Maintenance
|
### Verification & Maintenance
|
||||||
|
|
||||||
#### Verify Backup Integrity
|
#### Verify Backup Integrity
|
||||||
@@ -664,8 +677,15 @@ sudo -u postgres ./dbbackup restore cluster cluster_backup.tar.gz \
|
|||||||
--confirm \
|
--confirm \
|
||||||
--jobs 16 \
|
--jobs 16 \
|
||||||
--verbose
|
--verbose
|
||||||
|
|
||||||
|
# Special case: Limited system disk space (use alternative extraction directory)
|
||||||
|
sudo -u postgres ./dbbackup restore cluster cluster_backup.tar.gz \
|
||||||
|
--workdir /u01/dba/restore_tmp \
|
||||||
|
--confirm
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Note:** The `--workdir` flag is only needed when your system disk is small but you have larger mounted storage (NFS, SAN, etc.). For standard deployments, it's not required.
|
||||||
|
|
||||||
**Safety Features:**
|
**Safety Features:**
|
||||||
|
|
||||||
- Archive integrity validation
|
- Archive integrity validation
|
||||||
|
|||||||
Reference in New Issue
Block a user