Opened 3 weeks ago
Closed 5 days ago
#36827 closed New feature (fixed)
Adding hash index support for exclusion constraint in PostgreSQL
| Reported by: | haki | Owned by: | haki |
|---|---|---|---|
| Component: | contrib.postgres | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | haki | 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
In PostgreSQL you can’t define a unique constraint using a hash index. However, you can enforce uniqueness using an exclusion constraint and a hash index. This is useful for large values that only use equality and that are not referenced by FKs (fields like UIDs, hashes, checksums, URLs, other large texts etc.).
However, the current implementation(https://github.com/django/django/blob/4426b1a72dc289643e2ae8c190b8dc4b3a39daf7/django/contrib/postgres/constraints.py#L38) of ExclusionConstraint in django.contrib.postgres.constraints is limited to gist and spgist. It seems like the implementation haven’t changed much since it was added in 2019.
I made a local change to allow hash to the list of allowed index_types and generated this constraint:
from django.contrib.postgres.constraints import ExclusionConstraint
class ShortUrl(models.Model):
class Meta:
constraints = (
ExclusionConstraint(
index_type='hash', # <--- this index type is currently unsupported
expressions=[
(F('url'), '='),
],
name='%(app_label)s_url_unique_hash',
),
)
It produced the expected SQL:
ALTER TABLE "shorturl_shorturl" ADD CONSTRAINT "shorturl_url_unique_hash" EXCLUDE USING hash ("url" WITH =);
After applying the migration the constraint worked as expected.
Change History (7)
comment:1 by , 3 weeks ago
| Has patch: | set |
|---|
comment:2 by , 3 weeks ago
comment:3 by , 3 weeks ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:4 by , 3 weeks ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:5 by , 3 weeks ago
| Patch needs improvement: | set |
|---|
Patch is looking great except for the lack of graceful handling of covering indices which will require adjustments and additional tests.
comment:6 by , 5 days ago
| Patch needs improvement: | unset |
|---|---|
| Triage Stage: | Accepted → Ready for checkin |
PR link https://github.com/django/django/pull/20462