クライアントの作成

サーバー バージョン 3.4 以上で接続を確立するときに mongod ログに出力されるアプリケーション名。

String

なし

使用する認証メカニズムを指定します。 次のいずれかになります。 :gssapi 、 :mongodb_cr 、 :mongodb_x509 、 :plain 、 :scram 、 :scram256 。 GSSAPI （Kerberos）認証には追加の依存関係が必要です。

Symbol

ユーザー認証情報が提供されていない場合、 nilは 。 ユーザー認証情報が指定されている場合、デフォルトはサーバーのバージョンによって異なります。 MongoDB 4.0 以降: ユーザー認証情報が SCRAM-SHA-256 認証をサポートするユーザーに対応する場合は:scram256 、それ以外の場合は:scram 。 MongoDB 3.0-3.6: :scram 。 MongoDB 2.6: :mongodb_cr

追加の認証メカニズム プロパティを提供します。

プロパティ内のキーは、大文字と小文字を区別せずに解釈されます。 クライアントが作成されると、キーは小文字になります。

Hash

GSSAPI 認証メカニズムを使用する場合、デフォルトのプロパティは{service_name: "mongodb"}です。 それ以外の場合、デフォルトは nil です。

認証ソースを指定します。

String

MongoDB 2.6 以降の場合: 認証情報が提供されている場合は管理者、そうでない場合は現在のデータベース

自動暗号化を設定するためのオプションのHash 。

• :key_vault_client - 暗号化データキーを保存している MongoDB インスタンスに接続されているクライアント（ Mongo::Client 、デフォルトは最上位のクライアント インスタンス）。

• :key_vault_namespace - "database.collection"形式のキーヴォールト コレクションの名前空間（ String 、必須）。

• :kms_providers - KMS構成情報。 キー:localと:awsの 1 つまたは両方を指定する必要があります（ Hash 、必須）。 このオプションの詳細については、クライアント側暗号化 チュートリアルの「 kms_providersオプション」セクションを参照してください。

• :schema_map - 暗号化するフィールドを指定する 1 つ以上のコレクションの JSONSchema（ Hash 、任意、デフォルトはnil ）。

• :bypass_auto_encryption - データベース操作の実行時に自動暗号化をスキップするかどうか（ Boolean 、デフォルトはfalse ）。

• :extra_options - mongocryptd の生成に関連するオプション（ Hash 、任意、デフォルトはnil ）。

これらのオプションの形式の詳細については、クライアント側暗号化 チュートリアルの「自動暗号化オプション」セクションを参照してください。

Hash

なし

試験用。 バックグラウンド スレッドでエラーが発生したときにバックトレースをログに記録するかどうか、またどのようにログに記録するかを制御します。 trueの場合、ドライバーは完全なバックトレースをログに記録します。 正の整数に設定すると、ドライバーはそのバックトレース行数までログを記録します。 falseまたはnilに設定されている場合、バックトレースはログに記録されません。 その他の値はエラーです。

true, false, nil, Integer

なし

使用する潜在的なコンプレッサーのリスト（優先順位順）。 ドライバーが圧縮を実装する方法の詳細については、以下を参照してください。

Array<String>

なし

非推奨。 ドライバーによって通常実行される配置トポロジーの検出を無効にし、クラスター トポロジーを特定のタイプに強制します。 有効な値は、 :direct 、 :load_balanced 、 :replica_set 、または:shardedです。 :load_balancedを使用する場合、クライアントは、接続サーバーがロード バランサーとして自分自身を宣言するかどうかにかかわらず、ロード バランサーに接続されている場合と同じように動作します。

Symbol

なし

例外が発生する前に、ソケット接続を確立するための待機時間（秒単位）。 このタイムアウトは SRV DNS レコード解決にも使用されます。 nilと0はタイムアウトなしを意味します。 無効なタイムアウト値（負の値や数値以外の値など）が渡されると、クライアントの作成はエラーで失敗します。

Float

10

接続するデータベースの名前。

String

管理者

指定されたホストに直接接続し、配置トポロジーを検出しません。

