接続オプションの指定

項目一覧

Overview

接続オプションを設定する
接続 URI の使用
mongocxx::options::clientオブジェクトの使用
接続オプションの読み取り
接続 URI オプション
レプリカセットオプション
接続オプション
接続プールオプション
書込み保証（write concern）オプション
readConcern オプション
設定オプションを読む
認証オプション
サーバーの選択と検出オプション
その他の設定

Overview

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

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

接続を構成するには、接続 URI でオプションを指定するか、 mongocxx::options::clientクラスのインスタンスをclient_optionsパラメータとしてmongocxx::clientコンストラクターに渡します。

注意

接続 URI でのみ指定できる接続オプションと、 client_optionsパラメーターでのみ指定できる接続オプションがあります。必要なオプションをすべて指定するには、これらの方法を組み合わせて使用する必要がある場合があります。

接続 URI の使用

mongocxx::clientオブジェクトを構築するときに、接続 URI を表すmongocxx::uriオブジェクトを渡すことができます。この接続 URI には、接続オプションを<name>=<value>ペアとして含めることができます。次の例では、接続 URI に、値がtrueのtlsオプションと、値がpath/to/file.pemのtlsCertificateKeyFileオプションが含まれています。

#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
#include <mongocxx/instance.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::uri uri("mongodb://<hostname>:<port>/?tls=true&tlsCertificateKeyFile=path/to/file.pem");
    mongocxx::client client(uri);
}

`mongocxx::options::client`オブジェクトの使用

mongocxx::clientコンストラクターには、 mongocxx::options::clientクラスのインスタンスを受け入れるclient_optionsパラメーターが含まれています。接続 URI にオプションを含める代わりに、 client_optionsパラメータで特定のオプションを指定できます。

次の例は、 client_optionsパラメータを使用して接続オプションを設定する方法を示しています。

#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
#include <mongocxx/instance.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::options::client client_options;
    mongocxx::options::tls tls_options;
    tls_options.pem_file("/path/to/file.pem");
    client_options.tls_opts(tls_options);
    mongocxx::uri uri("mongodb://<hostname>:<port>/?tls=true");
    mongocxx::client client(uri, client_options);
}

接続オプションの読み取り

mongocxx::clientオブジェクトを構築した後、 mongocxx::uriオブジェクトのプロパティを使用して、特定の接続オプションの値を読み取ることができます。

次の例は、 tls()プロパティを使用してtls接続オプションの値を読み取る方法を示しています。

#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
#include <mongocxx/instance.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::uri uri("mongodb://<hostname>:<port>/?tls=true");
    mongocxx::client client(uri);
    auto is_tls_enabled = uri.tls();
}

次のセクションでは、それをサポートする各接続オプションに対応するmongocxx::uriプロパティを示します。

接続 URI オプション

次のセクションでは、 C++ドライバーに渡される接続 URI で設定できる接続オプションについて説明します。各接続オプションは、 MongoDB Serverマニュアルと、対応するmongocxx::uriプロパティ（サポートされている場合）にリンクします。

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

接続 URI オプション	`mongocxx::uri` ノード
directConnection	direct_ connection()
replicaSet	レプリカ_セット()