Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#28423 closed Cleanup/optimization (fixed)

Refer to GinIndex instead of RunSQL in ArrayField docs. Add GinIndex refs to HStoreField and JSONField docs.

Reported by: Phil Krylov Owned by: Tim Graham <timograham@…>
Component: Documentation Version: 1.11
Severity: Normal Keywords: postgres gin arrayfield jsonfield hstorefield index
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description

At the moment of writing this, the ​ArrayField docs says "A more useful index is a GIN index, which you should create using a RunSQL operation."
Since 1.11, you can use django.contrib.postgres.indexes.GinIndex to create GIN indexes. I think it's better to recommend it and not RunSQL.
Also, HStoreField and JSONField docs totally miss the indexing problem, this should also be fixed.

Change History (4)

comment:1 by Tim Graham, 7 years ago

Triage Stage: Unreviewed → Accepted

comment:5 by Tim Graham, 7 years ago

Has patch: set
Patch needs improvement: set

​PR

comment:6 by Tim Graham <timograham@…>, 7 years ago

Owner: set to Tim Graham <timograham@…>
Resolution: → fixed
Status: new → closed

In 22ff4f81:

Fixed #28423 -- Expanded docs for indexing contrib.postgres fields.

comment:7 by Tim Graham <timograham@…>, 7 years ago

In d3e11515:

[2.0.x] Fixed #28423 -- Expanded docs for indexing contrib.postgres fields.

Backport of 22ff4f81b1859ed7af7999ef479a10b5d31a2164 from master

Note: See TracTickets for help on using tickets.
Back to Top