Skip to content

Commit c5985c9

Browse files
committed
Include FAQ to README
1 parent 167b0b6 commit c5985c9

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,29 @@ from the new application's `apps.py` file.
101101
Valid values for `verbosity` are `"queryPlanner"` (default),
102102
`"executionStats"`, and `"allPlansExecution"`.
103103

104+
## Why are we building a MongoDB-Django integration?
105+
106+
Building a robust solution that makes Django and NoSQL databases work together well has historically been challenging due to Django's ORM being built around relational database principles. While there have been several attempts in the past to create NoSQL (and MongoDB) integrations for Django, many of these projects have not achieved lasting success for various reasons. So, why have we chosen to tackle this problem now?
107+
108+
According to the 2023 Django Developer Survey, 8% of respondents reported using MongoDB as a database backend with Django. This figure has shown a consistent upward trend in recent years (see 2021 and 2022 surveys). Additionally, numerous community members and customers have expressed a strong interest in leveraging Django alongside MongoDB.
109+
Our goal is to meet the needs of the developer community by providing an exceptional experience when working with MongoDB. Therefore, we are embarking on this journey to create a reliable integration. **Please note that the current project is in a very early stage of development and is not yet ready for PoC or Production use cases.**
110+
111+
## Current capabilities
112+
113+
At this stage, the project should let you replicate the djangoproject.com tutorial with minimal changes. You will likely be able to run it passing a portion of the standard Django test suite but not all of it. Some key features that we have added so far are:
114+
- Able to define MongoDB collections using Django models
115+
- Able to query data using Django’s `QuerySets`
116+
- Able to use Django’s authentication system `django.contrib.auth`
117+
- Able to use Django’s automatic admin interface `django.contrib.admin`
118+
- Able to use Django’s management commands
119+
- Able to use MongoDB’s Aggregation Pipeline
120+
121+
## What's next?
122+
We are working towards a Public Preview release early 2025. We do not yet have a timeline for general availability. Exact details of the roadmap will be published soon. Stay tuned!
123+
What level of support will MongoDB provide to developers using this code?
124+
125+
This code is still in development and not intended for POC or production use cases, so we are not providing formal support within our Technical Services team at this time.
126+
104127
## Known issues and limitations
105128

106129
- The following `QuerySet` methods aren't supported:
@@ -149,6 +172,10 @@ from the new application's `apps.py` file.
149172
- You can study the skipped tests in `DatabaseFeatures.django_test_skips` for
150173
more details on known issues.
151174

175+
176+
## We value your feedback!
177+
We invite you to share your feedback as we work to address this challenge. If you are interested in becoming a design partner, please connect with us through our community forum. You can also create issues or submit pull requests directly to our project GitHub repository.
178+
152179
## Troubleshooting
153180

154-
TODO
181+
TODO

0 commit comments

Comments
 (0)