Restore Develop
Restore takes a Develop environment back to the configs another environment holds, or to the configs it held itself on a chosen date.
When to use it
Use Restore when work in Develop needs to be wound back to a known good state, for example:
Develop has drifted from Production and you want it to match again before starting new work.
A change was made across several configs and needs undoing as a set.
You want Develop to look the way it did before a particular day's work.
What a restore does
A restore only ever writes configs. It never deletes one. A config that exists in Develop but that the restore point knows nothing about is listed as No restore point and left exactly as it is.
Version Numbers decides what happens to the version number a restored config carries. Nothing is removed from the config history either way, so a restore can itself be undone by restoring again.
Version Numbers | What happens |
|---|---|
Save as a new version | The config is saved above whatever Develop holds now. If Develop holds v12 of a stage and you restore the content of v7, Develop ends up with v13 holding v7's content. |
Roll the version number back | The config goes back to the version number it is restored to. Develop holding v12 and restoring v7 leaves the stage on v7. |
Each restore is recorded alongside deployments on the Deployed Packages page, with a snapshot of Develop as it stood beforehand.
Choosing what to restore to
Restore from | What each config goes back to |
|---|---|
From another environment | The version that environment holds right now. Usually Production. |
At a date and time | The version Develop itself held at that moment, read from config history. |
A point in time restore reaches back only as far as config history holds the stored config. Anything older is listed under Could Not Be Read and skipped.
How to run a restore
In Bragi, open the Packages menu and select Restore Develop.
Choose the Develop Environment being restored. Only Develop environments can be written to.
Choose whether to restore From another environment or At a date and time, then pick the source environment, or the date and time.
Choose Version Numbers: whether restored configs are saved as a new version or put back on the version number they came from. You can change this after building the plan; the rows update to say what it will now do.
Click Build Restore Plan.
Review the list. Each row shows what Develop holds now, the version it will go back to, and the version number it will be saved as.
Adjust anything you need to:
Untick Include? to leave a config out of the restore.
Change Restore To to pick a different version for that one config. The list holds every version config history has for it, newest first, labelled with its number, the date it was saved and who saved it. Hand-picked rows get an undo button to put them back to the version the restore point chose.
Check the Dependency Issues panel if it appears. It warns when a config you have included needs another one that you have left out, and when a file group is missing on the Develop environment.
Click Restore and confirm.
If the restore changes Archives structurally, you may be prompted to run manual SQL scripts.
Read What Was Restored. Every Config the restore was given has a row saying whether it was written or not, and why if it was not.
Reading the result
Configs are written one at a time, and a failure moves on to the next rather than stopping the restore, so a restore can work for most of what it was given and still fail for some of it. Configs Restored reads n of m when the two differ, and the result table says which rows were which:
Status | Meaning |
|---|---|
Added | Re-created in Develop, which no longer held it. |
Updated | Written over the Config Develop held. |
Failed | Not written. The words on the row say why. |
Not attempted | The restore stopped before reaching it, so it is untouched. |
Nothing is rolled back when a row fails. The Configs that were restored stay restored, and the restore is recorded on the Deployed Packages page either way.
Row states
State | Shown by | Meaning |
|---|---|---|
Will be updated | Show Changed Items | Develop holds a different version; it will be written over. |
Unchanged | Show Unchanged Items | Develop is already on the restore point version, so there is nothing to do. |
Will be added | Show New Items | The config is not in Develop any more and will be put back. |
No restore point | Show Items With No Restore Point | Nothing to restore to. The config is left untouched. |
These are the words the Compare page uses for the same four questions, so a row reads the same way here as it does there. What a restore does to a row on top of that - which version it goes back to, and whether the version number moves forwards or back - is in the row's own words.