You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -16,7 +15,6 @@ Django. For example, to get the latest compatible release for Django 5.2.x:
16
15
```bash
17
16
pip install django-mongodb-backend==5.2.*
18
17
```
19
-
20
18
## Quickstart
21
19
22
20
### Start project
@@ -37,7 +35,6 @@ the template url to get the template for any Django version matching 5.2:
37
35
django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
38
36
```
39
37
40
-
41
38
### Connect to the database
42
39
43
40
Navigate to your `example/settings.py` file and replace the `DATABASES`
@@ -54,49 +51,33 @@ DATABASES = {
54
51
```
55
52
56
53
### Run the server
57
-
To verify that you installed Django MongoDB Backend and correctly configured your project, run the following command from your project root:
54
+
To verify that you installed Django MongoDB Backend and correctly configured
55
+
your project, run the following command from your project root:
58
56
```bash
59
57
python manage.py runserver
60
58
```
61
-
Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!" message and an image of a rocket.
62
-
63
-
64
-
## Capabilities of Django MongoDB Backend
65
-
66
-
-**Model MongoDB Documents Through Django’s ORM**
67
-
68
-
- Store Django model instances as MongoDB documents.
69
-
- Maps Django's built-in fields to MongoDB data types.
70
-
- Provides custom fields for arrays (`ArrayField`) and embedded documents (`EmbeddedModelField`).
71
-
- Supports core migration functionalities.
72
-
-**Index Management**
73
-
- Create single, compound, partial, and unique indexes using Django Indexes.
74
-
-**Querying Data**
75
-
- Supports most of the Django QuerySet API.
76
-
- Supports relational field usage and executes `JOIN` operations with MQL.
77
-
- A custom `QuerySet.raw_aggregate` method exposes MongoDB-specific operations like Vector Search, Atlas Search, and GeoSpatial querying to yield Django QuerySet results.
78
-
-**Administrator Dashboard & Authentication**
79
-
- Manage your data in Django’s admin site.
80
-
- Fully integrated with Django's authentication framework.
81
-
- Supports native user management features like creating users and session management.
82
-
59
+
Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!"
60
+
message and an image of a rocket.
83
61
84
62
### Issues & Help
85
63
86
-
We're glad to have such a vibrant community of users of Django MongoDB Backend.
87
64
You can ask questions and request features through the
88
65
[MongoDB Community Forums](https://www.mongodb.com/community/forums/tag/python).
89
66
90
-
91
67
#### Bugs / Feature Requests
92
-
To report a bug or to request a new feature in Django MongoDB Backend, please open an issue in JIRA, our issue-management tool, using the following steps:
68
+
To report a bug or to request a new feature in Django MongoDB Backend, please
69
+
open an issue in JIRA, our issue-management tool, using the following steps:
93
70
94
71
1.[Create a JIRA account.](https://jira.mongodb.org/)
95
72
96
73
2. Navigate to the [Python Integrations project](https://jira.mongodb.org/projects/INTPYTHON/).
97
74
98
-
3. Click **Create Issue**. Please provide as much information as possible about the issue and the steps to reproduce it.
75
+
3. Click **Create Issue**. Please provide as much information as possible about
76
+
the issue and the steps to reproduce it.
99
77
100
-
Bug reports in JIRA for the Django MongoDB Backend project can be viewed by everyone.
78
+
Bug reports in JIRA for the Django MongoDB Backend project can be viewed by
79
+
everyone.
101
80
102
-
If you identify a security vulnerability in the driver or in any other MongoDB project, please report it according to the instructions found in [Create a Vulnerability Report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/).
81
+
If you identify a security vulnerability in the driver or in any other MongoDB
82
+
project, please report it according to the instructions found in
83
+
[Create a Vulnerability Report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/).
0 commit comments