feat(django-spanner): support covering indexes, dynamic user-agent, and docs for Django 6.0

Author: sakthivelmanii

packages/django-google-spanner/README.rst

@@ -65,12 +65,13 @@ Supported versions
 ~~~~~~~~~~~~~~~~~~
 
 The library supports `Django 5.2
-<https://docs.djangoproject.com/en/5.2/>`_.
+<https://docs.djangoproject.com/en/5.2/>`_ and `Django 6.0
+<https://docs.djangoproject.com/en/6.0/>`_.
 The minimum required Python version is 3.10.
 
 .. code:: shell
 
-    pip3 install django==5.2
+    pip3 install "django>=5.2,<6.1"
 
 
 Installing the package
@@ -88,7 +89,7 @@ To install from source:
 .. code:: shell
 
     git clone git@github.com:googleapis/google-cloud-python.git
-    cd python-spanner-django
+    cd packages/django-google-spanner
     pip3 install -e .
 
 
@@ -266,6 +267,26 @@ By participating in this project you agree to abide by its terms. See the `Code
 of Conduct <https://github.com/googleapis/google-cloud-python/blob/main/CODE_OF_CONDUCT.md>`_ for more information.
 
 
+DML RETURNING Behavior
+~~~~~~~~~~~~~~~~~~~~~~
+
+Starting with Django 6.0 compatibility, ``can_return_columns_from_insert = True`` is enabled. Django will generate ``THEN RETURN`` clauses for insert statements that create model instances with database-generated defaults or ``GeneratedField`` columns.
+
+If your application relies on the previous behavior (where returned columns were not queried automatically upon insert), you can disable it in your Django ``AppConfig``:
+
+.. code:: python
+
+    from django.apps import AppConfig
+
+    class MyAppConfig(AppConfig):
+        name = "myapp"
+
+        def ready(self):
+            from django_spanner.features import DatabaseFeatures
+
+            DatabaseFeatures.can_return_columns_from_insert = False
+
+
 Limitations
 ~~~~~~~~~~~
 

packages/django-google-spanner/django_spanner/base.py

@@ -16,6 +16,7 @@
 from .introspection import DatabaseIntrospection
 from .operations import DatabaseOperations
 from .schema import DatabaseSchemaEditor
+from .version import __version__
 
 # Global cache for Spanner client to prevent multiple initializations
 # which can cause OpenTelemetry 'MeterProvider override' crashes.
@@ -160,7 +161,7 @@ def get_connection_params(self):
             "project": self._get_project_id(),
             "instance_id": self.settings_dict["INSTANCE"],
             "database_id": self.settings_dict["NAME"],
-            "user_agent": "django_spanner/2.2.0a1",
+            "user_agent": f"django_spanner/{__version__}",
             **self.settings_dict["OPTIONS"],
         }
 

packages/django-google-spanner/django_spanner/features.py

@@ -71,6 +71,7 @@ def introspected_field_types(self):
     # Spanner does not support order by null modifiers.
     supports_order_by_nulls_modifier = False
     supports_any_value = True
+    supports_covering_indexes = True
     # Spanner does not support SELECTing an arbitrary expression that also
     # appears in the GROUP BY clause.
     supports_subqueries_in_group_by = False
@@ -214,6 +215,11 @@ def introspected_field_types(self):
         "many_to_one_null.tests.ManyToOneNullTests.test_set_clear_non_bulk",
         "many_to_one_null.tests.ManyToOneNullTests.test_unsaved",
         "foreign_object.tests.MultiColumnFKTests.test_prefetch_foreignobject_reverse",
+        # Indexes tests: Spanner uses STORING instead of PostgreSQL's INCLUDE syntax
+        # and does not support partial (WHERE) indexes. Upstream test assertions hardcode
+        # the literal string 'INCLUDE', causing string assertion failures against Spanner's STORING clause.
+        "indexes.tests.CoveringIndexTests.test_covering_index",
+        "indexes.tests.CoveringIndexTests.test_covering_partial_index",
         # Admin ChangeList tests
         "admin_changelist.tests.ChangeListTests.test_custom_lookup_in_search_fields",
         "admin_changelist.tests.ChangeListTests.test_deterministic_order_for_model_ordered_by_its_manager",

packages/django-google-spanner/django_spanner/utils.py

@@ -13,7 +13,7 @@ def check_django_compatability(supported_django_versions):
     """
     Verify that this version of django-spanner is compatible with the installed
     version of Django. For example, django-spanner is compatible
-    with Django 2.2.y and 3.2.z
+    with Django 5.2.x and 6.0.y
     """
     from . import __version__
 

packages/django-google-spanner/docs/samples.rst

