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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
=============================
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(), ...]
The operation skips adding the extension if it already exists.
For most extensions, this requires a database user with superuser privileges.
If the Django database user doesn't have the appropriate privileges, you'll
have to create the extension outside of Django migrations with a user that has
them. 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, hints=None)
An ``Operation`` subclass which installs a PostgreSQL extension. For common
extensions, use one of the more specific subclasses below.
.. attribute:: name
This is a required argument. The name of the extension to be installed.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``BloomExtension``
==================
.. class:: BloomExtension(hints=None)
Installs the ``bloom`` extension.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``BtreeGinExtension``
=====================
.. class:: BtreeGinExtension(hints=None)
Installs the ``btree_gin`` extension.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``BtreeGistExtension``
======================
.. class:: BtreeGistExtension(hints=None)
Installs the ``btree_gist`` extension.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``CITextExtension``
===================
.. class:: CITextExtension(hints=None)
Installs the ``citext`` extension.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``CryptoExtension``
===================
.. class:: CryptoExtension(hints=None)
Installs the ``pgcrypto`` extension.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``HStoreExtension``
===================
.. class:: HStoreExtension(hints=None)
Installs the ``hstore`` extension and also sets up the connection to
interpret hstore data for possible use in subsequent migrations.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``TrigramExtension``
====================
.. class:: TrigramExtension(hints=None)
Installs the ``pg_trgm`` extension.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
``UnaccentExtension``
=====================
.. class:: UnaccentExtension(hints=None)
Installs the ``unaccent`` extension.
.. attribute:: hints
.. versionadded:: 6.0
The optional ``hints`` argument will be passed as ``**hints`` to the
:meth:`allow_migrate` method of database routers to assist them in
:ref:`making routing decisions <topics-db-multi-db-hints>`.
.. _manage-postgresql-collations:
Managing collations using migrations
====================================
If you need to filter or order a column using a particular collation that your
operating system provides but PostgreSQL does not, you can manage collations in
your database using a migration file. These collations can then be used with
the ``db_collation`` parameter on :class:`~django.db.models.CharField`,
:class:`~django.db.models.TextField`, and their subclasses.
For example, to create a collation for German phone book ordering::
from django.contrib.postgres.operations import CreateCollation
class Migration(migrations.Migration):
...
operations = [
CreateCollation(
"case_insensitive",
provider="icu",
locale="und-u-ks-level2",
deterministic=False,
),
...,
]
.. class:: CreateCollation(name, locale, *, provider='libc', deterministic=True)
Creates a collation with the given ``name``, ``locale`` and ``provider``.
Set the ``deterministic`` parameter to ``False`` to create a
non-deterministic collation, such as for case-insensitive filtering.
.. class:: RemoveCollation(name, locale, *, provider='libc', deterministic=True)
Removes the collations named ``name``.
When reversed this is creating a collation with the provided ``locale``,
``provider``, and ``deterministic`` arguments. Therefore, ``locale`` is
required to make this operation reversible.
Concurrent index operations
===========================
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>`).
Adding constraints without enforcing validation
===============================================
PostgreSQL supports the ``NOT VALID`` option with the ``ADD CONSTRAINT``
statement to add check constraints without enforcing validation on existing
rows. This option is useful if you want to skip the potentially lengthy scan of
the table to verify that all existing rows satisfy the constraint.
To validate check constraints created with the ``NOT VALID`` option at a later
point of time, use the
:class:`~django.contrib.postgres.operations.ValidateConstraint` operation.
See `the PostgreSQL documentation <https://www.postgresql.org/docs/current/
sql-altertable.html#SQL-ALTERTABLE-NOTES>`__ for more details.
.. class:: AddConstraintNotValid(model_name, constraint)
Like :class:`~django.db.migrations.operations.AddConstraint`, but avoids
validating the constraint on existing rows.
.. class:: ValidateConstraint(model_name, name)
Scans through the table and validates the given check constraint on
existing rows.
.. note::
``AddConstraintNotValid`` and ``ValidateConstraint`` operations should be
performed in two separate migrations. Performing both operations in the
same atomic migration has the same effect as
:class:`~django.db.migrations.operations.AddConstraint`, whereas performing
them in a single non-atomic migration, may leave your database in an
inconsistent state if the ``ValidateConstraint`` operation fails.
|
