/ /

/ /

接続オプションの指定

Overview

このページでは、 PHPライブラリで使用できるMongoDBの接続オプションと認証オプションについて説明します。

接続オプションを設定する

接続 URI でオプションを指定するか、それを MongoDB\Clientコンストラクターに渡すことで接続を構成できます。

接続 URI の使用

MongoDB\Clientコンストラクターに接続 URI を渡す場合は、接続オプションを<name>=<value>ペアとして URI に含めることができます。次の例では、接続 URI はtlsオプションをtrueに、 tlsCertificateKeyFileオプションを/path/to/file.pemに設定します。

// Replace the placeholders with your actual hostname, port, and path to the certificate key file
$uri = 'mongodb://<hostname>:<port>/?tls=true&tlsCertificateKeyFile=/path/to/file.pem';
// Create a MongoDB client
$client = new MongoDB\Client($uri);

MongoDB $ Client オブジェクトの使用

接続 URI に接続オプションを含める代わりに、 MongoDB\Clientコンストラクターに接続オプションを渡すことができます。

次の例は、 MongoDB\Clientコンストラクターの$uriOptionsパラメーターを使用して接続オプションを設定する方法を示しています。

// Replace the placeholders with your actual hostname and port
$uri = 'mongodb://<hostname>:<port>/';
// Set the connection options
// Replace the placeholder with the actual path to the certificate key file
$uriOptions = [
    'tls' => true,
    'tlsCertificateKeyFile' => '/path/to/file.pem',
];
// Create a MongoDB client with the URI and options
$client = new Client($uri, $uriOptions);

注意

$uriOptionsパラメータと接続 URI の両方にオプションを指定する場合は、 $uriOptionsの値が優先されます。

接続 URI オプション

次のセクションでは、 MongoDB. への接続に設定できるオプションについて説明します。各接続オプションは、 MongoDB Serverマニュアル内の対応するエントリにリンクします。

重要

パーセントエンコーディング

接続オプションの値に特殊文字が含まれている場合は、接続 URI に含める前に、値をパーセントエンコードする必要があります。RFC 3986 で指定されている URI構文に従ってこれらの値をエンコードするには、rawurlencode() メソッドを使用します。

接続オプションを$uriOptionsパラメーターに含める場合、パーセントエンコードしないでください。

詳細については、以下のリソースを参照してください。

RFC 3986
ローリングコード（ PHPマニュアルの参照）

レプリカセットオプション

接続オプション	説明
directConnection	Data Type: `bool` MongoDB\Client Example: `$uriOptions = ['directConnection' => true];` Connection URI Example: `directConnection=true`
replicaSet	Data Type: `string` MongoDB\Client Example: `$uriOptions = ['replicaSet' => 'replicaSetName'];` Connection URI Example: `replicaSet=replicaSetName`