Overview
このガイドでは、Lambda MongoDB を使用して、Lambel アプリケーションを MongoDB インスタンスまたはレプリカセットの配置に接続する方法を学習できます。
このガイドには、次のセクションが含まれています。
Connection URI, which explains connection URIs and their constituent parts
Laravel Database Connection Configuration, which explains how to set up your MongoDB database connection for your Laravel app.
Connection Example, which provides examples that show how to connect to MongoDB by using an Atlas connection string.
「 MongoDB に接続するその他の方法 」では、Atlas でホストされていない MongoDB 配置に接続する方法について説明します。
接続URI
接続 URI （ 接続stringとも呼ばれます）は、Lambda 統合がMongoDBに接続する方法と、接続中の動作を指定します。
接続 URI の一部
接続文字列には、次のコンポーネントが含まれます。
コンポーネント | 説明 |
|---|---|
| Required. A prefix that identifies the URI as a string in the standard connection format ( For more information, see Connection String Formats. |
| 任意。認証用のデータベースユーザー名とパスワードを 配置で認証 が必要ない場合は、このセクションを省略します。 |
| 必須。 MongoDB が実行されているホストとオプションのポート番号。 ポート番号を指定しない場合、ドライバーはデフォルトのポート Note that specifying the port number is only supported when using the standard connection format. If you are using the SRV connection format, omit the port number. |
| 任意。 接続stringに Can also be the application database if and only if the |
| 任意。接続固有のオプションを |
次の例では、プロトコル、認証情報、ホスト名とポート、および接続オプションを指定する完全な接続 URI を示しています。
mongodb://myUser:myPass123@localhost:27017/?w=majority&retryWrites=true
For more information on connection strings, see Connection Strings in the Server manual manual.
Lambda データベース接続の構成
Lambda 統合を使用すると、 config/database.php Lambda アプリケーション ファイルで MongoDB database 接続を構成できます。 このファイルでは、次の接続の詳細を指定できます。
defaultは、指定されていない場合に使用するデータベース接続を指定します。connectionsは、アプリケーションから 1 つ以上のデータベースにアクセスするためのデータベース接続情報を含みます。
構成ファイルで次のコードを使用して、 connections配列内の対応するmongodbエントリへのデフォルト接続を設定できます。
'default' => 'mongodb',
MongoDB データベース接続の場合、次の詳細を指定できます。
設定 | 説明 | ||
|---|---|---|---|
| 接続に使用するデータベースドライバーを指定します。 | ||
| MongoDB 接続 URI を指定するデータソース名（DSN）。 | ||
| 配置における 1 つ以上の MongoDB ノードのネットワークアドレスとポートを指定します。この設定は、 複数のホストを指定するには、次の例に示すように、それらを配列で渡します。 注意 このオプションは、DNS シードリスト接続形式を使用するホストを受け入れません。 | ||
| 読み取りおよび書込み先の MongoDB database の名前を指定します。 | ||
| MongoDB で認証するためのデータベースユーザーのユーザー名認証情報を指定します。 | ||
| MongoDB で認証するためのデータベースユーザーのパスワード認証情報を指定します。 | ||
| 接続動作を決定する MongoDB に渡す接続オプションを指定します。 接続オプションの詳細については、「接続オプションと認証オプション 」を参照してください。 | ||
| その接続のドライバーの動作を決定する MongoDB PHP ライブラリに渡す固有のオプションを指定します。 ドライバー オプションの詳細については、「ドライバー接続オプション 」を参照してください。 |
注意
dsn 構成では、配列項目としてではなく、 MongoDB接続stringのパラメーターとして指定できます。
hostusernamepasswordoptionsとdriver_optionsは、オプション名で指定されます
重要
Lambda 統合は、prefix と prefix_indexes の接続設定をサポートしていません。
次の例は、 connections配列項目で MongoDB 接続の詳細を指定する方法を示しています。
'connections' => [ 'mongodb' => [ 'driver' => 'mongodb', 'dsn' => 'mongodb+srv//myUser:myPass123@sample.host/', 'database' => 'sample_mflix', 'options' => [ 'w' => 'majority', ], 'driver_options' => [ 'serverApi' => 1, ], ], // ... ],
次のセクションでは、MongoDB 接続を指定する一般的な方法について説明します。
接続例
このセクションでは、 MongoDB Atlas接続stringを使用して Lambda アプリケーションの DSN を構成する方法を示します。
MongoDB DSN を Lambda アプリケーションに追加するには、次の変更を行います。
プロジェクトの
.env環境構成ファイルに、環境変数として DSN を追加します。 変数の値をAtlas接続stringに設定します。config/database.php構成ファイルのconnections配列に MongoDB 接続用の接続エントリを追加します。 接続エントリのdsn値を設定して、DSN を含む環境変数を参照します。
次の例えは、関連する構成ファイルで接続stringとして "mongodb+srv://myUser:myPass123@mongodb0.example.com/" を指定する方法を示しています。
DB_URI="mongodb+srv://myUser:myPass123@mongodb0.example.com/"
'connections' => [ 'mongodb' => [ 'dsn' => env('DB_URI'), // uses the value of the DB_URI environment variable 'driver' => 'mongodb', 'database' => 'sample_mflix', // ... ], // ... ]
Tip
Atlas接続stringを取得するには、クイック スタート チュートリアルの「接続stringの作成」の手順に従います。
MongoDB に接続する他の方法
次のセクションでは、単一の MongoDB サーバー インスタンスまたは MongoDB Atlas でホストされていないレプリカセットに接続する方法を示します。
ローカルマシン上の MongoDB Server への接続
このセクションでは、ローカル開発環境などの同じマシンからstring Lambda アプリケーションとMongoDB サーバーを実行する場合に使用できる接続 の例を示します。
アプリケーションを同じマシンでホストされている MongoDB インスタンスに接続するには、次のタスクを実行する必要があります。
MongoDB サーバーをダウンロード、インストール、実行します。
MongoDB サーバーが実行されている IP アドレスとポートを取得します。 MongoDB サーバーのローカル インストールのデフォルト設定を使用する場合、IP アドレスは
127.0.0.1で、ポートは27017です。接続例セクションに示されているように、
dsnの値について環境変数DB_URIを参照するようにconfig/database.php接続を設定します。
次の例は、アプリケーションがデフォルトのstring .envMongoDBIPアドレスとポートで実行されている サーバーに接続する場合に、 ファイルに追加できるサンプル接続 を示しています。
DB_URI="mongodb://127.0.0.1:27017/";
To learn how to download and install MongoDB server, see Install MongoDB Community Edition in the Server manual.
レプリカセットへの接続
MongoDB レプリカセットの配置は、接続されたインスタンス、つまりノードのグループであり、ノードは同じデータセットを保存します。 このインスタンスの構成は、データの冗長性と高いデータ可用性を提供します。
レプリカセットの配置に接続するには、各ノードのホスト名とポート番号をカンマで区切って指定し、レプリカセット名を 接続stringの replicaSet パラメータの値として指定します。
レプリカセットに接続するために Lambda アプリケーションの .env ファイルに追加できる接続stringを示すこの例では、次のサンプル値を使用します。
host1MongoDB ノードのホスト名は 、host2、host3で、27017は、それらのホスト上で MongoDB が実行されるポートとして、myRSとして、レプリカセットの設定された名前myUserデータベースユーザーの認証情報としての とmyPass123
DB_URI="mongodb://myUser:myPass123@host1:27017,host2:27017,host3:27017/?replicaSet=myRS"
レプリカセットに接続する際、Lambda 統合が MongoDB との接続を管理するために使用するライブラリは、特に指定されていない限り、次のアクションを実行します。
いずれかのノードのアドレスが指定されると、レプリカセットのすべてのノードを検出します。
プライマリノードに対する書込み指示などの操作を適切なメンバーに送信します。 レプリカセット プライマリの詳細については、サーバー マニュアルの「レプリカセット プライマリ」を参照してください。
Tip
レプリカセットに接続するには、1 つのホストのみを指定する必要があります。 ただし、選択したホストが利用できない場合でも接続できるようにするには、ホストの全リストを提供します。
MongoDB レプリカセットのセットアップの詳細については、サーバー マニュアルの「レプリカセットの配置 」を参照してください。
直接接続
MongoDBレプリカセット内の特定のノードで操作を強制的に実行するには、接続stringにノードの接続情報と、true 値を持つ directConnection パラメーターを指定します。
直接接続には、次の制限があります。
DNS シードリスト接続形式の接続文字列は使用できません。
指定されたホストがプライマリでない場合、書き込み操作は失敗します。
When the host is not the primary, you must specify the
secondaryread preference in your connection options. To learn more about this limitation, see the secondary read preference entry in the Server manual.
次の例は、string レプリカセット内のセカンダリ.env ノードへの直接接続を確立するために Atlas アプリケーションの ファイルに追加できる接続MongoDB を示しています。この例では、次のサンプル値を使用します。
host2: セカンダリ ノードのホスト名27017: MongoDB ノードが listen するポート:
DB_URI="mongodb://host2:27017/?directConnection=true&readPreference=secondary"