Support indexes in mat. views in different schemas

Author: Mikuláš Poul

django_pgviews/view.py

@@ -11,6 +11,7 @@
 from django.core import exceptions
 from django.db import connections, router, transaction
 from django.db import models
+from django.db.backends.postgresql.schema import DatabaseSchemaEditor
 from django.db.models.query import QuerySet
 
 from django_pgviews.db import get_fields_by_name
@@ -96,7 +97,8 @@ def _drop_mat_view(cursor, view_name):
 
 
 def _concurrent_index_name(view_name, concurrent_index):
-    return view_name + "_" + "_".join([s.strip() for s in concurrent_index.split(",")]) + "_index"
+    # replace . with _ in view_name in case the table is in a schema
+    return view_name.replace(".", "_") + "_" + "_".join([s.strip() for s in concurrent_index.split(",")]) + "_index"
 
 
 def _create_concurrent_index(cursor, view_name, concurrent_index):
@@ -109,6 +111,21 @@ def _create_concurrent_index(cursor, view_name, concurrent_index):
     )
 
 
+class CustomSchemaEditor(DatabaseSchemaEditor):
+    def _create_index_sql(self, *args, **kwargs):
+        """
+        Override to handle indexes in custom schemas, when the schema is explicitly set.
+        """
+        statement = super()._create_index_sql(*args, **kwargs)
+
+        model = args[0]
+
+        if "." in model._meta.db_table:  # by default the table it's quoted, but we need it non-quoted
+            statement.parts["table"] = model._meta.db_table
+
+        return statement
+
+
 def _ensure_indexes(connection, cursor, view_cls, schema_name_log):
     """
     This function gets called when a materialized view is deemed not needing a re-create. That is however only a part
@@ -133,17 +150,19 @@ def _ensure_indexes(connection, cursor, view_cls, schema_name_log):
         concurrent_index_name = None
 
     for index_name in existing_indexes - required_indexes:
-        cursor.execute(f"DROP INDEX {index_name}")
+        cursor.execute(f"DROP INDEX {vschema}.{index_name}")
         logger.info("pgview dropped index %s on view %s (%s)", index_name, view_name, schema_name_log)
 
+    schema_editor: DatabaseSchemaEditor = CustomSchemaEditor(connection)
+
     for index_name in required_indexes - existing_indexes:
         if index_name == concurrent_index_name:
             _create_concurrent_index(cursor, view_name, concurrent_index)
             logger.info("pgview created concurrent index on view %s (%s)", view_name, schema_name_log)
         else:
             for index in indexes:
                 if index.name == index_name:
-                    connection.schema_editor().add_index(view_cls, index)
+                    schema_editor.add_index(view_cls, index)
                     logger.info("pgview created index %s on view %s (%s)", index.name, view_name, schema_name_log)
                     break
 
@@ -218,7 +237,7 @@ def create_materialized_view(connection, view_cls, check_sql_changed=False):
             logger.info("pgview created concurrent index on view %s (%s)", view_name, schema_name_log)
 
         if view_cls._meta.indexes:
-            schema_editor = connection.schema_editor()
+            schema_editor = CustomSchemaEditor(connection)
 
             for index in view_cls._meta.indexes:
                 schema_editor.add_index(view_cls, index)

tests/test_project/test_project/viewtest/models.py

@@ -68,6 +68,17 @@ class Meta:
         indexes = [models.Index(fields=["model"])]
 
 
+class CustomSchemaMaterializedRelatedViewWithIndex(view.ReadOnlyMaterializedView):
+    concurrent_index = "id"
+    sql = """SELECT id AS model_id, id FROM viewtest_testmodel"""
+    model = models.ForeignKey(TestModel, on_delete=models.DO_NOTHING)
+
+    class Meta:
+        db_table = "test_schema.my_custom_view_with_index"
+        managed = False
+        indexes = [models.Index(fields=["model"])]
+
+
 class CustomSchemaView(view.ReadOnlyView):
     sql = """SELECT id AS model_id, id FROM viewtest_testmodel"""
     model = models.ForeignKey(TestModel, on_delete=models.DO_NOTHING)

tests/test_project/test_project/viewtest/tests.py

@@ -15,6 +15,7 @@
 from django.utils import timezone
 
 from django_pgviews.signals import view_synced, all_views_synced
+from django_pgviews.view import _schema_and_name
 
 from . import models
 from .models import LatestSuperusers
@@ -28,7 +29,9 @@ def create_test_schema(sender, app_config, using, **kwargs):
 
 
 def get_list_of_indexes(cursor, cls):
-    cursor.execute("SELECT indexname FROM pg_indexes WHERE tablename = %s", [cls._meta.db_table])
+    schema, table = _schema_and_name(cursor.connection, cls._meta.db_table)
+
+    cursor.execute("SELECT indexname FROM pg_indexes WHERE tablename = %s AND schemaname = %s", [table, schema])
     return set(x[0] for x in cursor.fetchall())
 
 
@@ -144,6 +147,7 @@ def test_materialized_view_indexes(self):
             self.assertIn("viewtest_materializedrelatedviewwithindex_id_index", orig_indexes)
             self.assertEqual(len(orig_indexes), 2)
 
+            # drop current indexes, add some random ones which will get deleted
             for index_name in orig_indexes:
                 cursor.execute(f"DROP INDEX {index_name}")
 
@@ -163,6 +167,32 @@ def test_materialized_view_indexes(self):
 
             self.assertEqual(new_indexes, orig_indexes)
 
+    def test_materialized_view_schema_indexes(self):
+        with connection.cursor() as cursor:
+            orig_indexes = get_list_of_indexes(cursor, models.CustomSchemaMaterializedRelatedViewWithIndex)
+
+            self.assertEqual(len(orig_indexes), 2)
+            self.assertIn("test_schema_my_custom_view_with_index_id_index", orig_indexes)
+
+            # drop current indexes, add some random ones which will get deleted
+            for index_name in orig_indexes:
+                cursor.execute(f"DROP INDEX test_schema.{index_name}")
+
+            cursor.execute(
+                "CREATE UNIQUE INDEX my_custom_view_with_index_concurrent_idx "
+                "ON test_schema.my_custom_view_with_index (id)"
+            )
+            cursor.execute(
+                "CREATE INDEX my_custom_view_with_index_some_idx ON test_schema.my_custom_view_with_index (model_id)"
+            )
+
+        call_command("sync_pgviews", materialized_views_check_sql_changed=True)
+
+        with connection.cursor() as cursor:
+            new_indexes = get_list_of_indexes(cursor, models.CustomSchemaMaterializedRelatedViewWithIndex)
+
+            self.assertEqual(new_indexes, orig_indexes)
+
     def test_materialized_view_with_no_data(self):
         """
         Test a materialized view with no data works correctly
@@ -203,7 +233,7 @@ def on_all_views_synced(sender, **kwargs):
         call_command("sync_pgviews", update=False)
 
         # All views went through syncing
-        self.assertEqual(len(synced_views), 11)
+        self.assertEqual(len(synced_views), 12)
         self.assertEqual(all_views_were_synced[0], True)
         self.assertFalse(expected)