Boolean

false

サーバー モニターがサーバーの状態を非同期に更新するまでの秒数。

Float

10

ドキュメントの ID を生成するカスタム オブジェクト。 #generate に応答する必要があります。

Object

なし

ロード バランサーへの接続を要求するかどうか。

Boolean

false

動作対象の選択可能なサーバーと最も近いサーバーとの間の最大レイテンシを秒単位で指定します。

Float

0.015

カスタム ロガー。

Object

Logger

接続プールが並行して確立を試みる接続の最大数。

Integer

2

接続プールによって閉じられる前に接続がアイドル状態になる最大時間（秒単位）。

警告:ロード バランサーに接続すると、ドライバーは既存の接続を使用してカーソルを反復処理し（変更ストリームを含む）、トランザクションを実行します。 このオプションでアイドル時間を設定すると、ドライバーが後続の操作に必要な接続を閉じてしまい、それらの操作が失敗する可能性があります。

Integer

なし

各サーバーの接続プールの最大サイズ。 このオプションを 0 に設定すると、接続プールの最大サイズ制限が削除され、任意の接続数に拡大できるようになります。

Integer

20

レガシー読み取り再試行が使用される場合の読み取り再試行の最大回数。 レガシー読み取り再試行を無効にするには、 を 0 に設定します。

Integer

1

レガシー書込み再試行が使用される場合の最大書込み再試行回数。 レガシー書込み再試行を無効にするには、 を 0 に設定します。

Integer

1

各サーバーの接続プール内の最小接続数。 プールにこの数の接続が含まれるまで、ドライバーはバックグラウンドで接続を確立します。

Integer

0

監視オブジェクト。

Object

なし

認証するユーザーのパスワード。

String

なし

サーバー バージョン 3.4 以上で接続を確立するときに mongod ログに出力されるメタデータに含めるプラットフォーム情報。

String

なし

サーバーを選択するための読み込み設定（read preference）モードとタグセットをHashとして指定します。 ハッシュで許可されているキーは、 :mode 、 :tag_sets 、 :max_stalenessです。

{ read:
  { mode: :secondary,
    tag_sets: [ "data_center" => "berlin" ],
    max_staleness: 5,
  }
}

タグセットが指定される場合、それらはハッシュの配列である必要があります。 サーバーは、タグが提供されたタグセット内の 1 つのハッシュと一致する場合、読み込み設定 (read preference) を満たす場合、読み込み設定 (read preference) を満たします。

各タグセットはハッシュである必要があり、サーバー選択に使用される前に内部的にBSON::Documentインスタンスに変換されます。 ハッシュキーは string または記号にすることができます。 キーでは大文字と小文字が区別されます。 ハッシュ値は string である必要があり、レプリカセット構成の値と完全に一致します。

Hash

{ :mode => :primary }

読み取り保証 (read concern) オプションを指定します。 有効なキーはlevelのみで、有効な値は:local 、 :available 、 :majority 、 :snapshot 、 :linearizableです。

Hash

なし

mongos での読み取りが再試行される間隔（秒単位）。

Integer

5

レプリカセットに接続する場合、これはサーバーをフィルタリングするセットの名前です。

String

なし

ネットワーク エラーによってシングル ステートメント書込み (write) 操作が失敗した場合、ドライバーはサーバー バージョン 3.6 以降に接続すると自動的に再試行します。

Boolean

true

クライアントは構築されるとすぐにバックグラウンドで配置の監視を開始するため、クライアントを構築し、別の ステートメントでSDAMイベントにサブスクライブすると、サブスクライブが一部の SDAM イベントを受信しない可能性があります。 :sdam_procオプションを使用すると、SDAM イベントが公開される前に構築されるクライアントにイベント サブスクライブを追加できます。

クライアントのイベント サブスクライブ メカニズムが初期化された後、いずれかのサーバーがクライアントに追加される前に、 Clientを引数として呼び出されるProcを渡します。 このProcを使用して、クライアントで SDAM イベント サブスクライブを設定します。

