From 44a17d71554dbf1d58cbf2bf76fd972e71924f28 Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Tue, 21 Dec 2021 22:53:30 +0100 Subject: [PATCH] docs(migrations): Some documentation ++ --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 076169a..cca8833 100644 --- a/README.md +++ b/README.md @@ -31,16 +31,12 @@ or if you want to also run the tests: pip3 install --user ".[ldap,tests]" -You will also need a MySQL driver, recommended drivers are -- `mysqlclient` -- `PyMySQL` +You will also need a MySQL driver, by default one of this is installed: +- `mysqlclient` (non Windows) +- `PyMySQL` (on Windows) -`setup.py` will try to install a matching driver. - -#### Windows -Same as above, but if you want to use `mysqlclient` instead of `PyMySQL` (performance?) you have to follow this guide: - -https://www.radishlogic.com/coding/python-3/installing-mysqldb-for-python-3-in-windows/ +#### Hint on MySQL driver on Windows: +If you want to use `mysqlclient` instead of `PyMySQL` (performance?) you have to follow [this guide](https://www.radishlogic.com/coding/python-3/installing-mysqldb-for-python-3-in-windows/) ### Install database The user needs to have full permissions to the database. @@ -53,11 +49,12 @@ If not you need to create user and database manually do (or similar on Windows): echo "FLUSH PRIVILEGES;" ) | sudo mysql -Then you can install the database tables +Then you can install the database tables, this will update all tables from core + all enabled plugins. $ flaschengeist db upgrade heads -Or to only upgrade one plugin: +## Plugins +To only upgrade one plugin: $ flaschengeist db upgrade events@head