Hide the migrations when not using the database store.

This is a bit of a hack as we're adjusting the project's settings
and it hides all migrations.

Author: tim-schilling

debug_toolbar/apps.py

@@ -24,6 +24,22 @@ def ready(self):
         # allows panels like CachePanel to enable their instrumentation immediately.
         for cls in DebugToolbar.get_panel_classes():
             cls.ready()
+        _manage_migrations_visibility(self.name)
+
+
+def _manage_migrations_visibility(app_name):
+    """
+    Adjust the toolbar's migration visibility by manipulating the
+    project's settings.
+
+    This is a hack since it's manipulating settings.
+    """
+    if (
+        dt_settings.get_config()["TOOLBAR_STORE_CLASS"]
+        != "debug_toolbar.store.DatabaseStore"
+    ):
+        # This effectively hides the migrations by telling Django they don't exist.
+        settings.MIGRATION_MODULES.setdefault(app_name, None)
 
 
 def check_template_config(config):

docs/changes.rst

@@ -16,6 +16,8 @@ Pending
 * Upgraded CI ``postgis`` version to 17-3.5.
 * Added how to generate the documentation locally to the contributing
   documentation.
+* Hide the toolbar's migrations unless the database store is being used. This
+  may change in the future.
 
 6.0.0 (2025-07-22)
 ------------------

docs/configuration.rst

@@ -196,15 +196,15 @@ Toolbar options
   The DatabaseStore provides persistence and automatically cleans up old
   entries based on the ``RESULTS_CACHE_SIZE`` setting.
 
-  Note: For full functionality, DatabaseStore requires migrations for
-  the debug_toolbar app:
+  Note: When using ``DatabaseStore`` migrations are required for
+  the ``debug_toolbar`` app:
 
   .. code-block:: bash
 
       python manage.py migrate debug_toolbar
 
-  For the DatabaseStore to work properly, you need to run migrations for the
-  debug_toolbar app. The migrations create the necessary database table to store
+  For the ``DatabaseStore`` to work properly, you need to run migrations for the
+  ``debug_toolbar`` app. The migrations create the necessary database table to store
   toolbar data.
 
 .. _TOOLBAR_LANGUAGE:

tests/test_apps.py

@@ -0,0 +1,27 @@
+from unittest.mock import patch
+
+from django.test import SimpleTestCase, override_settings
+
+from debug_toolbar.apps import _manage_migrations_visibility
+
+
+class AppsTestCase(SimpleTestCase):
+    @override_settings(
+        DEBUG_TOOLBAR_CONFIG={
+            "TOOLBAR_STORE_CLASS": "debug_toolbar.store.DatabaseStore"
+        }
+    )
+    @patch("debug_toolbar.apps.settings.MIGRATION_MODULES")
+    def test_migrations_are_visible(self, mocked_migration_modules):
+        _manage_migrations_visibility("debug_toolbar")
+        self.assertFalse(mocked_migration_modules.setdefault.called)
+
+    @override_settings(
+        DEBUG_TOOLBAR_CONFIG={"TOOLBAR_STORE_CLASS": "debug_toolbar.store.MemoryStore"}
+    )
+    @patch("debug_toolbar.apps.settings.MIGRATION_MODULES")
+    def test_migrations_are_hidden(self, mocked_migration_modules):
+        _manage_migrations_visibility("debug_toolbar")
+        mocked_migration_modules.setdefault.assert_called_once_with(
+            "debug_toolbar", None
+        )