注: 手順で提供されるProc :sdam_proc is invoked, in particular the cluster is nil at this time. ``:sdam_procClient#subscribeClient#unsubscribeが、渡されたクライアントのみに メソッドと メソッドを呼び出すよう制限する場合、クライアントは完全に構築されていません。

Proc

なし

リクエストされたサーバー API バージョン。 これは、次の許可された項目を含むハッシュです: - :version（ string ） - :strict（true または false） - :deprecation_errors（true または false）

サーバー API バージョンは Ruby オプションとしてのみ指定でき、URI オプションとしては指定できないこと、およびデータベースおよびコレクション オブジェクトを上書きすることはできないことに注意してください。

クライアントでサーバー API バージョンが変更された場合（ with呼び出しによる場合など）、API バージョン ハッシュ全体が新しい仕様に置き換えられます（古いフィールドと新しい個々のフィールドはマージされません）。

Hash

なし

例外が発生する前に、操作が実行されるよう適切なサーバーが選択されるまで待機する秒数。

Float

30

例外が発生する前に、ソケット上で操作が実行されるまで待機する秒数。 nilと0はタイムアウトなしを意味します。 無効なタイムアウト値（負の値や数値以外の値など）が渡されると、クライアントの作成はエラーで失敗します。

Float

なし

シャーディングされたトポロジにドライバーが通信する mongos の最大数。 このオプションを 0 に設定すると、mongos の最大数はなくなります。 指定された URI が:srv_max_hostsを超えるホストに解決される場合、クライアントはランダムに:srv_max_hostsサイズのホストのサブセットを選択します。 クライアント構築中にドライバーが無視したホストは使用されないことに注意してください。 ドライバーによって選択されたホストが使用できなくなると、配置に他の機能的な mongos があっても、クライアントは完全に動作を終了します。

Integer

0

SRV DNS クエリで使用するサービス名。

String

mongodb

TLS 経由でサーバーに接続するようにクライアントに指示します。

Boolean

false

接続のもう一方の側から渡された証明書を検証するために使用される、連結された証明機関証明書を含むファイル パス。 :ssl_verifyには、 :ssl_ca_cert 、 :ssl_ca_cert_string 、または:ssl_ca_cert_object （優先順位順）のいずれかが必要です。

String

なし

接続先から渡された証明書を検証するために使用される証明機関証明書を表す OpenSSL::X509::Certificate の配列。 :ssl_verifyには、 :ssl_ca_cert 、 :ssl_ca_cert_string 、または:ssl_ca_cert_object （優先順位順）のいずれかが必要です。

Array< OpenSSL::X509::Certificate >

なし

接続のもう一方の側から渡された証明書を検証するために使用される、連結された証明機関証明書を含む string。 :ssl_verifyには、 :ssl_ca_cert 、 :ssl_ca_cert_string 、または:ssl_ca_cert_object （優先順位順）のいずれかが必要です。

String

なし

MongoDB サーバーへのアプリケーションを識別するために使用されるクライアント証明書ファイルへのパス。 ファイルには証明書の秘密キーも含まれている場合があります。その場合、秘密キーはこのオプションによって無視されます。 ファイルには、クライアント証明書から CA 証明書への証明書チェーンを構成する中間証明書も含まれる場合があります。中間証明書はドライバーによって解析され、 extra_chain_cert属性の OpenSSL コンテキストに提供されます。 中間証明書が提供される場合は、 ファイルの最初の証明書であるクライアント証明書に従う必要があります。

このオプションは、存在する場合、 :ssl_cert_stringおよび:ssl_cert_objectオプションよりも優先されます。

String

なし

MongoDB サーバーに対してアプリケーションを識別するために使用される OpenSSL::X509::Certificate 。 このオプションを介して渡すことができる証明書は 1 つだけです。

OpenSSL::X509::Certificate

なし

