Files
@ 35af0bd45bf3
Branch filter:
Location: kallithea/docs/dev/dbmigrations.rst - annotation
35af0bd45bf3
2.9 KiB
text/prs.fallenstein.rst
diff: drop per file ignore-whitespace and context - it didn't work and had conceptual issue (Issue #344)
Diffs are currently generated at the low level as one big diff between two vcs
resisions, provided global values for diff context size and flag for ignoring
whitespace. All files use the same flags. There is no way to actually compute
the full diff using these use per file flags, and no simple and efficient way
to add it.
The best option is thus to drop the failed attempt at making it per file, and
just rely on the simple global flags in the URL.
The links for changing whitespace and context is sometimes shown for the whole
"page", and sometimes next to the diff for one file. For now, keep showing the
link in these places, but make sure it navigates back to the FID of the section
where the link was clicked.
The implementation is completely rewritten and moved to a more appropriate
location in helpers.
With a more clean implementation, we also consistently use the simple getters
to extract values from the URL.
Diffs are currently generated at the low level as one big diff between two vcs
resisions, provided global values for diff context size and flag for ignoring
whitespace. All files use the same flags. There is no way to actually compute
the full diff using these use per file flags, and no simple and efficient way
to add it.
The best option is thus to drop the failed attempt at making it per file, and
just rely on the simple global flags in the URL.
The links for changing whitespace and context is sometimes shown for the whole
"page", and sometimes next to the diff for one file. For now, keep showing the
link in these places, but make sure it navigates back to the FID of the section
where the link was clicked.
The implementation is completely rewritten and moved to a more appropriate
location in helpers.
With a more clean implementation, we also consistently use the simple getters
to extract values from the URL.
9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 7784a1212471 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 3158cf0dafb7 0080ffd8aea0 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d 9fd64dd2617d | =======================
Database schema changes
=======================
Kallithea uses Alembic for :ref:`database migrations <upgrade_db>`
(upgrades and downgrades).
If you are developing a Kallithea feature that requires database schema
changes, you should make a matching Alembic database migration script:
1. :ref:`Create a Kallithea configuration and database <setup>` for testing
the migration script, or use existing ``development.ini`` setup.
Ensure that this database is up to date with the latest database
schema *before* the changes you're currently developing. (Do not
create the database while your new schema changes are applied.)
2. Create a separate throwaway configuration for iterating on the actual
database changes::
kallithea-cli config-create temp.ini
Edit the file to change database settings. SQLite is typically fine,
but make sure to change the path to e.g. ``temp.db``, to avoid
clobbering any existing database file.
3. Make your code changes (including database schema changes in ``db.py``).
4. After every database schema change, recreate the throwaway database
to test the changes::
rm temp.db
kallithea-cli db-create -c temp.ini --repos=/var/repos --user=doe --email doe@example.com --password=123456 --no-public-access --force-yes
kallithea-cli repo-scan -c temp.ini
5. Once satisfied with the schema changes, auto-generate a draft Alembic
script using the development database that has *not* been upgraded.
(The generated script will upgrade the database to match the code.)
::
alembic -c development.ini revision -m "area: add cool feature" --autogenerate
6. Edit the script to clean it up and fix any problems.
Note that for changes that simply add columns, it may be appropriate
to not remove them in the downgrade script (and instead do nothing),
to avoid the loss of data. Unknown columns will simply be ignored by
Kallithea versions predating your changes.
7. Run ``alembic -c development.ini upgrade head`` to apply changes to
the (non-throwaway) database, and test the upgrade script. Also test
downgrades.
The included ``development.ini`` has full SQL logging enabled. If
you're using another configuration file, you may want to enable it
by setting ``level = DEBUG`` in section ``[handler_console_sql]``.
The Alembic migration script should be committed in the same revision as
the database schema (``db.py``) changes.
See the `Alembic documentation`__ for more information, in particular
the tutorial and the section about auto-generating migration scripts.
.. __: http://alembic.zzzcomputing.com/en/latest/
Troubleshooting
---------------
* If ``alembic --autogenerate`` responds "Target database is not up to
date", you need to either first use Alembic to upgrade the database
to the most recent version (before your changes), or recreate the
database from scratch (without your schema changes applied).
|