[Django] #27236: Deprecate Model.Meta.index_together in favour of Model.Meta.indexes
Django
-------------------------------------+-------------------------------------
Reporter: akki | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Database layer | Version:
(models, ORM) | Keywords: db-indexes
Severity: Normal | index_together
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Anything that `index_together` does can be done by `indexes` and the
`Index` class.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Reporter: akki | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Database layer | Version:
(models, ORM) |
Keywords: db-indexes | Triage Stage:
index_together | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Comment:
This ticket tracks a sub-part of this deprecation process -
https://code.djangoproject.com/ticket/27064
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:1>
Django
-------------------------------------+-------------------------------------
Reporter: akki | Owner: nobody
Type: | Status: new
Cleanup/optimization |
(models, ORM) |
Severity: Normal | Resolution:
index_together |
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* version: => master
* stage: Unreviewed => Accepted
Comment:
My understanding is that we're keeping the `AlterIndexTogether` migration
operation around indefinitely for support in historical migrations. Are
there any other details from our conversations to add?
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:2>
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* keywords: db-indexes index_together =>
Comment:
Yes, since `AlterIndexTogether` is currently there in the migrations of so
many Django projects we need to keep maintaining it. But the idea is to
deprecate the use of `index_together` in the models file and the
`generate_altered_index_together` method of the `MigrationAutodetector`.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:3>
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* keywords: => index_together
Comment:
Changed the keywords by mistake.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:4>
Django
-------------------------------------+-------------------------------------
Type: | Tabone
Cleanup/optimization | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: nobody => Olivier Tabone
* status: new => assigned
* cc: olivier.tabone@… (added)
Comment:
working on this ticket during duth sprint
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:5>
Django
-------------------------------------+-------------------------------------
Type: | Tabone
Cleanup/optimization | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Olivier Tabone):
see [https://github.com/django/django/pull/7509]
any comment appreciated
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:6>
Django
-------------------------------------+-------------------------------------
Type: | Tabone
Cleanup/optimization | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:7>
Django
-------------------------------------+-------------------------------------
Type: | Tabone
Cleanup/optimization | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
Comment:
I left comments for improvement.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:8>
Django
-------------------------------------+-------------------------------------
Type: | Tabone
Cleanup/optimization | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
-------------------------------------+-------------------------------------
Comment (by Markus Holtermann):
While this is the one step of the deprecation process of `index_together`
there is currently no way to migrate an existing from `index_together` to
`indexes` w/o dropping and recreating indexes. Since removing and adding
an index can be a quite expensive operation, this is not an option to do
so for now.
The next step in the deprecation process needs to treat `indexes` and
`index_together` similarly in the sense that the latter is translated into
the former internally (inside the migration framework). Once this is done,
the deprecation of actually using `index_together` can start.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:9>
Django
-------------------------------------+-------------------------------------
Type: | Tabone
Cleanup/optimization | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
-------------------------------------+-------------------------------------
Comment (by Olivier Tabone):
Hi Markus, Thank you for your reply.
Are you referring to #27064 ? or is it something different ?
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:10>
Django
-------------------------------------+-------------------------------------
Type: | Tabone
Cleanup/optimization | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
-------------------------------------+-------------------------------------
Comment (by Tim Graham):
I think that's the correct ticket.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:11>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
-------------------------------------+-------------------------------------
* cc: David Wobrock (added)
* owner: Olivier Tabone => David Wobrock
Comment:
Since https://code.djangoproject.com/ticket/27064 is done, I'll try to
tackle this issue.
Here is a new [https://github.com/django/django/pull/15703 PR] based a bit
off the previous one.
I changed the assignee, since it was set about 6 years ago :)
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:12>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:13>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
* needs_docs: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:14>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
* needs_docs: 1 => 0
Comment:
Here we go again! With 3 PRs:
[https://github.com/django/django/pull/15703 The main PR]
[https://github.com/django/django/pull/15754 Inlining test classes]
[https://github.com/django/django/pull/15755 Splitting index/unique
together autodetector tests]
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:15>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"a3a1290d47326c3f87824b3cf7ca969cb0d364aa" a3a1290d]:
{{{
#!CommitTicketReference repository=""
revision="a3a1290d47326c3f87824b3cf7ca969cb0d364aa"
Refs #27236 -- Moved models with Meta.index_together inside of test
methods.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:16>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"db588d4f0edde5095f8975be1da4e693268b86b3" db588d4f]:
{{{
#!CommitTicketReference repository=""
revision="db588d4f0edde5095f8975be1da4e693268b86b3"
Refs #27236 -- Split index_together and unique_together autodetector
tests.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:18>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"457cfd6f393511a207e3400184ff03813818afa5" 457cfd6f]:
{{{
#!CommitTicketReference repository=""
revision="457cfd6f393511a207e3400184ff03813818afa5"
Refs #27236 -- Added test_autodetector.BaseAutodetectorTests.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:17>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:19>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:20>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"57793b47657ace966ce8ce96d801ac0d85e5efc6" 57793b47]:
{{{
#!CommitTicketReference repository=""
revision="57793b47657ace966ce8ce96d801ac0d85e5efc6"
Refs #27236 -- Refactored out DeprecationForHistoricalMigrationMixin.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:21>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"41019e48bbf082c985e6ba3bad34d118b903bff1" 41019e48]:
{{{
#!CommitTicketReference repository=""
revision="41019e48bbf082c985e6ba3bad34d118b903bff1"
Refs #27236 -- Added generic mechanism to handle the deprecation of
migration operations.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:22>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"f8f16b3cd85599b464cbc5c7e884387940c24e6f" f8f16b3c]:
{{{
#!CommitTicketReference repository=""
revision="f8f16b3cd85599b464cbc5c7e884387940c24e6f"
Refs #27236 -- Removed usage of Meta.index_together from
indexes/introspection test models.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:23>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"4f284115a9181990f713d5167b25628fa171a5e4" 4f284115]:
{{{
#!CommitTicketReference repository=""
revision="4f284115a9181990f713d5167b25628fa171a5e4"
Refs #27236 -- Split RenameField() tests with unique/index_together.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:24>
Django
-------------------------------------+-------------------------------------
Type: | Wobrock
Cleanup/optimization | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:25>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Component: Database layer | Version: dev
(models, ORM) |
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"a6385b382e05a614a99e5a5913d8e631823159a2" a6385b3]:
{{{
#!CommitTicketReference repository=""
revision="a6385b382e05a614a99e5a5913d8e631823159a2"
Fixed #27236 -- Deprecated Meta.index_together in favor of Meta.indexes.
This also deprecates AlterIndexTogether migration operation.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:26>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Collin Anderson):
I'm getting system check error: "AlterIndexTogether is deprecated. Support
for it (except in historical migrations) will be removed in Django 5.1.",
even though it's only used in historical migrations. Is there something
I'm supposed to do? Or why give a warning if I don't need to take any
action? Is there any way to clarify this? (Same with release notes
deprecation section, very unclear what action I'm supposed to take.)
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:27>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Simon Charette):
I think you'll want to squash the migrations containing such operations.
I'm not sure if the warnings point at doing that but if it's not the case
it definitely should as this will be a common issue given
`AlterIndexTogether` has been around forever.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:28>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
We should probably run `check_deprecation_details()` only for not applied
migrations. What do you think?
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:29>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
[https://github.com/django/django/pull/15847 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:30>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Simon Charette):
> We should probably run check_deprecation_details() only for not applied
migrations. What do you think?
I think this will go a long way in avoiding to spam users every single
time they run a management command that triggers system checks but it's
not uncommon for developers to drop their local database and start from
scratch.
Ultimately they'll have to squash their migrations before 5.1 if they want
to avoid having their migration breaking so I wonder if we are doing them
a favour by silencing the check which than can already silence using
`SILENCED_SYSTEM_CHECKS`.
I think the system check hint should point at the proper procedure of
using `indexes` and running `makemigrations` instead?
Ultimately the only way for all the warnings and check errors to go away
before 5.1 where `AlterIndexTogether` will likely be marked as `elidable =
True` since it will be a noop is for users to manually edit their
migrations to replace their usage of `AlterIndexTogether` by `AddIndex`
and friends. I'm not sure the current documentation does a good job at
explaining how this must be done as it's a relatively complex operation.
Maybe there something that could be done through
`RenameIndex.reduce(operation: AlterIndexTogether)` to ease the pain when
`old_fields` is present here and have migration squashing handle most of
the cases? Otherwise I foresee a lot of reports coming our way on the 5.1
rollout saying that `RenameIndex` is failing to run due to a missing
index.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:31>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Collin Anderson):
> "run only on unapplied migrations"
makes sense to me.
> "Ultimately they'll have to squash their migrations before 5.1 if they
want to avoid having their migration breaking"
The deprecation warning/check says "Support for it (except in historical
migrations) will be removed in Django 5.1", so that seems to say to me
that it _won't_ be removed for historical migrations, and I as a developer
don't need to worry about it for historical migrations.
I'm mostly just providing feedback here on the wording. If Django wants me
to do something to my project to fix this issue, it should tell me what I
should do (like squash, or is there an alternative migration operation
that I should use instead?). Or if I don't need to do anything then there
shouldn't be a warning.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:32>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Carlton Gibson (added)
Comment:
I think we need all three:
- more descriptive release notes for `AlterIndexTogether`,
- running checks only on unapplied migrations, and
- reducing `AlterIndexTogether` with `RenameIndex`.
Lots of folks don't recreate their databases so they won't have to do
anything. As for the rest, we can document possible solutions, e.g.
- squash migrations,
- update the historical `CreateModel()` operation with
`options={index_together=[...]}` with the current state of
`index_together` (as long as all fields existed when the model was
created),
- replace `AlterIndexTogether` with `AddIndex`/`RemoveIndex`.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:33>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Simon Charette (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:34>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Component: Database layer | Version: dev
(models, ORM) |
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: closed => new
* has_patch: 1 => 0
* resolution: fixed =>
* severity: Normal => Release blocker
* stage: Ready for checkin => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:35>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
Alternatively, we can revert 57793b47657ace966ce8ce96d801ac0d85e5efc6,
41019e48bbf082c985e6ba3bad34d118b903bff1, and partly
a6385b382e05a614a99e5a5913d8e631823159a2 and leave `AlterIndexTogether`
fully functional forever.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:36>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Collin Anderson):
I'm personally always in favor of keeping things fully functional forever,
to reduce the amount of work that developers need to do, as long as it's
easy enough to maintain ( https://groups.google.com/g/django-
developers/c/zImXMKzWN4A/m/4SNu7MyFAQAJ ). If so, then there probably
doesn't need to be a warning message at all, but certainly not for applied
migrations, and no need for a deprecation timeline. Just discourage its
use and move on. Again, as long as it's easy enough to maintain long-term.
If functionality is getting removed or no-op'd in the future, then I'd
suggest that yes there should be a warning (not just for un-applied
migrations), and in my opinion the warning message should suggest an
alternative or at least link to docs about this deprecation and how to fix
it (AddIndex/RemoveIndex or something?) And, ideally it would be a type of
change that could be automatically applied using django-codemod or django-
upgrade, but that might be asking for too much.
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:37>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
I'm longer convinced that we have to deprecate and remove it. We can
document that is supported only in pre-Django 4.2 migrations and will not
receive any bugfixes in the future.
Simon, What do you think?
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:38>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
Alternative [https://github.com/django/django/pull/15861 PR].
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:39>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Collin Anderson (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:40>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by GitHub <noreply@…>):
In [changeset:"f81032572107846922745b68d5b7191058fdd5f5" f810325]:
{{{
#!CommitTicketReference repository=""
revision="f81032572107846922745b68d5b7191058fdd5f5"
Refs #27236 -- Made cosmetic edits to Meta.index_together deprecation.
This should make it more straightforward to move forward when
deprecation ends.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:41>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:42>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"66f30dbf253f89a3803aebbcee2675ce3e186b00" 66f30dbf]:
{{{
#!CommitTicketReference repository=""
revision="66f30dbf253f89a3803aebbcee2675ce3e186b00"
Refs #27236 -- Reverted "Refs #27236 -- Refactored out
DeprecationForHistoricalMigrationMixin."
This reverts commit 57793b47657ace966ce8ce96d801ac0d85e5efc6.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:45>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"7e3c9c3205e9646261cea5e5a7af7ec0e806690a" 7e3c9c32]:
{{{
#!CommitTicketReference repository=""
revision="7e3c9c3205e9646261cea5e5a7af7ec0e806690a"
Refs #27236 -- Doc'd that AlterIndexTogether is no longer officially
supported for Django 4.2+ migration files.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:46>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"c773d5794eb425c4836c726bdf6e1e742c94e9c0" c773d579]:
{{{
#!CommitTicketReference repository=""
revision="c773d5794eb425c4836c726bdf6e1e742c94e9c0"
Refs #27236 -- Reverted AlterIndexTogether deprecation.
This partly reverts a6385b382e05a614a99e5a5913d8e631823159a2.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:43>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: new
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution:
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"a1e9e9abc592b8f44fa798c6e4e225b1a04f757c" a1e9e9ab]:
{{{
#!CommitTicketReference repository=""
revision="a1e9e9abc592b8f44fa798c6e4e225b1a04f757c"
Refs #27236 -- Reverted "Refs #27236 -- Added generic mechanism to handle
the deprecation of migration operations."
This reverts commit 41019e48bbf082c985e6ba3bad34d118b903bff1.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:44>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Component: Database layer | Version: dev
(models, ORM) |
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => fixed
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:47>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by GitHub <noreply@…>):
In [changeset:"ca5d3c99efb1bcf181e923dcd00c4679ab6174ef" ca5d3c9]:
{{{
#!CommitTicketReference repository=""
revision="ca5d3c99efb1bcf181e923dcd00c4679ab6174ef"
Refs #27236 -- Made more cosmetic edits to Meta.index_together
deprecation.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:48>
Django
-------------------------------------+-------------------------------------
Reporter: Akshesh Doshi | Owner: David
Type: | Wobrock
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Release blocker | Resolution: fixed
Keywords: index_together | Triage Stage: Ready for
| checkin
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"2abf417c815c20f41c0868d6f66520b32347106e" 2abf417c]:
{{{
#!CommitTicketReference repository=""
revision="2abf417c815c20f41c0868d6f66520b32347106e"
Refs #27236 -- Removed Meta.index_together per deprecation timeline.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27236#comment:49>