接続オプションの指定

ConnectTimeout

タイムアウトする前にドライバーがサーバーへの単一の TCP ソケット接続を確立しようとする時間の長さ。

データ型： integer

デフォルト値: 10000 （10 秒）

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?connectTimeoutMS=60000");

SocketTimeout

ドライバーがタイムアウトする前にソケット上で送信または受信を試みる時間の長さ。デフォルト値はオペレーティング システムによって設定されます。

データ型： integer

デフォルト値: 300000 （5 分）

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?socketTimeoutMS=60000");

ConnectTimeout

タイムアウトする前にドライバーがサーバーへの単一の TCP ソケット接続を確立しようとする時間の長さ。

データ型： integer

デフォルト値: 10000 （10 秒）

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_CONNECTTIMEOUTMS, 60000);

SocketTimeout

ドライバーがタイムアウトする前にソケット上で送信または受信を試みる時間の長さ。デフォルト値はオペレーティング システムによって設定されます。

データ型： integer

デフォルト値: 300000 （5 分）

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_SOCKETTIMEOUTMS, 60000);

コンプレッサー

サーバーとの間で送受信されるワイヤ プロトコル メッセージの圧縮には、次の順でこれらのタイプが推奨されます。ビルド時の任意の依存関係として、"snappy" 、"zlib" 、"zstd" を有効にできます。ドライバーは、サーバーがサポートするこれらの圧縮タイプの最初のものを使用します。

データ型： char*

デフォルト値: NULL

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?compressors=zlib,snappy");

コンプレッサー

サーバーとの間で送受信されるワイヤ プロトコル メッセージの圧縮には、次の順でこれらのタイプが推奨されます。ビルド時の任意の依存関係として、"snappy" 、"zlib" 、"zstd" を有効にできます。ドライバーは、サーバーがサポートするこれらの圧縮タイプの最初のものを使用します。

データ型： char*

デフォルト値: NULL

例:

mongoc_uri_set_option_as_utf8(uri, MONGOC_URI_COMPRESSORS, "zlib,snappy");

maxPoolSize

ドライバーが接続プール内で作成できるクライアントまたは接続の最大数。このカウント数には、使用中の接続が含まれます。

データ型： integer

デフォルト値: 100

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?maxPoolSize=150");

WaitQueueTimeout

ドライバーがタイムアウトする前にサーバーの接続プールから接続をチェックアウトしようとする時間の長さ。

データ型： integer

デフォルト値: -1 （タイムアウトなし）

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?waitQueueTimeoutMS=30000");

MaxConnectionPoolSize

ドライバーが接続プール内で作成できるクライアントまたは接続の最大数。このカウント数には、使用中の接続が含まれます。

データ型： integer

デフォルト値: 100

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_MAXPOOLSIZE, 150)

mongoc_client_pool_t 構造を使用して最大接続プールサイズを設定することもできます。

mongoc_client_pool_t *pool = mongoc_client_pool_new(uri);
// Specifies max pool size 
mongoc_client_pool_max_size(pool, 150);

WaitQueueTimeout

ドライバーがタイムアウトする前にサーバーの接続プールから接続をチェックアウトしようとする時間の長さ。

データ型： integer

デフォルト値: 0

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_WAITQUEUETIMEOUTMS, 30000);

w

書込み保証 (write concern)の w コンポーネント。指定された数のMongoDBインスタンスに書込み (write)操作が反映されたことの確認応答を要求します。デフォルト値は、アービタと投票ノードの数に応じて "majority" または 1 です。w オプションの詳細については、 MongoDB Serverマニュアルの書込み保証を参照してください。

データ型： integer or char*

デフォルト値: 1 or "majority"

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?w=2");

w タイムアウト

書込み保証 (write concern)の時間制限を指定する書込み保証 (write concern)の wtimeoutms コンポーネント。wtimeout オプションの詳細については、 MongoDB Serverマニュアルの書込み保証を参照してください。

データ型： integer

デフォルト値: 0

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?wTimeoutMS=5000");

Journal

書込み保証 (write concern)の j コンポーネントは、 MongoDBインスタンスがオンディスクのジャーナルに書き込んだことの確認を要求します。

データ型： boolean

デフォルト値: false

jオプションの詳細については、 MongoDB Serverマニュアルの「 書込み保証 」を参照してください。

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?journal=true");

w

