Skip to content

Commit 63d5932

Browse files
authored
correct incremental restore envvar (#642)
1 parent 5108fac commit 63d5932

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/incremental-mysql-backups-and-restores.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Incremental MySQL Backups and Restores
22

33
Customers who have large MySQL databases who wish to save storage space can use the `--incremental` flag with `ghe-backup` and `ghe-restore`.
4-
Using this flag performs backups for other parts of GHES as normal, but only performs a MySQL backup of the changes to the database from the previous snapshot.
4+
Using this flag performs backups for other parts of GHES as normal, but only performs a MySQL backup of the changes to the database from the previous snapshot.
55
For larger databases this can conserve a lot of storage space for backups.
66

77
## Configuring number of backups
88

9-
In your backup.config file you will need to set the variable `GHE_INCREMENTAL_BACKUP_MAX`.
9+
In your backup.config file you will need to set the variable `GHE_INCREMENTAL_MAX_BACKUPS`.
1010
This variable determines how many cycles of full and incremental backups will be performed before the next full backup is created.
11-
For example, if `GHE_INCREMENTAL_BACKUP_MAX` is set to 14, backup-utils will run 1 full backup and then 13 incremental backups before performing another full backup on the next cycle.
11+
For example, if `GHE_INCREMENTAL_MAX_BACKUPS` is set to 14, backup-utils will run 1 full backup and then 13 incremental backups before performing another full backup on the next cycle.
1212

1313
Incremental backups require the previous snapshot backups before them to work.
1414
This means they do not follow the pruning strategy based on `GHE_NUM_SNAPSHOTS`.
@@ -19,7 +19,7 @@ To perform incremental backups:
1919

2020
`bin/ghe-backup --incremental`
2121

22-
the program will detect whether it needs to performa full or incremental snapshot based on what is currently in `GHE_DATA_DIR`.
22+
the program will detect whether it needs to performa full or incremental snapshot based on what is currently in `GHE_DATA_DIR`.
2323

2424
To see what snapshots are part of your full and incremental backups, you can reference `GHE_DATA_DIR/inc_full_backup` and `GHE_DATA_DIR/inc_snapshot_data`, respectively.
2525

@@ -35,4 +35,4 @@ The program will use the MySQL folders from each previous incremental backup and
3535

3636
### Previous cycles
3737

38-
To ensure there is a rolling window of mySQL backups, incremental MySQL backups from the cycle before the current one are kept. Those snapshots are pre-pended with `inc_previous`. To perform a restore from there, just use the full directory name for the snapshot id.
38+
To ensure there is a rolling window of mySQL backups, incremental MySQL backups from the cycle before the current one are kept. Those snapshots are pre-pended with `inc_previous`. To perform a restore from there, just use the full directory name for the snapshot ID.

0 commit comments

Comments
 (0)