| Name | django-mongodb-backend JSON |
| Version |
5.0.0a3
JSON |
| download |
| home_page | None |
| Summary | MongoDB backend for Django |
| upload_time | 2025-01-14 14:52:16 |
| maintainer | None |
| docs_url | None |
| author | The MongoDB Python Team |
| requires_python | >=3.10 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
django
mongo
mongodb
pymongo
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
django
pymongo
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MongoDB backend for Django
This backend is currently in development and is not advised for Production workflows. Backwards incompatible
changes may be made without notice. We welcome your feedback as we continue to
explore and build. The best way to share this is via our [MongoDB Community Forum](https://www.mongodb.com/community/forums/tag/python)
## Install and usage
The development version of this package supports Django 5.0.x. To install it:
`pip install git+https://github.com/mongodb-labs/django-mongodb-backend`
### Specifying the default primary key field
In your Django settings, you must specify that all models should use
`ObjectIdAutoField`.
You can create a new project that's configured based on these steps using a
project template:
```bash
$ django-admin startproject mysite --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip
```
(where "5.0" matches the version of Django that you're using.)
This template includes the following line in `settings.py`:
```python
DEFAULT_AUTO_FIELD = "django_mongodb_backend.fields.ObjectIdAutoField"
```
But this setting won't override any apps that have an `AppConfig` that
specifies `default_auto_field`. For those apps, you'll need to create a custom
`AppConfig`.
For example, the project template includes `<project_name>/apps.py`:
```python
from django.contrib.admin.apps import AdminConfig
from django.contrib.auth.apps import AuthConfig
from django.contrib.contenttypes.apps import ContentTypesConfig
class MongoAdminConfig(AdminConfig):
default_auto_field = "django_mongodb_backend.fields.ObjectIdAutoField"
class MongoAuthConfig(AuthConfig):
default_auto_field = "django_mongodb_backend.fields.ObjectIdAutoField"
class MongoContentTypesConfig(ContentTypesConfig):
default_auto_field = "django_mongodb_backend.fields.ObjectIdAutoField"
```
Each app reference in the `INSTALLED_APPS` setting must point to the
corresponding ``AppConfig``. For example, instead of `'django.contrib.admin'`,
the template uses `'<project_name>.apps.MongoAdminConfig'`.
### Configuring migrations
Because all models must use `ObjectIdAutoField`, each third-party and contrib app
you use needs to have its own migrations specific to MongoDB.
For example, `settings.py` in the project template specifies:
```python
MIGRATION_MODULES = {
"admin": "mongo_migrations.admin",
"auth": "mongo_migrations.auth",
"contenttypes": "mongo_migrations.contenttypes",
}
```
The project template includes these migrations, but you can generate them if
you're setting things up manually or if you need to create migrations for
third-party apps. For example:
```console
$ python manage.py makemigrations admin auth contenttypes
Migrations for 'admin':
mongo_migrations/admin/0001_initial.py
- Create model LogEntry
...
```
### Creating Django applications
Whenever you run `python manage.py startapp`, you must remove the line:
`default_auto_field = 'django.db.models.BigAutoField'`
from the new application's `apps.py` file (or change it to reference
`"django_mongodb_backend.fields.ObjectIdAutoField"`).
Alternatively, you can use the following `startapp` template which includes
this change:
```bash
$ python manage.py startapp myapp --template https://github.com/mongodb-labs/django-mongodb-app/archive/refs/heads/5.0.x.zip
```
(where "5.0" matches the version of Django that you're using.)
### Configuring the `DATABASES` setting
After you've set up a project, configure Django's `DATABASES` setting similar
to this:
```python
DATABASES = {
"default": {
"ENGINE": "django_mongodb_backend",
"HOST": "mongodb+srv://cluster0.example.mongodb.net",
"NAME": "my_database",
"USER": "my_user",
"PASSWORD": "my_password",
"PORT": 27017,
"OPTIONS": {
# Example:
"retryWrites": "true",
"w": "majority",
"tls": "false",
},
},
}
```
For a localhost configuration, you can omit `HOST` or specify
`"HOST": "localhost"`.
`HOST` only needs a scheme prefix for SRV connections (`mongodb+srv://`). A
`mongodb://` prefix is never required.
`OPTIONS` is an optional dictionary of parameters that will be passed to
[`MongoClient`](https://pymongo.readthedocs.io/en/stable/api/pymongo/mongo_client.html).
`USER`, `PASSWORD`, and `PORT` (if 27017) may also be optional.
For a replica set or sharded cluster where you have multiple hosts, include
all of them in `HOST`, e.g.
`"mongodb://mongos0.example.com:27017,mongos1.example.com:27017"`.
Alternatively, if you prefer to simply paste in a MongoDB URI rather than parse
it into the format above, you can use:
```python
import django_mongodb_backend
MONGODB_URI = "mongodb+srv://my_user:my_password@cluster0.example.mongodb.net/myDatabase?retryWrites=true&w=majority&tls=false"
DATABASES["default"] = django_mongodb_backend.parse_uri(MONGODB_URI)
```
This constructs a `DATABASES` setting equivalent to the first example.
#### `django_mongodb_backend.parse_uri(uri, conn_max_age=0, test=None)`
`parse_uri()` provides a few options to customize the resulting `DATABASES`
setting, but for maximum flexibility, construct `DATABASES` manually as
described above.
- Use `conn_max_age` to configure [persistent database connections](
https://docs.djangoproject.com/en/stable/ref/databases/#persistent-database-connections).
- Use `test` to provide a dictionary of [settings for test databases](
https://docs.djangoproject.com/en/stable/ref/settings/#test).
Congratulations, your project is ready to go!
## Notes on Django QuerySets
* `QuerySet.explain()` supports the [`comment` and `verbosity` options](
https://www.mongodb.com/docs/manual/reference/command/explain/#command-fields).
Example: `QuerySet.explain(comment="...", verbosity="...")`
Valid values for `verbosity` are `"queryPlanner"` (default),
`"executionStats"`, and `"allPlansExecution"`.
## Known issues and limitations
- The following `QuerySet` methods aren't supported:
- `bulk_update()`
- `dates()`
- `datetimes()`
- `distinct()`
- `extra()`
- `prefetch_related()`
- `QuerySet.delete()` and `update()` do not support queries that span multiple
collections.
- `DateTimeField` doesn't support microsecond precision, and correspondingly,
`DurationField` stores milliseconds rather than microseconds.
- The following database functions aren't supported:
- `Chr`
- `ExtractQuarter`
- `MD5`
- `Now`
- `Ord`
- `Pad`
- `Repeat`
- `Reverse`
- `Right`
- `SHA1`, `SHA224`, `SHA256`, `SHA384`, `SHA512`
- `Sign`
- The `tzinfo` parameter of the `Trunc` database functions doesn't work
properly because MongoDB converts the result back to UTC.
- When querying `JSONField`:
- There is no way to distinguish between a JSON "null" (represented by
`Value(None, JSONField())`) and a SQL null (queried using the `isnull`
lookup). Both of these queries return both of these nulls.
- Some queries with `Q` objects, e.g. `Q(value__foo="bar")`, don't work
properly, particularly with `QuerySet.exclude()`.
- Filtering for a `None` key, e.g. `QuerySet.filter(value__j=None)`
incorrectly returns objects where the key doesn't exist.
- You can study the skipped tests in `DatabaseFeatures.django_test_skips` for
more details on known issues.
- Due to the lack of ability to introspect MongoDB collection schema,
`migrate --fake-initial` isn't supported.
## Troubleshooting
### Debug logging
To troubleshoot MongoDB connectivity issues, you can enable [PyMongo's logging](
https://pymongo.readthedocs.io/en/stable/examples/logging.html) using
[Django's `LOGGING` setting](https://docs.djangoproject.com/en/stable/topics/logging/).
This is a minimal `LOGGING` setting that enables PyMongo's `DEBUG` logging:
```python
LOGGING = {
"version": 1,
"disable_existing_loggers": False,
"handlers": {
"console": {
"class": "logging.StreamHandler",
},
},
"loggers": {
"pymongo": {
"handlers": ["console"],
"level": "DEBUG",
},
},
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "django-mongodb-backend",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "django, mongo, mongodb, pymongo",
"author": "The MongoDB Python Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2b/b5/ca4eb2060eb79edeccab9e150b4160dce7f292da9753bbab781f67285880/django_mongodb_backend-5.0.0a3.tar.gz",
"platform": null,
"description": "# MongoDB backend for Django\n\nThis backend is currently in development and is not advised for Production workflows. Backwards incompatible\nchanges may be made without notice. We welcome your feedback as we continue to\nexplore and build. The best way to share this is via our [MongoDB Community Forum](https://www.mongodb.com/community/forums/tag/python)\n\n## Install and usage\n\nThe development version of this package supports Django 5.0.x. To install it:\n\n`pip install git+https://github.com/mongodb-labs/django-mongodb-backend`\n\n### Specifying the default primary key field\n\nIn your Django settings, you must specify that all models should use\n`ObjectIdAutoField`.\n\nYou can create a new project that's configured based on these steps using a\nproject template:\n\n```bash\n$ django-admin startproject mysite --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip\n```\n(where \"5.0\" matches the version of Django that you're using.)\n\nThis template includes the following line in `settings.py`:\n\n```python\nDEFAULT_AUTO_FIELD = \"django_mongodb_backend.fields.ObjectIdAutoField\"\n```\n\nBut this setting won't override any apps that have an `AppConfig` that\nspecifies `default_auto_field`. For those apps, you'll need to create a custom\n`AppConfig`.\n\nFor example, the project template includes `<project_name>/apps.py`:\n\n```python\nfrom django.contrib.admin.apps import AdminConfig\nfrom django.contrib.auth.apps import AuthConfig\nfrom django.contrib.contenttypes.apps import ContentTypesConfig\n\n\nclass MongoAdminConfig(AdminConfig):\n default_auto_field = \"django_mongodb_backend.fields.ObjectIdAutoField\"\n\n\nclass MongoAuthConfig(AuthConfig):\n default_auto_field = \"django_mongodb_backend.fields.ObjectIdAutoField\"\n\n\nclass MongoContentTypesConfig(ContentTypesConfig):\n default_auto_field = \"django_mongodb_backend.fields.ObjectIdAutoField\"\n```\n\nEach app reference in the `INSTALLED_APPS` setting must point to the\ncorresponding ``AppConfig``. For example, instead of `'django.contrib.admin'`,\nthe template uses `'<project_name>.apps.MongoAdminConfig'`.\n\n### Configuring migrations\n\nBecause all models must use `ObjectIdAutoField`, each third-party and contrib app\nyou use needs to have its own migrations specific to MongoDB.\n\nFor example, `settings.py` in the project template specifies:\n\n```python\nMIGRATION_MODULES = {\n \"admin\": \"mongo_migrations.admin\",\n \"auth\": \"mongo_migrations.auth\",\n \"contenttypes\": \"mongo_migrations.contenttypes\",\n}\n```\n\nThe project template includes these migrations, but you can generate them if\nyou're setting things up manually or if you need to create migrations for\nthird-party apps. For example:\n\n```console\n$ python manage.py makemigrations admin auth contenttypes\nMigrations for 'admin':\n mongo_migrations/admin/0001_initial.py\n - Create model LogEntry\n...\n```\n\n### Creating Django applications\n\nWhenever you run `python manage.py startapp`, you must remove the line:\n\n`default_auto_field = 'django.db.models.BigAutoField'`\n\nfrom the new application's `apps.py` file (or change it to reference\n `\"django_mongodb_backend.fields.ObjectIdAutoField\"`).\n\nAlternatively, you can use the following `startapp` template which includes\nthis change:\n\n```bash\n$ python manage.py startapp myapp --template https://github.com/mongodb-labs/django-mongodb-app/archive/refs/heads/5.0.x.zip\n```\n(where \"5.0\" matches the version of Django that you're using.)\n\n### Configuring the `DATABASES` setting\n\nAfter you've set up a project, configure Django's `DATABASES` setting similar\nto this:\n\n```python\nDATABASES = {\n \"default\": {\n \"ENGINE\": \"django_mongodb_backend\",\n \"HOST\": \"mongodb+srv://cluster0.example.mongodb.net\",\n \"NAME\": \"my_database\",\n \"USER\": \"my_user\",\n \"PASSWORD\": \"my_password\",\n \"PORT\": 27017,\n \"OPTIONS\": {\n # Example:\n \"retryWrites\": \"true\",\n \"w\": \"majority\",\n \"tls\": \"false\",\n },\n },\n}\n```\n\nFor a localhost configuration, you can omit `HOST` or specify\n`\"HOST\": \"localhost\"`.\n\n`HOST` only needs a scheme prefix for SRV connections (`mongodb+srv://`). A\n`mongodb://` prefix is never required.\n\n`OPTIONS` is an optional dictionary of parameters that will be passed to\n[`MongoClient`](https://pymongo.readthedocs.io/en/stable/api/pymongo/mongo_client.html).\n\n`USER`, `PASSWORD`, and `PORT` (if 27017) may also be optional.\n\nFor a replica set or sharded cluster where you have multiple hosts, include\nall of them in `HOST`, e.g.\n`\"mongodb://mongos0.example.com:27017,mongos1.example.com:27017\"`.\n\nAlternatively, if you prefer to simply paste in a MongoDB URI rather than parse\nit into the format above, you can use:\n\n```python\nimport django_mongodb_backend\n\nMONGODB_URI = \"mongodb+srv://my_user:my_password@cluster0.example.mongodb.net/myDatabase?retryWrites=true&w=majority&tls=false\"\nDATABASES[\"default\"] = django_mongodb_backend.parse_uri(MONGODB_URI)\n```\n\nThis constructs a `DATABASES` setting equivalent to the first example.\n\n#### `django_mongodb_backend.parse_uri(uri, conn_max_age=0, test=None)`\n\n`parse_uri()` provides a few options to customize the resulting `DATABASES`\nsetting, but for maximum flexibility, construct `DATABASES` manually as\ndescribed above.\n\n- Use `conn_max_age` to configure [persistent database connections](\n https://docs.djangoproject.com/en/stable/ref/databases/#persistent-database-connections).\n- Use `test` to provide a dictionary of [settings for test databases](\n https://docs.djangoproject.com/en/stable/ref/settings/#test).\n\nCongratulations, your project is ready to go!\n\n## Notes on Django QuerySets\n\n* `QuerySet.explain()` supports the [`comment` and `verbosity` options](\n https://www.mongodb.com/docs/manual/reference/command/explain/#command-fields).\n\n Example: `QuerySet.explain(comment=\"...\", verbosity=\"...\")`\n\n Valid values for `verbosity` are `\"queryPlanner\"` (default),\n `\"executionStats\"`, and `\"allPlansExecution\"`.\n\n## Known issues and limitations\n\n- The following `QuerySet` methods aren't supported:\n - `bulk_update()`\n - `dates()`\n - `datetimes()`\n - `distinct()`\n - `extra()`\n - `prefetch_related()`\n\n- `QuerySet.delete()` and `update()` do not support queries that span multiple\n collections.\n\n- `DateTimeField` doesn't support microsecond precision, and correspondingly,\n `DurationField` stores milliseconds rather than microseconds.\n\n- The following database functions aren't supported:\n - `Chr`\n - `ExtractQuarter`\n - `MD5`\n - `Now`\n - `Ord`\n - `Pad`\n - `Repeat`\n - `Reverse`\n - `Right`\n - `SHA1`, `SHA224`, `SHA256`, `SHA384`, `SHA512`\n - `Sign`\n\n- The `tzinfo` parameter of the `Trunc` database functions doesn't work\n properly because MongoDB converts the result back to UTC.\n\n- When querying `JSONField`:\n - There is no way to distinguish between a JSON \"null\" (represented by\n `Value(None, JSONField())`) and a SQL null (queried using the `isnull`\n lookup). Both of these queries return both of these nulls.\n - Some queries with `Q` objects, e.g. `Q(value__foo=\"bar\")`, don't work\n properly, particularly with `QuerySet.exclude()`.\n - Filtering for a `None` key, e.g. `QuerySet.filter(value__j=None)`\n incorrectly returns objects where the key doesn't exist.\n - You can study the skipped tests in `DatabaseFeatures.django_test_skips` for\n more details on known issues.\n\n- Due to the lack of ability to introspect MongoDB collection schema,\n `migrate --fake-initial` isn't supported.\n\n## Troubleshooting\n\n### Debug logging\n\nTo troubleshoot MongoDB connectivity issues, you can enable [PyMongo's logging](\nhttps://pymongo.readthedocs.io/en/stable/examples/logging.html) using\n[Django's `LOGGING` setting](https://docs.djangoproject.com/en/stable/topics/logging/).\n\nThis is a minimal `LOGGING` setting that enables PyMongo's `DEBUG` logging:\n\n```python\nLOGGING = {\n \"version\": 1,\n \"disable_existing_loggers\": False,\n \"handlers\": {\n \"console\": {\n \"class\": \"logging.StreamHandler\",\n },\n },\n \"loggers\": {\n \"pymongo\": {\n \"handlers\": [\"console\"],\n \"level\": \"DEBUG\",\n },\n },\n}\n```\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
"summary": "MongoDB backend for Django",
"version": "5.0.0a3",
"project_urls": {
"Documentation": "https://django-mongodb-backend.readthedocs.io",
"Homepage": "https://www.mongodb.org",
"Source": "https://github.com/mongodb-labs/django-mongodb-backend",
"Tracker": "https://github.com/mongodb-labs/django-mongodb-backend/issues"
},
"split_keywords": [
"django",
" mongo",
" mongodb",
" pymongo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fde71d5628e8bea6f6206bf7cfac5c9e1709a55660f848b631c5e0dd87792ba0",
"md5": "c113f927cf82e9d9de9733fd2ed5c838",
"sha256": "5e89f8de38af6da2c539f0464a7898ca857a07a12b3a534d27d74b671b574558"
},
"downloads": -1,
"filename": "django_mongodb_backend-5.0.0a3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c113f927cf82e9d9de9733fd2ed5c838",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 74420,
"upload_time": "2025-01-14T14:52:14",
"upload_time_iso_8601": "2025-01-14T14:52:14.894686Z",
"url": "https://files.pythonhosted.org/packages/fd/e7/1d5628e8bea6f6206bf7cfac5c9e1709a55660f848b631c5e0dd87792ba0/django_mongodb_backend-5.0.0a3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2bb5ca4eb2060eb79edeccab9e150b4160dce7f292da9753bbab781f67285880",
"md5": "814411079db4d96d87ae067ecb027850",
"sha256": "43c9a467ed6f6b8b6c92afd4a6f5af9da7004c74f6d1390df2485200534acd3a"
},
"downloads": -1,
"filename": "django_mongodb_backend-5.0.0a3.tar.gz",
"has_sig": false,
"md5_digest": "814411079db4d96d87ae067ecb027850",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 94403,
"upload_time": "2025-01-14T14:52:16",
"upload_time_iso_8601": "2025-01-14T14:52:16.384510Z",
"url": "https://files.pythonhosted.org/packages/2b/b5/ca4eb2060eb79edeccab9e150b4160dce7f292da9753bbab781f67285880/django_mongodb_backend-5.0.0a3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 14:52:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mongodb-labs",
"github_project": "django-mongodb-backend",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "django",
"specs": [
[
">=",
"5.0"
],
[
"<",
"5.1"
]
]
},
{
"name": "pymongo",
"specs": [
[
"<",
"5.0"
],
[
">=",
"4.6"
]
]
}
],
"lcname": "django-mongodb-backend"
}
