/ /

MongoDB に接続する

Overview

このガイドでは、Diango プロジェクトのMongoDBへの接続を構成する方法を学習できます。

接続構成

Dlango MongoDBバックエンドをインストールし、プロジェクトを作成したら、プロジェクトの settings.pyファイルで DATABASES 設定を変更して、 MongoDBへの接続を構成できます。

Tip

Dpango MongoDBバックエンドをインストールし、Dlangoプロジェクトを作成する方法については、「 MongoDBバックエンドを使い始める」チュートリアルを参照してください。

次のコードに示すように、default キーを含む辞書に DATABASES を設定します。

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

default キーを設定するには、その値としてネストされた辞書を割り当てます。このネストされた辞書には次のキーがあります。

キー	説明
エンジン	接続に使用するバックエンドドライバー。このキーを `"django_mongodb_backend"` に設定します。
Host	ホスト名。ローカルホスト接続の場合、このキーは任意です。 SRV 接続の場合は、スキームプレフィックス（）を含める必要があります。このキーで接続`mongodb+srv://` URI を指定することもできます。詳細については、「データベース設定の自動構成」を参照してください。複数のホストを指定するには、すべてのホスト名を 1 つの string に含めます。各ホスト名はカンマで区切ります。例:`"HOST": "mongodb://mongos0.example.com:27017,mongos1.example.com:27017"`
名前	使用するデータベース。
USER	接続に認証が必要な場合は、データベースに認証するためのユーザー名。
PASSWORD	接続に認証が必要な場合は、データベースユーザーのパスワード。
ポート	データベースサーバーがリッスンしているポート番号。デフォルトのポートは`27017` です。 MongoDB Atlas接続の場合、このキーは任意です。
オプション	データベースの追加の接続オプションの辞書。このキーは任意です。 `OPTIONS`キーで設定できる接続オプションの完全なリストについては、 PyMongo APIドキュメントの MongoClient の任意のパラメータを参照してください。

このセクションでは、DATABASES 設定を使用して次の方法で接続を構成する方法について説明します。

データベース設定を自動的に構成する : ネストされた HOST キーを使用して接続 URI を指定し、接続設定を自動的に構成します。
データベース設定を手動で構成する : 複数の辞書キーにわたる接続設定を指定します。

データベース設定の自動構成

重要

v5.2.1 で追加

Django MongoDBバックエンド v5.2.1は、ネストされた HOST キーで接続 URI を指定するためのサポートを追加します。前のバージョンを使用している場合でも、接続を手動で構成したり、非推奨のparse_uri() 関数を使用したりできます。

接続 URI で接続設定を指定するには、次のネストされた default キーを設定します。

ENGINE: "django_mongodb_backend"に設定します。
HOST: 接続 URI に設定します。
NAME: 使用するデータベースの名前に設定します。

前のセクションで説明されているその他のキーはすべてオプションです。

例

この例では、ENGINE、HOST、NAME キーのみを使用してMongoDBへの接続を構成しています。DATABASES 設定は次のアクションを実行します。

ユーザー名が my_user でパスワードが my_password のデータベースユーザーの認証情報を提供します
retryWrites 接続オプションを true に設定し、失敗した場合に特定の書込み操作を自動的に再試行するようにドライバーを構成します
w 接続オプションを majority に設定します。これにより、書込み操作を実行する前に、過半数のレプリカセットノードからの確認を待機するようにドライバーが構成されます
データベースをに設定します 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",
}

注意

DATABASES 設定で追加のキーを指定すると、それらのキーの値が接続 URI から解析された競合する値を上書きします。

データベース設定の手動構成

default キー全体で接続情報を指定することで、接続設定を手動で構成できます。

例

この例では、辞書キーを使用して、前の例と同じデータベース接続を構成しています。

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",
        },
    },
}

詳細情報

MongoDBデータベース接続を構成するサンプルプロジェクトを表示するには、はじめにチュートリアルの「 MongoDB接続の構成」ステップを参照してください。

Diango 設定の詳細については、Diango ドキュメントの設定を参照してください。

戻る

はじめる

モデルデータ