comparison docs/dev/dbmigrations.rst @ 6554:2c3d30095d5e

gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack This is a step towards moving away from the Pylons stack to TurboGears2, but still independent of it. Some notes from the porting - it could perhaps be the missing(?) documentation for migrating from paster to gearbox: Note: 'gearbox' without parameters will crash - specify '-h' to get started testing. Replace paster summary = 'yada yada' with the first line of the docstring of the Command class ... or override get_description. Note: All newlines in the docstring will be collapsed and mangle the long help text. Grouping of commands is not possible. Standard commands (for development) can't be customized under the same name or hidden. (Like for paster, the conceptual model also assumes that the sub-command naming is namespaced so commands from other packages won't conflict.) The usage help is fully automated from the declared options. For all deprecated Commands, replace paster hidden = True with gearbox deprecated = True Note: config_file, takes_config_file, min_args and max_args are not available / relevant. The gearbox parser is customized by overriding get_parser - there is nothing like paster update_parser. Gearbox is using argparse instead of optparse ... but argparse add_argument is mostly backwards compatible with optparse add_option. Instead of overriding command or run as in paster, override take_action in gearbox. The parsed arguments are passed to take_action, not available on the command instance. Paster BadCommand is not available and must be handled manually, terminating with sys.exit(1). There is no standard make-config command in gearbox. Paster appinstall has been replaced by the somewhat different setup_app module in gearbox. There is still no clean way to pass parameters to SetupAppCommand and it relies on websetup and other apparently unnecessary complexity. Instead, implement setup-db from scratch. Minor change by Thomas De Schampheleire: add gearbox logging configuration. Because we use logging.config.fileConfig(.inifile) during gearbox command execution, the logging settings need to be correct and contain a block for gearbox logging itself. Otherwise, errors in command processing are not even visible and the command exits silently.
author Mads Kiilerich <madski@unity3d.com>
date Tue, 25 Oct 2016 21:32:24 +0200
parents 9fd64dd2617d
children 213085032127
comparison
equal deleted inserted replaced
6553:e9ac5698281d 6554:2c3d30095d5e
16 create the database while your new schema changes are applied.) 16 create the database while your new schema changes are applied.)
17 17
18 2. Create a separate throwaway configuration for iterating on the actual 18 2. Create a separate throwaway configuration for iterating on the actual
19 database changes:: 19 database changes::
20 20
21 paster make-config Kallithea temp.ini 21 TODO make-config Kallithea temp.ini
22 22
23 Edit the file to change database settings. SQLite is typically fine, 23 Edit the file to change database settings. SQLite is typically fine,
24 but make sure to change the path to e.g. ``temp.db``, to avoid 24 but make sure to change the path to e.g. ``temp.db``, to avoid
25 clobbering any existing database file. 25 clobbering any existing database file.
26 26
28 28
29 4. After every database schema change, recreate the throwaway database 29 4. After every database schema change, recreate the throwaway database
30 to test the changes:: 30 to test the changes::
31 31
32 rm temp.db 32 rm temp.db
33 paster setup-db temp.ini --repos=/var/repos --user=doe --email doe@example.com --password=123456 --no-public-access --force-yes 33 gearbox setup-db -c temp.ini --repos=/var/repos --user=doe --email doe@example.com --password=123456 --no-public-access --force-yes
34 paster repo-scan temp.ini 34 gearbox repo-scan -c temp.ini
35 35
36 5. Once satisfied with the schema changes, auto-generate a draft Alembic 36 5. Once satisfied with the schema changes, auto-generate a draft Alembic
37 script using the development database that has *not* been upgraded. 37 script using the development database that has *not* been upgraded.
38 (The generated script will upgrade the database to match the code.) 38 (The generated script will upgrade the database to match the code.)
39 39