書込み保証 (write concern)の w コンポーネント。指定された数のMongoDBインスタンスに書込み (write)操作が反映されたことの確認応答を要求します。デフォルト値は、アービタと投票ノードの数に応じて "majority" または 1 です。w オプションの詳細については、 MongoDB Serverマニュアルの書込み保証を参照してください。

データ型： integer or char*

デフォルト値: 1 or "majority"

MONGOC_URI_W オプションを使用して w を設定できます。

例:

// Use the int32 version of the mongoc_uri_t set function to set integer values
mongoc_uri_set_option_as_int32(uri, MONGOC_URI_W, 2); 
// Use the utf8 version of the mongoc_uri_t set function to set string values 
mongoc_uri_set_option_as_utf8(uri, MONGOC_URI_W, "majority"); 

mongoc_write_concern_t 構造を使用して w を設定することもできます。

// Creates a write concern structure
mongoc_write_concern_t *write_concern = mongoc_write_concern_new();
// Sets w=2
mongoc_write_concern_set_w(write_concern, 2);
mongoc_client_set_write_concern(client, write_concern);

w タイムアウト

書込み保証 (write concern)の時間制限を指定する書込み保証 (write concern)の wtimeoutms コンポーネント。wtimeout オプションの詳細については、 MongoDB Serverマニュアルの書込み保証を参照してください。

データ型： integer

デフォルト値: 0

MONGOC_URI_WTIMEOUTMS オプションを使用して wtimeoutms を設定できます。

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_WTIMEOUTMS, 5000); 

mongoc_write_concern_t 構造を使用して wtimeoutms を設定することもできます。

// Creates a write concern structure
mongoc_write_concern_t *write_concern = mongoc_write_concern_new();
// Sets w=2
mongoc_write_concern_set_wtimeout(write_concern, 5000);
// Apply write concern to client
mongoc_client_set_write_concern(client, write_concern);

Journal

書込み保証 (write concern)の j コンポーネントは、 MongoDBインスタンスがオンディスクのジャーナルに書き込んだことの確認を要求します。デフォルト値は、writeConcernMajorityJournalDefault 設定の値によって異なります。j オプションの詳細については、 MongoDB Serverマニュアルの「 書込み保証 」を参照してください。

データ型： boolean

デフォルト値: false

MONGOC_URI_JOURNAL オプションを使用して journal を設定できます。

例:

mongoc_uri_set_option_as_bool(uri, MONGOC_URI_JOURNAL, true);

mongoc_write_concern_t 構造を使用して journal を設定することもできます。

// Creates a write concern structure
mongoc_write_concern_t *write_concern = mongoc_write_concern_new();
// Sets journal to true
mongoc_write_concern_set_journal(write_concern, true);
// Apply write concern to client
mongoc_client_set_write_concern(client, write_concern);

読み取り保証レベル

クライアントの読み取り保証 (read concern) ) レベル詳細については、MongoDB Serverマニュアルの読み取り保証 (read concern)のリファレンスを参照してください。

データ型： char*

デフォルト値: local

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?readConcernLevel=local");

読み取り保証レベル

クライアントの読み取り保証 (read concern) ) レベル詳細については、MongoDB Serverマニュアルの読み取り保証 (read concern)のリファレンスを参照してください。

データ型： char*

デフォルト値: local

読み取り保証 (read concern)レベルは、MONGOC_URI_READCONCERNLEVEL オプションを使用して設定できます。

例:

mongoc_uri_set_option_as_utf8(uri, MONGOC_URI_READCONCERNLEVEL, "local")

mongoc_read_concern_t 構造を使用して読み取り保証 (read concern)レベルを設定することもできます。

mongoc_read_concern_t *read_concern = mongoc_read_concern_new();
// Set the read concern level to "local"
mongoc_read_concern_set_level(read_concern, MONGOC_READ_CONCERN_LEVEL_LOCAL);
mongoc_client_set_read_concern(client, read_concern); 

読み込み設定 (read preference)

クライアントのデフォルトの読み取り設定。詳細については、 MongoDB Serverマニュアルの「 読み込み設定 」を参照してください。

データ型： char*

デフォルト値: primary

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?readPreference=primaryPreferred");

maxstaleness

Max Staleness 秒は、セカンダリで発生してもサーバー選択の対象となる最長のレプリケーションラグ を、ウォール クロック時間で表します。maxStalenessSeconds に許可される最小値は 90 秒です。このオプションは、非プライマリの読み込み設定 (read preference)で使用する必要があります。

データ型： integer

デフォルト値: -1

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?readPreference=secondary&maxStalenessSeconds=120");

