Skip to content

Commit

Permalink
document known data migration issue
Browse files Browse the repository at this point in the history
refs #164
  • Loading branch information
guruofgentoo committed Dec 8, 2022
1 parent 29c1dbd commit 23ec6fe
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/source/getting-started.rst
Expand Up @@ -286,6 +286,14 @@ responsibility.
If you are using a migration library like ``alembic``, you can autogenerate a migration
after upgrading Keg-Auth to ensure any model updates from mixins are included.

__Note__: autogenerated migrations solve most of the problems, but if you are starting with
an existing database that already has user records, you may have some data issues to resolve
as well. The following are known issues:

- Email field is expected to have all lowercase data. The model type assumes that because email
addresses are not case-sensitive, it can coerce input to lowercase for comparison, and expects
that persisted data matches that assumption.

.. _gs-navigation:

Navigation Helpers
Expand Down

0 comments on commit 23ec6fe

Please sign in to comment.