Documentation about database upgrade
This commit is contained in:
parent
41ee6df887
commit
9ec8077be1
@ -18,7 +18,9 @@ This page helps you navigate the documentation of BrickTracker.
|
|||||||
## Specific procedures
|
## Specific procedures
|
||||||
|
|
||||||
- [Setup lightweight authentication](authentication.md)
|
- [Setup lightweight authentication](authentication.md)
|
||||||
|
- Database
|
||||||
- [Move an existing ./app.db database](move-existing-database.md)
|
- [Move an existing ./app.db database](move-existing-database.md)
|
||||||
|
- [Upgrade your database](upgrade-database.md)
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
# Common errors/problems
|
# Common errors/problems
|
||||||
|
|
||||||
> **Note**
|
> **Note**
|
||||||
> The following page is based on version `1.0.0` of BrickTracker.
|
> The following page is based on version `1.1.0` of BrickTracker.
|
||||||
|
|
||||||
## I need a password to access some pages
|
## I need a password to access some pages
|
||||||
|
|
||||||
@ -46,3 +46,9 @@ Make sure that the folder exists, and if it exists that it is writable by the ap
|
|||||||
|
|
||||||
Either the theme is too recent for your version of the themes file, or your theme file has not be initialized.
|
Either the theme is too recent for your version of the themes file, or your theme file has not be initialized.
|
||||||
Head to the **Admin** page, **Themes** section and update the file.
|
Head to the **Admin** page, **Themes** section and update the file.
|
||||||
|
|
||||||
|
## Your database need to be upgraded from version <current> to version <required>.
|
||||||
|
|
||||||
|
![](images/common-errors-05.png)
|
||||||
|
|
||||||
|
A database schema modification was necessary to implement new features and the database need to be upgraded from the **Admin** page. See [upgrade your database](upgrade-database.md) for more information.
|
||||||
|
BIN
docs/images/common-errors-05.png
Normal file
BIN
docs/images/common-errors-05.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 46 KiB |
BIN
docs/images/upgrade-database-01.png
Normal file
BIN
docs/images/upgrade-database-01.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 56 KiB |
BIN
docs/images/upgrade-database-02.png
Normal file
BIN
docs/images/upgrade-database-02.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 18 KiB |
BIN
docs/images/upgrade-database-03.png
Normal file
BIN
docs/images/upgrade-database-03.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 109 KiB |
BIN
docs/images/upgrade-database-04.png
Normal file
BIN
docs/images/upgrade-database-04.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 60 KiB |
34
docs/upgrade-database.md
Normal file
34
docs/upgrade-database.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
# Upgrade your database
|
||||||
|
|
||||||
|
Sometimes, it is necessary to perform structural changes to the database to implement new features.
|
||||||
|
A built-in tool is in charge of this task, however it is not automatic (because is rare case it can lead to unexpected results.)
|
||||||
|
|
||||||
|
To perform a database upgrade, you need to navigate to the **Admin page**.
|
||||||
|
|
||||||
|
![](images/upgrade-database-01.png)
|
||||||
|
|
||||||
|
## Backup your data
|
||||||
|
|
||||||
|
> **Warning**
|
||||||
|
> Even if the migration steps are crafted so that your data is preserved, there can be unexpected results.
|
||||||
|
> **ALWAYS BACKUP YOUR DATA BEFORE PROCEEDING WITH A MIGRATION**.
|
||||||
|
|
||||||
|
To back up your data, use the **Download the database file** button. It will download a copy of the database file to your disk.
|
||||||
|
The file will be named: `<name>-v<version>-year-month-day-hours-minutes-secondes.db`.
|
||||||
|
|
||||||
|
### Restore a backup
|
||||||
|
|
||||||
|
In case of a problem, you can always use the **Import a database file** button in the **Database danger zone**.
|
||||||
|
|
||||||
|
![](images/upgrade-database-02.png)
|
||||||
|
|
||||||
|
## Perform the upgrade
|
||||||
|
|
||||||
|
The upgrade procedure is automated, you simply need to start it. Press the **Upgrade the database** button to see the planned list of changes.
|
||||||
|
|
||||||
|
![](images/upgrade-database-03.png)
|
||||||
|
|
||||||
|
Confirm by pressing the **Upgrade the database** button once more.
|
||||||
|
Once the upgrade is done you wil be back to the **Admin page**. You can see that your database file is at the required version.
|
||||||
|
|
||||||
|
![](images/upgrade-database-04.png)
|
Loading…
Reference in New Issue
Block a user