MongoDB Django Database Backend

[https://jira.mongodb.org/browse/INTPYTHON-535](https://JIRA ISSUE CREATED)

PS: I tried using the mongodb backend to an ongoing django project, but was advised to get started from the template(at least for now). I still want to try the mongodb backend and do some benchmarks on performance as compared to postgres.

I got these two issues, maybe the team can help address, but I’m pretty sure I may have missed a step or something from the official guideline(feel free to criticize my feedback)

settings.DATABASE miss the “name” value

After starting the project from the quickstart template, there’s an error on running migrations:

Traceback (most recent call last):
  File "/Users/ca/cdc/django-mongodb/quickstart/./manage.py", line 22, in <module>
    main()
  File "/Users/ca/cdc/django-mongodb/quickstart/./manage.py", line 18, in main
    execute_from_command_line(sys.argv)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/__init__.py", line 436, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/base.py", line 413, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/base.py", line 459, in execute
    output = self.handle(*args, **options)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/base.py", line 107, in wrapper
    res = handle_func(*args, **kwargs)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/commands/makemigrations.py", line 158, in handle
    loader.check_consistent_history(connection)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/migrations/loader.py", line 313, in check_consistent_history
    applied = recorder.applied_migrations()
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/migrations/recorder.py", line 89, in applied_migrations
    if self.has_table():
       ^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/migrations/recorder.py", line 64, in has_table
    tables = self.connection.introspection.table_names(cursor)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django_mongodb_backend/introspection.py", line 10, in table_names
    return sorted([x["name"] for x in self.connection.database.list_collections()])
                                      ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django_mongodb_backend/base.py", line 155, in __getattr__
    self.connect()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/asyncio.py", line 26, in inner
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/backends/base/base.py", line 255, in connect
    conn_params = self.get_connection_params()
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django_mongodb_backend/base.py", line 166, in get_connection_params
    raise ImproperlyConfigured('settings.DATABASES is missing the "NAME" value.')
django.core.exceptions.ImproperlyConfigured: settings.DATABASES is missing the "NAME" value.

that I quickly fixed:

DATABASES = {
    "name": "default",
    "default": django_mongodb_backend.parse_uri("mongodb+srv://chrisdevcode:<pass>@djangomongo.oybyx.mongodb.net/?retryWrites=true&w=majority&appName=djangomongo"),
}
`

# AttributeError: 'str' object has no attribute 'setdefault' in django-mongodb Integration

On running the migrations again(after creating an app, from the starter template), I get the error:

```bash
(mongobackend) ➜  quickstart git:(main) ✗ ./manage.py migrate
Traceback (most recent call last):
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/asgiref/local.py", line 89, in _lock_storage
    asyncio.get_running_loop()
RuntimeError: no running event loopDuring handling of the above exception, another exception occurred:Traceback (most recent call last):
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 58, in __getitem__
    return getattr(self._connections, alias)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/asgiref/local.py", line 118, in __getattr__
    return getattr(storage, key)
           ^^^^^^^^^^^^^^^^^^^^^
AttributeError: '_thread._local' object has no attribute 'default'During handling of the above exception, another exception occurred:Traceback (most recent call last):
  File "/Users/ca/cdc/django-mongodb/quickstart/./manage.py", line 22, in <module>
    main()
  File "/Users/ca/cdc/django-mongodb/quickstart/./manage.py", line 18, in main
    execute_from_command_line(sys.argv)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/__init__.py", line 416, in execute
    django.setup()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/__init__.py", line 24, in setup
    apps.populate(settings.INSTALLED_APPS)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/apps/registry.py", line 116, in populate
    app_config.import_models()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/apps/config.py", line 269, in import_models
    self.models_module = import_module(models_module_name)
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/importlib/__init__.py", line 90, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 999, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/Users/ca/cdc/django-mongodb/quickstart/sample_mflix/models.py", line 4, in <module>
    from django_mongodb_backend.models import EmbeddedModel
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django_mongodb_backend/models.py", line 6, in <module>
    class EmbeddedModel(models.Model):
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/models/base.py", line 143, in __new__
    new_class.add_to_class("_meta", Options(meta, app_label))
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/models/base.py", line 371, in add_to_class
    value.contribute_to_class(cls, name)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/models/options.py", line 231, in contribute_to_class
    self.db_table, connection.ops.max_name_length()
                   ^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 15, in __getattr__
    return getattr(self._connections[self._alias], item)
                   ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 60, in __getitem__
    if alias not in self.settings:
                    ^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/functional.py", line 47, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
                                         ^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 45, in settings
    self._settings = self.configure_settings(self._settings)
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/utils.py", line 160, in configure_settings
    conn.setdefault("ATOMIC_REQUESTS", False)
    ^^^^^^^^^^^^^^^
AttributeError: 'str' object has no attribute 'setdefault'
(mongobackend) ➜  quickstart git:(main) ✗ ./manage.py makemigration
Traceback (most recent call last):
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/asgiref/local.py", line 89, in _lock_storage
    asyncio.get_running_loop()
RuntimeError: no running event loopDuring handling of the above exception, another exception occurred:Traceback (most recent call last):
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 58, in __getitem__
    return getattr(self._connections, alias)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/asgiref/local.py", line 118, in __getattr__
    return getattr(storage, key)
           ^^^^^^^^^^^^^^^^^^^^^
AttributeError: '_thread._local' object has no attribute 'default'During handling of the above exception, another exception occurred:Traceback (most recent call last):
  File "/Users/ca/cdc/django-mongodb/quickstart/./manage.py", line 22, in <module>
    main()
  File "/Users/ca/cdc/django-mongodb/quickstart/./manage.py", line 18, in main
    execute_from_command_line(sys.argv)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/core/management/__init__.py", line 416, in execute
    django.setup()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/__init__.py", line 24, in setup
    apps.populate(settings.INSTALLED_APPS)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/apps/registry.py", line 116, in populate
    app_config.import_models()
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/apps/config.py", line 269, in import_models
    self.models_module = import_module(models_module_name)
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/importlib/__init__.py", line 90, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 999, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/Users/ca/cdc/django-mongodb/quickstart/sample_mflix/models.py", line 4, in <module>
    from django_mongodb_backend.models import EmbeddedModel
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django_mongodb_backend/models.py", line 6, in <module>
    class EmbeddedModel(models.Model):
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/models/base.py", line 143, in __new__
    new_class.add_to_class("_meta", Options(meta, app_label))
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/models/base.py", line 371, in add_to_class
    value.contribute_to_class(cls, name)
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/models/options.py", line 231, in contribute_to_class
    self.db_table, connection.ops.max_name_length()
                   ^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 15, in __getattr__
    return getattr(self._connections[self._alias], item)
                   ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 60, in __getitem__
    if alias not in self.settings:
                    ^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/functional.py", line 47, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
                                         ^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/utils/connection.py", line 45, in settings
    self._settings = self.configure_settings(self._settings)
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/anaconda3/envs/mongobackend/lib/python3.12/site-packages/django/db/utils.py", line 160, in configure_settings
    conn.setdefault("ATOMIC_REQUESTS", False)
    ^^^^^^^^^^^^^^^
AttributeError: 'str' object has no attribute 'setdefault' 
```

I honestly don't know how to tackle that(may need more time to go through the package source to understand)
1 Like

Thank you for using Django MongoDB Backend!

Try including the database name in the URI:

DATABASES = {
    "default": django_mongodb_backend.parse_uri("mongodb+srv://chrisdevcode:<pass>@djangomongo.oybyx.mongodb.net/default?retryWrites=true&w=majority&appName=djangomongo"),
}

Or try configuring the NAME setting like this:

DATABASES = {
    "default": django_mongodb_backend.parse_uri("mongodb+srv://chrisdevcode:<pass>@djangomongo.oybyx.mongodb.net/?retryWrites=true&w=majority&appName=djangomongo"),
}

DATABASES["default"]["NAME"] = "default"

Also in the beta 1 release of Django MongoDB Backend, you’ll be able to do this:

DATABASES = {
    "default": django_mongodb_backend.parse_uri("mongodb+srv://chrisdevcode:<pass>@djangomongo.oybyx.mongodb.net/?retryWrites=true&w=majority&appName=djangomongo", db_name="default"),
}

See: INTPYTHON-509 Add db_name parameter to parse_uri() by timgraham · Pull Request #249 · mongodb/django-mongodb-backend · GitHub for more information.

2 Likes