Opened 12 years ago

Closed 11 years ago

Last modified 11 years ago

#19441 closed Bug (fixed)

No Postgres _like index when unique=True

Reported by: Dylan Verheul Owned by: nobody
Component: Database layer (models, ORM) Version: dev
Severity: Normal Keywords: postgresql
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Claude Paroz)

class Species(models.Model):
    scientific_name = models.CharField(max_length=200, db_index=True)

Generates 2 indexes:

BEGIN;
CREATE INDEX "species_species_scientific_name" ON "species_species" ("scientific_name");
CREATE INDEX "species_species_scientific_name_like" ON "species_species" ("scientific_name" varchar_pattern_ops);

COMMIT;
class Species(models.Model):
    scientific_name = models.CharField(max_length=200, unique=True, db_index=True)

...does not create any indexes, because it depends on UNIQUE, but it SHOULD generate the index:

CREATE INDEX "species_species_scientific_name_like" ON "species_species" ("scientific_name" varchar_pattern_ops);

to make sure Postgres is optimized for LIKE operator.

Attachments (2)

19441-1.diff (3.5 KB ) - added by Claude Paroz 12 years ago.
19441-2.diff (1.7 KB ) - added by Claude Paroz 11 years ago.

Download all attachments as: .zip

Change History (16)

comment:1 by Claude Paroz, 12 years ago

Description: modified (diff)

comment:2 by Claude Paroz, 12 years ago

Keywords: postgresql added
Triage Stage: UnreviewedAccepted
Version: 1.5-beta-1master

by Claude Paroz, 12 years ago

Attachment: 19441-1.diff added

comment:3 by Claude Paroz, 12 years ago

Has patch: set

comment:4 by Dylan Verheul, 12 years ago

Apologies if this is too much of a vanity request, but could this ticket's reporter be set to my user (dyve) instead of to my e-mail? Makes it easier to keep track of. Apparently I wasn't logged in properly when I filed it.

comment:5 by Aymeric Augustin, 12 years ago

Reporter: changed from dylan@… to Dylan Verheul

comment:6 by Anssi Kääriäinen, 12 years ago

Triage Stage: AcceptedReady for checkin

It seems that getting the LIKE index when db_index = True for unique field is correct.

I tested the patch on top of 1.5 for the indexes tests. This looks ready for commit to me.

comment:7 by Claude Paroz <claude@…>, 11 years ago

Resolution: fixed
Status: newclosed

In 55972ee5c799c75f2d3a320a46297076aaae614a:

Fixed #19441 -- Created PostgreSQL varchar index when unique=True

Thanks Dylan Verheul for the report and Anssi Kääriäinen for the
review.

comment:8 by Claude Paroz <claude@…>, 11 years ago

In ddea0e0d7ee1a885f8ecbe45d7306a39c7780d63:

[1.5.x] Fixed #19441 -- Created PostgreSQL varchar index when unique=True

Thanks Dylan Verheul for the report and Anssi Kääriäinen for the
review.
Backport of 55972ee5c from master.

comment:9 by Dylan Verheul, 11 years ago

Now that I;'ve worked with this solution in 1.5c1 I am wondering if this is 100% correct.

For all systems except for postgres, unique=True makes db_index=True obsolete
For postgres, you would basically need to add db_index=True to fields with unique=True if you intend to do LIKE searches on that field.

So the choice is:
A - different technical behavior varying by db vendor (db_index is considered True if unique is True)
B - different functional behavior varying by db vendor (currently implemented behavior)

My knowledge of Django philosophy on these matters is too limited to take a good stance on this, so consider this just an extra heads up. Either way this might need some extra documentation. If you don't know where to look, this is a nasty one to find in Postgres country.

Last edited 11 years ago by Dylan Verheul (previous) (diff)

by Claude Paroz, 11 years ago

Attachment: 19441-2.diff added

comment:10 by Claude Paroz, 11 years ago

Dylan, can you check the attached patch? Does it address your concerns?

The alternative would be to document that Postgres users who want to make like queries on unique fields should set db_index=True in addition to unique=True.

comment:11 by Dylan Verheul, 11 years ago

Claude, this would be perfect. The explanation you added (unique=True implies db_index=True on all occasions) says it all, and it very elegant.

The only "added weight" you collect by solving it like this is the creation of like-indexes on postgresql when the field is used as a unique identifier and not meant for like searching, The like indexes would be created but never used. I think this is not a problem, as it is far more important to have a unified way that Django works (again, unique=True implies db_index=True) than to take different database vendors into account when deciding when or not to add db_index=True.

To put it briefly, I'd be in favor of submitting this patch as the final solution for this issue.

Last edited 11 years ago by Dylan Verheul (previous) (diff)

comment:12 by Claude Paroz <claude@…>, 11 years ago

In c698c55966ed9179828857398d27bf69e64713a2:

Created special PostgreSQL text indexes when unique is True

Refs #19441.

comment:13 by Claude Paroz <claude@…>, 11 years ago

In 012229914cb1391ee4fcb6c183a341a6491cd377:

[1.5.x] Created special PostgreSQL text indexes when unique is True

Refs #19441.
Backport of c698c55966 from master.

comment:14 by Claude Paroz <claude@…>, 11 years ago

In 012229914cb1391ee4fcb6c183a341a6491cd377:

[1.5.x] Created special PostgreSQL text indexes when unique is True

Refs #19441.
Backport of c698c55966 from master.

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