summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2022-07-20 07:56:02 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-07-26 11:42:54 +0200
commit7e3c9c3205e9646261cea5e5a7af7ec0e806690a (patch)
treee1455db680a009ef187a7283c846fe1e75254cbd /docs
parent66f30dbf253f89a3803aebbcee2675ce3e186b00 (diff)
Refs #27236 -- Doc'd that AlterIndexTogether is no longer officially supported for Django 4.2+ migration files.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/migration-operations.txt14
-rw-r--r--docs/releases/4.2.txt7
2 files changed, 18 insertions, 3 deletions
diff --git a/docs/ref/migration-operations.txt b/docs/ref/migration-operations.txt
index f8bfc4fb6b..a223ff6a23 100644
--- a/docs/ref/migration-operations.txt
+++ b/docs/ref/migration-operations.txt
@@ -102,9 +102,17 @@ subclass).
.. class:: AlterIndexTogether(name, index_together)
-Changes the model's set of custom indexes (the
-:attr:`~django.db.models.Options.index_together` option on the ``Meta``
-subclass).
+Changes the model's set of custom indexes (the ``index_together`` option on the
+``Meta`` subclass).
+
+.. warning::
+
+ ``AlterIndexTogether`` is officially supported only for pre-Django 4.2
+ migration files. For backward compatibility reasons, it's still part of the
+ public API, and there's no plan to deprecate or remove it, but it should
+ not be used for new migrations. Use
+ :class:`~django.db.migrations.operations.AddIndex` and
+ :class:`~django.db.migrations.operations.RemoveIndex` operations instead.
``AlterOrderWithRespectTo``
---------------------------
diff --git a/docs/releases/4.2.txt b/docs/releases/4.2.txt
index 24458cfc86..078fc88193 100644
--- a/docs/releases/4.2.txt
+++ b/docs/releases/4.2.txt
@@ -310,6 +310,13 @@ Running the :djadmin:`makemigrations` command will generate a migration
containing a :class:`~django.db.migrations.operations.RenameIndex` operation
which will rename the existing index.
+The ``AlterIndexTogether`` migration operation is now officially supported only
+for pre-Django 4.2 migration files. For backward compatibility reasons, it's
+still part of the public API, and there's no plan to deprecate or remove it,
+but it should not be used for new migrations. Use
+:class:`~django.db.migrations.operations.AddIndex` and
+:class:`~django.db.migrations.operations.RemoveIndex` operations instead.
+
Miscellaneous
-------------