LocalThreshold

サーバーの選択対象となるレイテンシウィンドウ。サーバーの往復時間が、最速のサーバーの往復時間とこの値を合わせた値より長い場合、そのサーバーは選択対象になりません。

データ型： integer

デフォルト値: 15

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?localThresholdMS=150");

読み込み設定 (read preference)

クライアントのデフォルトの読み取り設定。詳細については、 MongoDB Serverマニュアルの「 読み込み設定 」を参照してください。

データ型： char*

デフォルト値: primary

読み込み設定 (read preference)は、mongoc_read_prefs_t 構造を使用して設定できます。

例:

mongoc_client_t *client = mongoc_client_new("mongodb+srv://localhost:27017/");
// Specifies the read preference 
mongoc_read_prefs_t *read_prefs = mongoc_read_prefs_new(MONGOC_READ_PRIMARY_PREFERRED);
mongoc_client_set_read_prefs(client, read_prefs);

MONGOC_URI_READPREFERENCE オプションを使用して読み込み設定 (read preference)を設定することもできます。

mongoc_uri_set_option_as_utf8(uri, MONGOC_URI_READPREFERENCE, "primaryPreferred")

maxstaleness

Max Staleness 秒は、セカンダリで発生してもサーバー選択の対象となる最長のレプリケーションラグ を、ウォール クロック時間で表します。maxStalenessSeconds に許可される最小値は 90 秒です。このオプションは、非プライマリの読み込み設定 (read preference)で使用する必要があります。

データ型： integer

デフォルト値: -1

例:

mongoc_client_t *client = mongoc_client_new("mongodb+srv://localhost:27017/");
mongoc_read_prefs_t *read_prefs = mongoc_read_prefs_new(MONGOC_READ_SECONDARY);
// Specifies max staleness to 120 seconds
mongoc_read_prefs_set_max_staleness_seconds(read_prefs, 120);
mongoc_client_set_read_prefs(client, read_prefs);

LocalThreshold

サーバーの選択対象となるレイテンシウィンドウ。サーバーの往復時間が、最速のサーバーの往復時間とこの値を合わせた値より長い場合、そのサーバーは選択対象になりません。

データ型： integer

デフォルト値: 15

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_LOCALTHRESHOLDMS, 150);

認証メカニズム

ドライバーがMongoDB Serverに対して認証するために使用するメカニズム。認証メカニズムを指定しない場合、ドライバーはサーバーのバージョンに応じてSCRAM-SHA-1またはSCRAM-SHA-256のいずれかを使用します。

利用可能な認証メカニズムの詳細については、 認証メカニズム または エンタープライズ認証メカニズム のガイドを参照してください。

データ型： char*

デフォルト値: SCRAM-SHA-256 （ MongoDB 4.0 以降の場合）

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?authSource=admin&authMechanism=GSSAPI");

認証メカニズム

ドライバーがMongoDB Serverに対して認証するために使用するメカニズム。認証メカニズムを指定しない場合、ドライバーはサーバーのバージョンに応じてSCRAM-SHA-1またはSCRAM-SHA-256のいずれかを使用します。

利用可能な認証メカニズムの詳細については、 認証メカニズム または エンタープライズ認証メカニズム のガイドを参照してください。

データ型： char*

デフォルト値: SCRAM-SHA-256 （ MongoDB 4.0 以降の場合）

例:

mongoc_uri_set_auth_mechanism(uri, "GSSAPI");

ハートビート頻度

サーバーモニタリングチェックの間隔。500 ミリ秒以上である必要があります。デフォルト値は、プール型（マルチスレッド）モードでは 10000 ミリ秒（10 秒）、非プール（シングルスレッド）モードでは 60000 ミリ秒（60 秒）です。

データ型： integer

デフォルト値: 10000 プールされたクライアントの場合は 、シングルスレッド クライアントの場合は 60000

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?heartbeatFrequencyMS=5000");

ServerSelectionTimeout

ドライバーがタイムアウトする前にサーバーを選択しようとする時間の長さ。

データ型： integer

デフォルト値: 30000

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?serverSelectionTimeoutMS=40000");

ソケット チェック間隔

シングル スレッド クライアントにのみ適用されます。時間内にソケットが使用されていない場合、ドライバーは高速に "hello" で接続を確認します。再度使用される前に、 を呼び出します。

データ型： integer

デフォルト値: 5000

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?socketCheckIntervalMS=10000");

ハートビート頻度

