Configure sua conexão de banco de dados

Visão geral

Neste guia, você aprenderá a configurar a conexão do seu projeto Django com o MongoDB.

Configuração da conexão

Após instalar o Django MongoDB Backend e criar um projeto, você poderá configurar sua conexão com o MongoDB modificando a configuração do DATABASES no arquivo settings.py do seu projeto.

Dica

Para saber como instalar o Django MongoDB Backend e criar um projeto Django, acesse o tutorial de Introdução.

Defina DATABASES para um dicionário que contenha a chave default, conforme mostrado no seguinte código:

DATABASES = {
    "default": {
        # Specify nested dictionary keys here
    },
}

Para configurar a chave default, atribua um dicionário aninhado como seu valor. Este dicionário aninhado tem as seguintes chaves:

Chave	Descrição
Mecanismo	O driver de backend a ser usado para a conexão. Defina esta chave como `"django_mongodb_backend"`.
Anfitrião	The hostname. For localhost connections, this key is optional. For SRV connections, you must include a scheme prefix (`mongodb+srv://`). You can also specify a connection URI in this key. For more information, see Automatically Configure Database Settings. To specify more than one host, include all hostnames in one string. Use a comma to separate each hostname. Example: `"HOST": "mongodb://mongos0.example.com:27017,mongos1.example.com:27017"`
Nome	O banco de dados que você deseja usar.
USUÁRIO	O nome de usuário para autenticar no banco de dados, se sua conexão exigir autenticação.
PASSWORD	A senha do usuário de banco de dados, se a conexão exigir autenticação.
Porta	The port number on which the database server is listening. The default port is `27017`. For MongoDB Atlas connections, this key is optional.
Opções	A dictionary of additional connection options for the database. This key is optional. To see a full list of connection options that you can set in the `OPTIONS` key, see the optional parameters for MongoClient in the PyMongo API documentation.

Esta seção mostra como usar a configuração DATABASES para configurar sua conexão das seguintes maneiras:

Configurar automaticamente as configurações do banco de dados: Use a chave HOST aninhada para especificar seu URI de conexão e definir as configurações de conexão automaticamente.
Configurar manualmente as configurações do banco de dados: Especifique as configurações de conexão em várias chaves de dicionário.

Definir automaticamente as configurações do banco de dados

Importante

Adicionado em v5.2.1

Django MongoDB Backend v5.2.1 adiciona suporte para especificar um URI de conexão na chave HOST aninhada. Se você usar uma versão anterior, ainda poderá configurar manualmente sua conexão ou usar a função parse_uri().

Para especificar as configurações de conexão em seu URI de conexão, defina as seguintes chaves default aninhadas:

ENGINE: Defina como "django_mongodb_backend".
HOST: defina o URI de sua conexão.
NAME: Defina o nome do banco de dados que você deseja usar.

Todas as outras chaves descritas na seção anterior são opcionais.

Exemplo

Este exemplo utiliza somente as chaves ENGINE, HOST e NAME para configurar uma conexão com MongoDB. A configuração DATABASES executa as seguintes ações:

Fornece informações de autenticação para um usuário de banco de dados cujo nome de usuário é my_user e senha é my_password
Define a opção de conexão retryWrites como true, que configura o driver para repetir automaticamente determinadas operações de gravação se elas falharem
Define a opção de conexão w para majority, que configura o driver para aguardar a confirmação da maioria dos membros do conjunto de réplicas antes de executar operações de gravação
Define o banco de dados como my_database

DATABASES = {
    "default": {
        "ENGINE": "django_mongodb_backend",
        "HOST": "mongodb+srv://my_user:my_password@cluster0.example.mongodb.net/?retryWrites=true&w=majority",
        "NAME": "my_database",
}

Observação

Se você especificar chaves adicionais na configuração DATABASES, os valores nessas chaves substituirão quaisquer valores conflitantes analisados a partir do URI de conexão.

Definir manualmente as configurações do banco de dados

Você pode definir manualmente suas configurações de conexão especificando informações de conexão entre as chaves default.

Exemplo

Este exemplo utiliza chaves de dicionário para configurar a mesma conexão de banco de dados do exemplo anterior:

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": {
            "retryWrites": "true",
            "w": "majority",
        },
    },
}

Informações adicionais

Para visualizar um projeto de exemplo que configura uma conexão de banco de dados MongoDB , consulte a etapa Configurar sua conexão MongoDB no tutorial de Introdução.

Para saber mais sobre as configurações do Django, consulte Configurações na documentação do Django.

Voltar

Próximos passos

Modele seus dados