Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Document naming for schema migrations.

This commit is contained in:
Tim Abbott 2017-07-10 16:02:19 -07:00
parent c493a0f02a
commit 4e2b5bf200
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/schema-migrations.md
View File

@ -8,6 +8,15 @@ tutorial](new-feature-tutorial.html).
This page documents some important issues related to writing schema
migrations.
* **Naming**: Please provide clear names for new database migrations
(e.g. `0072_realmauditlog_add_index_event_time.py`). Since in the
Django migrations system, the filename is the name for the
migration, this just means moving the migration file to have a
reasonable name. Note that `tools/test-migrations` will fail in
Travis CI if a migration has bad name of the form
`0089_auto_20170710_1353.py`, which are what Django generates
automatically for nontrivial database schema changes.
* **Large tables**: For large tables like Message and UserMessage, you
want to take precautions when adding columns to the table,
performing data backfills, or building indexes. We have a