feat(indexes): add nulls_not_distinct option to PostgreSQLIndex - #2247
Open
pctablet505 wants to merge 3 commits into
Open
feat(indexes): add nulls_not_distinct option to PostgreSQLIndex#2247pctablet505 wants to merge 3 commits into
pctablet505 wants to merge 3 commits into
Conversation
pctablet505
marked this pull request as ready for review
July 17, 2026 12:48
Add unique and nulls_not_distinct parameters to PostgreSQLIndex so users can create PostgreSQL unique indexes that treat NULL values as equal. This implements the direction from abondar in tortoise#1641: expose the option on tortoise.contrib.postgres.indexes.PostgreSQLIndex instead of changing unique_together behavior. Fixes tortoise#1641
Run make style to satisfy the ruff format and isort (I) checks so the lint gate passes.
…ex_sql add_index() unconditionally passes unique= and nulls_not_distinct= to self._get_index_sql(), but only the Postgres schema editor's override declared those parameters. Every other backend (sqlite/mssql via the base implementation, and mysql via its own override) raised TypeError: _get_index_sql() got an unexpected keyword argument 'unique' on any migration that adds an index — this broke test_add_index_operation_runs_sql on the sqlite/mysql/mssql CI matrix. Both parameters are now accepted on every backend. unique mirrors the existing UNIQUE_INDEX_CREATE_TEMPLATE/uidx-prefix pattern already used elsewhere in these classes; nulls_not_distinct is inherently PostgreSQL-only (NULLS NOT DISTINCT has no equivalent elsewhere) so it's accepted and ignored on other backends, same as unique already is today in practice (only PostgreSQLIndex sets these attributes). Also fixes the mypy error in BasePostgresSchemaEditor._get_index_sql: _generate_index_name expects list[str], not the Sequence[str] the field_names parameter is typed as.
pctablet505
force-pushed
the
fix-1641-nulls-not-distinct
branch
from
August 21, 2026 15:19
9603f3e to
660a1e7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1641.
Adds
uniqueandnulls_not_distinctparameters toPostgreSQLIndex, so users can createNULLS NOT DISTINCTunique indexes directly instead of relying onunique_together. This matches the approach discussed in the issue: keepunique_togetherunchanged and expose the option on the PostgreSQL-specific index class.Adds regression tests for schema generation and migration SQL output.