How to include PostgreSQL functions in Django migrations?

Question

I would like to include some PostgreSQL functions as part of the database migration.

The two ways I can see are:

The first seems easier, but laborious if the migration needs to be remade. What would you recommend the best way to go about it?

You shouldn't edit migrations created by makemigrations, usually. But nothing stops you from adding your own migration (see here) with your own RunSQL commands, which will just be run as any other migration. — dirkgroten
– dirkgroten, Commented Mar 5, 2019 at 16:21
Thanks both.@RemcoGerlich in case the model is modified -- is there a better way to do that? @dirkgroten TIL I'll give that a go! — E. Edwards
– E. Edwards, Commented Mar 5, 2019 at 16:36
If a model is modified a new migration will be made, the old file won't be modified. I agree that this should be put in a new migration. — Kevin Christopher Henry
– Kevin Christopher Henry, Commented Mar 5, 2019 at 21:36

E. Edwards · Accepted Answer · 2019-03-08 09:50:28Z

11

Answering my own question to clear up the question (thanks to all the comments):

First I made an empty migration (python manage.py makemigrations --empty app_name)

Then, to operations add the function's SQL:

migrations.RunSQL(
    ('CREATE OR REPLACE FUNCTION my_function() ...'),
    ('DROP FUNCTION IF EXISTS my_function();')
)

The custom migration will be run automatically after the main migrations.

answered Mar 8, 2019 at 9:50

E. Edwards

4185 silver badges13 bronze badges

Sign up to request clarification or add additional context in comments.

1 Answer 1