Generate Django Database Migrations

Commands

sentry django makemigrations

sentry django makemigrations <app_name>

sentry django makemigrations <app_name> --empty

After Generating

1. If you added a new model, ensure it's imported in the app's

   __init__.py

2. Review the generated migration for correctness
3. Run

   sentry django sqlmigrate <app_name> <migration_name>

   to verify the SQL

Guidelines

Adding Columns

• Use

  db_default=<value>

  instead of

  default=<value>

  for columns with defaults
• Nullable columns: use

  null=True

• Not null columns: must have

  db_default

  set

Adding Indexes

is_post_deployment = True

Deleting Columns

1. Make column nullable (

   null=True

   ) if not already
2. Remove all code references
3. Replace

   RemoveField

   with

   SafeRemoveField(..., deletion_action=DeletionAction.MOVE_TO_PENDING)

4. Deploy, then create second migration with

   SafeRemoveField(..., deletion_action=DeletionAction.DELETE)

Deleting Tables

1. Remove all code references
2. Replace

   DeleteModel

   with

   SafeDeleteModel(..., deletion_action=DeletionAction.MOVE_TO_PENDING)

3. Deploy, then create second migration with

   SafeDeleteModel(..., deletion_action=DeletionAction.DELETE)

Renaming Columns/Tables

db_column

Meta.db_table

Resolving Merge Conflicts

migrations_lockfile.txt

bin/update-migration <migration_name>