Web Frameworks

This page serves a reference guide for common tasks within web frameworks. Squawk doesn't have special support for Django or any other web ORM. This page is merely a guide.

Django ORM

Django can auto generate schema changes, but many times the generated SQL won't pass Squawk's rules. These custom database backends for zero downtime migrations might work for your use case:

making a field non-nullable

In the Django ORM, making a nullable field non-nullable requires care to make the change safe.

This example shows how to make a nullable boolean field a non-nullable field.

# before
class Post(Model):
    published = models.BooleanField(null=True)

# after
class Post(Model):
    published = models.BooleanField(null=False, default=False)

migration steps

We cannot use the auto generated SQL from Django's migration system. We must use django.db.migrations.operations.SeparateDatabaseAndState to make changes to our Django models while using custom SQL.

Update the model with a default so newly created objects in Django get assigned a default value. This change must be deployed before making the SQL migrations.
```
class Post(Model):
    published = models.BooleanField(default=False)
```

Create trigger to set default value false for inserts published is null.

create function null_published_trigger() returns trigger
  as '
BEGIN
IF NEW.published IS NULL THEN
    NEW.published := false;
END IF;
RETURN NEW;
END'
  language 'plpgsql';

create trigger published_default_trigger
  before insert
  on post
  for each row
  execute procedure null_published_trigger();

Set a default value for existing objects.

update post set published = false where published is null;

Create a not null constraint.

alter table post
  add constraint published_not_null check (published is not null) not valid;

Validate constraint.

alter table post validate constraint published_not_null;

Remove trigger.

drop trigger if exists published_default_trigger on post;
drop function if exists null_published_trigger;

Alembic and SQLAlchemy

usage

alembic upgrade head --sql | squawk

or you can choose revisions

alembic upgrade first_revision:last_revision --sql | squawk

settings

Use transaction_per_migration = True in configure

# env.py
...
context.configure(
   ...
   transaction_per_migration=True
   ...
)
...

Set lock_timeout and statement_timeout

# env.py
...
def run_migrations_online() -> None:
    """Run migrations in 'online' mode.
    In this scenario we need to create an Engine
    and associate a connection with the context.
    """
    connectable = engine_from_config(
        config.get_section(config.config_ini_section),
        prefix="sqlalchemy.",
        poolclass=pool.NullPool,
        connect_args={'options': '-c lock_timeout=4000 -c statement_timeout=5000'}
    )
...

Django ORM​

making a field non-nullable​

migration steps​

Alembic and SQLAlchemy​

usage​

settings​