provided docs update and tests

Author: Jibola

django_mongodb_backend/compiler.py

@@ -652,7 +652,7 @@ def explain_query(self):
             **kwargs,
         )
         # explain() expects a list and joins on a newline. Concatenate no lines
-        return [json_util.dumps(explain)]
+        return [json_util.dumps(explain, indent=4)]
 
 
 class SQLInsertCompiler(SQLCompiler):

docs/source/releases/5.2.x.rst

@@ -16,6 +16,8 @@ New features
 - Added support for :ref:`database transactions <transactions>`.
 - Added :class:`~.fields.PolymorphicEmbeddedModelField` for storing a model
   instance that may be of more than one model class.
+- ``Query.explain()`` now returns a parseable JSON string instead of a list of
+  formatted lines.
 
 5.2.0 beta 1
 ============

tests/queries_/test_explain.py

@@ -0,0 +1,14 @@
+import json
+
+from django.test import TestCase
+
+from .models import Author
+
+
+class ExplainTests(TestCase):
+    def test_json_serializable(self):
+        explain = Author.objects.all().explain()
+        self.assertIsInstance(explain, str)
+
+        explained_json = json.loads(explain)
+        self.assertIsInstance(explained_json, dict)