MongoDB サーバーに対してアプリケーションを識別するために使用される PEM でエンコードされた証明書を含む string。 string には証明書の秘密キーが含まれる場合もあります。その場合、秘密キーはこのオプションによって無視されます。 string には、クライアント証明書から CA 証明書への証明書チェーンを構成する中間証明書も含まれる場合があります。中間証明書はドライバーによって解析され、 extra_chain_cert属性の OpenSSL コンテキストに提供されます。 中間証明書が提供される場合は、クライアント証明書に従う必要があります。クライアント証明書は、string の最初の証明書でなければなりません。

このオプションは、存在する場合、 :ssl_cert_objectオプションよりも優先されます。

String

なし

MongoDB に対する接続を識別するために使用される秘密キーファイル。 キーが証明書と同じファイルに保存されている場合でも、両方を明示的に指定する必要があることに注意してください。 このオプションが存在する場合、:ssl_key_string および :ssl_key_object の値よりも優先されます。

String

なし

MongoDB に対する接続を識別するために使用される秘密キー。

OpenSSL::PKey

なし

秘密キーのパスフレーズ。

String

なし

MongoDB に対する接続を識別するために使用される PEM でエンコードされた秘密キーを含む string 。 このパラメーターが存在する場合、オプションの値である :ssl_key_object よりも優先されます。

String

なし

ピア証明書、ホスト名、OCSP エンドポイントの検証を実行するかどうか。 :ssl_verify_certificateが設定されている場合は、証明書を検証するかどうかの決定が上書きされ、 :ssl_verify_hostnameが設定されている場合はホスト名を検証するかどうかの決定が上書きされ、OCSP エンドポイントを検証するかどうかの決定は、 :ssl_verify_ocsp_endpointが上書きされる場合、上書きされることに注意してください。 が設定されています。

Boolean

true

ピア証明書の検証を実行するかどうか。 この設定は、証明書の検証が実行されるかどうかに関して:ssl_verify設定を上書きします。

Boolean

true

ピア ホスト名の検証を実行するかどうか。 この設定は、ホスト名の検証が実行されるかどうかに関する:ssl_verify設定を上書きします。

Boolean

true

証明書で OCSP エンドポイントが指定されている場合、証明書で指定された OCSP エンドポイントに対してサーバーが提供した証明書を検証するかどうか。 この設定は、OCSP エンドポイント検証が実行されるかどうかに関して :ssl_verify を上書きします。

Boolean

true

ログをデフォルトで 250 文字で切り捨てるかどうか。

Boolean

true

認証するユーザーの名前。

String

なし

接続プール内の接続が利用可能になるまで待機する秒数。

Float

10

ドライバーをラップしている ODM などのライブラリに関する情報。 最初に低レベルのライブラリを指定します。 許可されたハッシュキー: :name、:version、:プラットフォーム。 例: [name: 'Mongoid', version: '7.1.2']

Array<Hash>

なし

非推奨。 :write_concernオプションと同等。 :writeと:write_concernの両方が指定されている場合、それらの値は同一である必要があります。

Hash

{ w: 1 }

書込み保証（write concern） オプションをHashとして指定します。 ハッシュ内のキーは、 :w 、 :wtimeout 、 :j 、 :fsyncです。 :wtimeoutは 秒ではなくミリ秒単位で指定されていることに注意してください。

{ write_concern: { w: 2 } }

Hash

{ w: 1 }

圧縮を使用する場合、使用するzlib圧縮レベル。 有効なレベルについては、 Rubyのzlibモジュールを参照してください。

Integer

なし

:app_name => String

:auth_mech => Symbol

認証メカニズム値は、URI オプションから Ruby オプションに次のように変換されます。

• GSSAPI => :gssapi

• MONGODB-CR => :mongodb_cr

• MONGODB-X509 => :mongodb_x509

• PLAIN => :plain

• SCRAM-SHA-1 => :scram

• SCRAM-SHA-256 => :scram256

認証メカニズムに別の値が指定されている場合は、変更されずに Ruby オプションに変換され、そのStringタイプが保持されます。 現在ドライバーでは認識されていない認証メカニズムでClient インスタンスを構築できますが、この動作 はドライバーの将来のバージョンで変更される可能性があります 。

{ :auth_mech_properties => { :service_realm => String, :canonicalize_host_name => true|false, :service_name => String } }

