blob: 1329ff1f9eab7e158f439251ec2a21e5c0f4c323 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
=============================
Database migration operations
=============================
All of these :doc:`operations </ref/migration-operations>` are available from
the ``django.contrib.postgres.operations`` module.
.. _create-postgresql-extensions:
Creating extension using migrations
===================================
You can create a PostgreSQL extension in your database using a migration file.
This example creates an hstore extension, but the same principles apply for
other extensions.
Set up the hstore extension in PostgreSQL before the first ``CreateModel``
or ``AddField`` operation that involves
:class:`~django.contrib.postgres.fields.HStoreField` by adding a migration with
the :class:`~django.contrib.postgres.operations.HStoreExtension` operation.
For example::
from django.contrib.postgres.operations import HStoreExtension
class Migration(migrations.Migration):
...
operations = [
HStoreExtension(),
...
]
Creating the extension requires a database user with superuser privileges.
If the Django database user doesn't have superuser privileges, you'll have
to create the extension outside of Django migrations with a user that has
the appropriate privileges. In that case, connect to your Django database and
run the query ``CREATE EXTENSION IF NOT EXISTS hstore;``.
.. currentmodule:: django.contrib.postgres.operations
``CreateExtension``
===================
.. class:: CreateExtension(name)
An ``Operation`` subclass which installs PostgreSQL extensions.
.. attribute:: name
This is a required argument. The name of the extension to be installed.
``BtreeGinExtension``
=====================
.. class:: BtreeGinExtension()
Install the ``btree_gin`` extension.
``BtreeGistExtension``
======================
.. class:: BtreeGistExtension()
Install the ``btree_gist`` extension.
``CITextExtension``
===================
.. class:: CITextExtension()
Installs the ``citext`` extension.
``CryptoExtension``
===================
.. class:: CryptoExtension()
Installs the ``pgcrypto`` extension.
``HStoreExtension``
===================
.. class:: HStoreExtension()
Installs the ``hstore`` extension and also sets up the connection to
interpret hstore data for possible use in subsequent migrations.
``TrigramExtension``
====================
.. class:: TrigramExtension()
Installs the ``pg_trgm`` extension.
``UnaccentExtension``
=====================
.. class:: UnaccentExtension()
Installs the ``unaccent`` extension.
Index concurrent operations
===========================
.. versionadded:: 3.0
PostgreSQL supports the ``CONCURRENTLY`` option to ``CREATE INDEX`` and
``DROP INDEX`` statements to add and remove indexes without locking out writes.
This option is useful for adding or removing an index in a live production
database.
.. class:: AddIndexConcurrently(model_name, index)
Like :class:`~django.db.migrations.operations.AddIndex`, but creates an
index with the ``CONCURRENTLY`` option. This has a few caveats to be aware
of when using this option, see `the PostgreSQL documentation of building
indexes concurrently <https://www.postgresql.org/docs/current/
sql-createindex.html#SQL-CREATEINDEX-CONCURRENTLY>`_.
.. class:: RemoveIndexConcurrently(model_name, name)
Like :class:`~django.db.migrations.operations.RemoveIndex`, but removes the
index with the ``CONCURRENTLY`` option. This has a few caveats to be aware
of when using this option, see `the PostgreSQL documentation
<https://www.postgresql.org/docs/current/sql-dropindex.html>`_.
.. note::
The ``CONCURRENTLY`` option is not supported inside a transaction (see
:ref:`non-atomic migration <non-atomic-migrations>`).
|