サーバーモニタリングチェックの間隔。500 ミリ秒以上である必要があります。デフォルト値は、プール型（マルチスレッド）モードでは 10000 ミリ秒（10 秒）、非プール（シングルスレッド）モードでは 60000 ミリ秒（60 秒）です。

データ型： integer

デフォルト値: 10000

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_HEARTBEATFREQUENCYMS, 5000);

ServerSelectionTimeout

ドライバーがタイムアウトする前にサーバーを選択しようとする時間の長さ。

データ型： integer

デフォルト値: 30000

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_SERVERSELECTIONTIMEOUTMS, 40000);

ソケット チェック間隔

シングル スレッド クライアントにのみ適用されます。時間内にソケットが使用されていない場合、ドライバーは高速に "hello" で接続を確認します。再度使用される前に、 を呼び出します。

データ型： integer

デフォルト値: 5000

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_SOCKETCHECKINTERVALMS, 10000);

RetryReads

再試行可能な読み取りを有効にします。

データ型： boolean

デフォルト値: true

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?retryReads=false");

RetryWrites

再試行可能な書き込みを有効にします。

データ型： boolean

デフォルト値: true TLS サポート付き、それ以外の場合は false

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?retryWrites=false");

RetryReads

再試行可能な読み取りを有効にします。

データ型： boolean

デフォルト値: true

例:

mongoc_uri_set_option_as_bool(uri, MONGOC_URI_RETRYREADS, false)

RetryWrites

再試行可能な書き込みを有効にします。

データ型： boolean

デフォルト値: true

例:

mongoc_uri_set_option_as_bool(uri, MONGOC_URI_RETRYWRITES, false);

ApplicationName

接続ハンドシェイクの一環として、ドライバーがクライアント メタデータでサーバーに渡すアプリ名。接続が確立されると、サーバーはこの値を MongoDB ログに出力します。この値は、ログ ファイル、スロークエリ ログ、プロファイル コレクションにも記録されます。

データ型： char*

デフォルト値: 空

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?appName=yourAppName");

LoadBalanced

ドライバーが ロードバランサーに接続しているかどうかを指定します。このプロパティは、次の条件が すべて 満たされている場合にのみ、 true に設定できます。

• ホスト名を 1 つだけ指定

• レプリカセットに接続していません。

• SrvMaxHostsプロパティを使用していません

• DirectConnectionプロパティを使用していません

データ型： boolean

デフォルト値: false

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?loadBalanced=true");

SrvMaxHosts

シードリストを初期設定するとき、または SRV ポーリング中にトポロジーに新しいホストを追加するときにランダムに選択する SRV 結果の最大数。

このプロパティは、接続文字列スキームが ConnectionStringScheme.MongoDBPlusSrv に設定されている場合にのみ使用できます。レプリカセットに接続する場合は、 を使用できません。

データ型： integer

デフォルト値: 0

例:

mongoc_uri_t *uri = mongoc_uri_new("mongodb+srv://localhost:27017/?srvMaxHosts=5");

ApplicationName

接続ハンドシェイクの一環として、ドライバーがクライアント メタデータでサーバーに渡すアプリ名。接続が確立されると、サーバーはこの値を MongoDB ログに出力します。この値は、ログ ファイル、スロークエリ ログ、プロファイル コレクションにも記録されます。

データ型： char*

デフォルト値: empty

例:

mongoc_uri_set_option_as_utf8(uri, MONGOC_URI_APPNAME, "yourAppName");

LoadBalanced

ドライバーが ロードバランサーに接続しているかどうかを指定します。このプロパティは、次の条件が すべて 満たされている場合にのみ、 true に設定できます。

• ホスト名を 1 つだけ指定

• レプリカセットに接続していません。

• SrvMaxHostsプロパティを使用していません

• DirectConnectionプロパティを使用していません

データ型： boolean

デフォルト値: false

例:

mongoc_uri_set_option_as_bool(uri, MONGOC_URI_LOADBALANCED, true);

SrvMaxHosts

シードリストを初期設定するとき、または SRV ポーリング中にトポロジーに新しいホストを追加するときにランダムに選択する SRV 結果の最大数。

このプロパティは、接続文字列スキームが ConnectionStringScheme.MongoDBPlusSrv に設定されている場合にのみ使用できます。レプリカセットに接続する場合は、 を使用できません。

データ型： integer

デフォルト値: 0

例:

mongoc_uri_set_option_as_int32(uri, MONGOC_URI_SRVMAXHOSTS, 5);