@@ -9,4 +9,4 @@ This `Example <example_from_scratch.html>`_ shows how to use django-spanner for
 django-spanner on healthchecks.io
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This `Example <example_healthchecks.html>`_ shows how to use django-spanner for Cloud Spanner as a backend database for `Django's tutorials <https://docs.djangoproject.com/en/2.2/intro/tutorial01/>`_ 
+This `Example <example_healthchecks.html>`_ shows how to use django-spanner for Cloud Spanner as a backend database for `Django's tutorials <https://docs.djangoproject.com/en/5.2/intro/tutorial01/>`_ 

packages/django-google-spanner/noxfile.py

@@ -56,13 +56,13 @@
 ]
 
 UNIT_TEST_DEPENDENCIES = [
-    "django~=5.2",
-    "sqlparse==0.3.1",
+    "django>=5.2,<6.1",
+    "sqlparse>=0.3.1",
 ]
 
 UNIT_TEST_MOCKSERVER_DEPENDENCIES = [
-    "django~=5.2",
-    "google-cloud-spanner>=3.55.0",
+    "django>=5.2,<6.1",
+    "google-cloud-spanner>=3.69.1",
     "sqlparse>=0.4.4",
 ]
 

packages/django-google-spanner/run_testing_worker.py

@@ -67,9 +67,10 @@ def __exit__(self, exc, exc_value, traceback):
 print("creating instance with delay: {} seconds".format(delay))
 time.sleep(delay)
 
+suite = os.environ.get("DJANGO_TEST_SUITE", "./django_test_suite_6.0.sh")
 with TestInstance() as instance_name:
     os.system(
-        """DJANGO_TEST_APPS="{apps}" SPANNER_TEST_INSTANCE={instance} bash ./django_test_suite_4.2.sh""".format(
-            apps=" ".join(test_apps), instance=instance_name
+        """DJANGO_TEST_APPS="{apps}" SPANNER_TEST_INSTANCE={instance} bash {suite}""".format(
+            apps=" ".join(test_apps), instance=instance_name, suite=suite
         )
     )

packages/django-google-spanner/tests/unit/django_spanner/simple_test.py

@@ -9,6 +9,7 @@
 from django_spanner.base import DatabaseWrapper
 from django_spanner.client import DatabaseClient
 from django_spanner.operations import DatabaseOperations
+from django_spanner.version import __version__
 
 # from unittest import TestCase
 from tests._helpers import OpenTelemetryBase
@@ -22,7 +23,7 @@ def setUpClass(cls):
 
         cls.INSTANCE_ID = "instance_id"
         cls.DATABASE_ID = "database_id"
-        cls.USER_AGENT = "django_spanner/2.2.0a1"
+        cls.USER_AGENT = f"django_spanner/{__version__}"
         cls.OPTIONS = {"option": "dummy"}
 
         cls.settings_dict = {

packages/django-google-spanner/tests/unit/django_spanner/test_features.py

@@ -24,6 +24,7 @@ def test_introspected_field_types(self):
     def test_spanner_specific_feature_flags(self):
         features = DatabaseFeatures(self.connection)
         self.assertTrue(features.supports_any_value)
+        self.assertTrue(features.supports_covering_indexes)
         self.assertTrue(features.supports_stored_generated_columns)
         self.assertTrue(features.supports_composite_primary_keys)
         self.assertFalse(features.supports_subqueries_in_group_by)

packages/django-google-spanner/tests/unit/django_spanner/test_utils.py

@@ -15,23 +15,23 @@
 class TestUtils(SpannerSimpleTestClass):
     SQL_WITH_WHERE = "Select 1 from Table WHERE 1=1"
     SQL_WITHOUT_WHERE = "Select 1 from Table"
-    # Only active LTS django versions (2.2.*, 3.2.*) are supported by this library right now.
-    SUPPORTED_DJANGO_VERSIONS = [(2, 2), (3, 2)]
+    # Supported Django versions (5.2.*, 6.0.*) are supported by this library right now.
+    SUPPORTED_DJANGO_VERSIONS = [(5, 2), (6, 0)]
 
     def test_check_django_compatability_match(self):
         """
         Checks django compatibility match.
         """
-        django_spanner.__version__ = "2.2"
-        django.VERSION = (2, 2, 19, "alpha", 0)
+        django_spanner.__version__ = "5.2"
+        django.VERSION = (5, 2, 0, "final", 0)
         check_django_compatability(self.SUPPORTED_DJANGO_VERSIONS)
 
     def test_check_django_compatability_mismatch(self):
         """
         Checks django compatibility mismatch.
         """
-        django_spanner.__version__ = "2.2"
-        django.VERSION = (3, 1, 19, "alpha", 0)
+        django_spanner.__version__ = "5.2"
+        django.VERSION = (4, 2, 0, "final", 0)
         with self.assertRaises(ImproperlyConfigured):
             check_django_compatability(self.SUPPORTED_DJANGO_VERSIONS)