カンマで区切られたキーと値のペアとして指定されます。例: "SERVICE_REALM:foo,CANONICALIZE_HOST_NAME:TRUE" 。

:auth_source => String

:compressors => Array<String>

使用する潜在的なコンプレッサーのコンマ区切りリスト（優先順位順）。 ドライバーが圧縮を実装する方法の詳細については、以下を参照してください。

:connect => Symbol

ここでは、 :connect Ruby オプションが受け入れる値と同じ値が受け入れられます。 複数単語の値の場合、単語を区切るためにアンダースコアを使用して値を提供する必要があります（例connect=replica_setとconnect=load_balanced 。

:connect_timeout => Float

Rubyな値（例: 負の値および数値以外の値）の場合、この URI オプションによって指定された無効な値は警告付きで無視されます。

:direct_connection => Boolean

{ :write_concern => { :fsync => true|false }}

:heartbeat_frequency => Float

{ :write_concern => { :j => true|false }}

:load_balanced => Boolean

:local_threshold => Float

:max_connecting => Integer

:max_idle_time => Float

{ :read => { :max_staleness => Integer }}

maxStalenessSeconds URI オプションの値が -1 の場合、 オプションがまったく指定されていない限り、ドライバーはこれを として扱います。 それ以外の場合、オプション値が数値の場合、Ruby オプションはIntegerに変換された指定された値に設定されます。 0 より大きく 90 未満、または -1 より小さい数値はwith Clientコンストラクターによって受け入れられますが、サーバー選択は失敗します（たとえば、ドライバー上で実行されているすべての操作に適用されます。 オプション値が数値以外の場合は無視され、ドライバーはこの場合、オプションがまったく指定されていないかのように扱われます。

:max_pool_size => Integer

:min_pool_size => Integer

:read_concern => Hash

{ :read => { :mode => Symbol }}

{ :read => { :tag_sets => Array<Hash> }}

readPreferenceTags フィールドの各インスタンスは、カンマで区切られたキーと値のペアであり、指定された順序で : tags_sets 配列に表示されます。 たとえば、 "readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny"は[ { 'dc' => 'ny', 'rack' => '1' }, { 'dc' => 'ny' }]に変換されます。

:replica_set => String

:retry_writes => boolean

:server_selection_timeout => Float

:socket_timeout => Float

Rubyな値（例: 負の値および数値以外の値）の場合、この URI オプションによって指定された無効な値は警告付きで無視されます。

:srv_max_hosts => Integer

:srv_service_name => String

:ssl => true|false

:ssl => boolean

:ssl_verify_certificate => boolean

tlsAllowInvalidCertificatesはtrueを使用して検証を無効にすることを指定し、 ssl_verify_certificateはfalseを使用して検証を無効にすることを指定するため、ブール値はssl_verify_certificateを設定するために使用される前に反転されます。

:ssl_verify_hostname => boolean

tlsAllowInvalidHostnamesはtrueを使用して検証を無効にすることを指定し、 ssl_verify_hostnameはfalseを使用して検証を無効にすることを指定するため、ブール値はssl_verify_hostnameを設定するために使用される前に反転されます。

:ssl_ca_cert => String

:ssl_cert => String

:ssl_key => String

:ssl_key_pass_phrase => String

:ssl_verify_ocsp_endpoint => boolean

tlsDisableOCSPEndpointCheckはtrueを使用して検証を無効にすることを指定し、 ssl_verify_ocsp_endpointはfalseを使用して検証を無効にすることを指定するため、ブール値はssl_verify_ocsp_endpointを設定するために使用される前に反転されます。

:ssl_verify => boolean

tlsInsecure はtrueを使用して検証を無効にすることを指定し、 ssl_verifyはfalseを使用して検証を無効にすることを指定するため、ブール値はssl_verifyを設定するために使用される前に反転されます。

{ :write_concern => { :w => Integer|String }}

:wait_queue_timeout => Float

{ :write_concern => { :wtimeout => Integer }}

:zlib_compression_level => Integer