confirm support for CockroachDB 25.1

Author: timgraham

.github/workflows/tests.yml

@@ -49,6 +49,11 @@ jobs:
             use_psycopg2: psycopg2
           - crdb-version: v24.3.8
             use_server_side_binding: server_side_binding
+          - crdb-version: v25.1.2
+          - crdb-version: v25.1.2
+            use_psycopg2: psycopg2
+          - crdb-version: v25.1.2
+            use_server_side_binding: server_side_binding
           # Uncomment to enable testing of CockroachDB nightly.
           #- crdb-version: LATEST
           #- crdb-version: LATEST

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 5.1.1 - Unreleased
 
-- Confirmed support for CockroachDB 24.2.x and 24.3.x (no code changes
+- Confirmed support for CockroachDB 24.2.x, 24.3.x, and 25.1.x (no code changes
   required).
 
 ## 5.1 - 2024-08-13

README.md

@@ -92,7 +92,7 @@ By default, CockroachDB sends the version of django-cockroachdb that you're
 using back to Cockroach Labs. To disable this, set
 `DISABLE_COCKROACHDB_TELEMETRY = True` in your Django settings.
 
-## Known issues and limitations in CockroachDB 24.3.x and earlier
+## Known issues and limitations in CockroachDB 25.1.x and earlier
 
 - CockroachDB [can't disable constraint checking](https://github.com/cockroachdb/cockroach/issues/19444),
   which means certain things in Django like forward references in fixtures
@@ -102,12 +102,6 @@ using back to Cockroach Labs. To disable this, set
 
    - [changing column type if it's part of an index](https://go.crdb.dev/issue/47636)
    - dropping or changing a table's primary key
-   - CockroachDB executes `ALTER COLUMN` queries asynchronously which is at
-     odds with Django's assumption that the database is altered before the next
-     migration operation begins. CockroachDB will give an error like
-     `unimplemented: table <...> is currently undergoing a schema change` if a
-     later operation tries to modify the table before the asynchronous query
-     finishes. A future version of CockroachDB [may fix this](https://github.com/cockroachdb/cockroach/issues/47137).
 
 - The `Field.db_comment` and `Meta.db_table_comment` options aren't supported
   due to [poor performance](https://github.com/cockroachdb/cockroach/issues/95068).
@@ -145,6 +139,15 @@ using back to Cockroach Labs. To disable this, set
        overlaps_below (&>|)](https://github.com/cockroachdb/cockroach/issues/57098)
      - [strictly_above (|>>), strictly_below (<<|)](https://github.com/cockroachdb/cockroach/issues/57095)
 
+## Known issues and limitations in CockroachDB 24.3.x and earlier
+
+- CockroachDB executes `ALTER COLUMN` queries asynchronously which is at
+  odds with Django's assumption that the database is altered before the next
+  migration operation begins. CockroachDB will give an error like
+  `unimplemented: table <...> is currently undergoing a schema change` if a
+  later operation tries to modify the table before the asynchronous query
+  finishes.
+
  ## Known issues and limitations in CockroachDB 23.1.x and earlier
 
 - CockroachDB doesn't support by ordering by JSON.

django_cockroachdb/features.py

@@ -87,6 +87,10 @@ def is_cockroachdb_24_1(self):
     def is_cockroachdb_24_3(self):
         return self.connection.cockroachdb_version >= (24, 3)
 
+    @cached_property
+    def is_cockroachdb_25_1(self):
+        return self.connection.cockroachdb_version >= (25, 1)
+
     @cached_property
     def django_test_expected_failures(self):
         expected_failures = super().django_test_expected_failures
@@ -291,6 +295,12 @@ def django_test_expected_failures(self):
                     # https://github.com/cockroachdb/cockroach/pull/127098#issuecomment-2492652084
                     "model_fields.test_uuid.TestQuerying.test_filter_with_expr",
                 })
+            if self.is_cockroachdb_25_1:
+                expected_failures.update({
+                    # psycopg.errors.IndeterminateDatatype: could not determine
+                    # data type of placeholder $1
+                    'expressions_case.tests.CaseExpressionTests.test_filter_with_expression_as_condition',
+                })
         else:
             expected_failures.update({
                 # Unsupported query: unsupported binary operator: <int> / <int>:
@@ -304,13 +314,6 @@ def django_test_expected_failures(self):
     def django_test_skips(self):
         skips = super().django_test_skips
         skips.update({
-            # https://github.com/cockroachdb/cockroach/issues/47137
-            # These tests only fail sometimes, e.g.
-            # https://github.com/cockroachdb/cockroach/issues/65691
-            'ALTER COLUMN fails if previous asynchronous ALTER COLUMN has not finished.': {
-                'schema.tests.SchemaTests.test_alter_field_db_collation',
-                'schema.tests.SchemaTests.test_alter_field_type_and_db_collation',
-            },
             # https://github.com/cockroachdb/django-cockroachdb/issues/153#issuecomment-664697963
             'CockroachDB has more restrictive blocking than other databases.': {
                 'select_for_update.tests.SelectForUpdateTests.test_block',
@@ -341,4 +344,14 @@ def django_test_skips(self):
                 'admin_views.test_multidb.ViewOnSiteTests.test_contenttype_in_separate_db',
             },
         })
+        if not self.is_cockroachdb_25_1:
+            skips.update({
+                # https://github.com/cockroachdb/cockroach/issues/47137
+                # These tests only fail sometimes, e.g.
+                # https://github.com/cockroachdb/cockroach/issues/65691
+                'ALTER COLUMN fails if previous asynchronous ALTER COLUMN has not finished.': {
+                    'schema.tests.SchemaTests.test_alter_field_db_collation',
+                    'schema.tests.SchemaTests.test_alter_field_type_and_db_collation',
+                },
+            })
         return skips

django_cockroachdb/schema.py

@@ -55,8 +55,12 @@ def _alter_field(self, model, old_field, new_field, old_type, new_type,
                      old_db_params, new_db_params, strict=False):
         # ALTER COLUMN TYPE is experimental.
         # https://github.com/cockroachdb/cockroach/issues/49329
-        if (old_type != new_type or
-                getattr(old_field, 'db_collation', None) != getattr(new_field, 'db_collation', None)):
+        if (
+            not self.connection.features.is_cockroachdb_25_1 and (
+                old_type != new_type or
+                getattr(old_field, 'db_collation', None) != getattr(new_field, 'db_collation', None)
+            )
+        ):
             self.execute('SET enable_experimental_alter_column_type_general = true')
         # Skip to the base class to avoid trying to add or drop
         # PostgreSQL-specific LIKE indexes.