接続オプションの指定

:auth_mech

Ruby ドライバーがアプリケーションを認証するために使用するメカニズム。

データ型: Symbol
デフォルト: :scram256
ユーザー認証情報が提供されていない場合は nil。
クライアント例: auth_mech: :scram256
接続 URI 例: authMechanism=SCRAM-SHA-256

:auth_mech_properties

認証メカニズムに固有のオプション。このオプションは、すべての認証メカニズムに必要とは限りません。

データ型: Hash
デフォルト: GSSAPI 認証メカニズムを使用する場合、
デフォルトのプロパティは {service_name: "mongodb"} です。
そうでない場合、デフォルトは nil です。
クライアント例: auth_mech_properties: {aws_session_token: '12345'}
接続 URI 例: authMechanismProperties=AWS_SESSION_TOKEN:12345

:auth_source

認証するデータベース。

データ型: String
デフォルト: admin (認証情報が提供される場合)
クライアント例: auth_source: admin
接続 URI 例: authSource=admin

:user

認証するユーザー名。このオプションが接続 URI に含まれている場合は、パーセントエンコードする必要があります。

データ型: String
デフォルト: なし
クライアント例: user: my+user
接続 URI 例: username=my+user

:password

認証用のパスワード。このオプションが接続 URI に含まれている場合は、パーセントエンコードする必要があります。

データ型: String
デフォルト: なし
クライアント例: password: strong+password
接続 URI 例: password=strong+password

:replica_set

接続先のレプリカセットの名前を指定します。

データ型: String
デフォルト: なし
クライアント例: replica_set: 'myRS'
接続 URI 例: replicaSet=myRS

:direct_ connection

指定されたホストに直接接続するかどうか

データ型: Boolean
デフォルト: false
クライアント例: direct_connection: true
接続 URI 例: directConnection=true

:enable_overload_re targeting

ドライバーが過負荷エラーを返すサーバーの優先順位を低くし、同じ過負荷サーバーで再試行する可能性を低減させるかどうか。

データ型: Boolean
デフォルト: false
クライアント例: enable_overload_retargeting: true
接続 URI 例: enableOverloadRetargeting=true

:max_adapactive_retry

ドライバーで過負荷エラーが発生した場合に試行する再試行の最大回数。

データ型: Integer
デフォルト: 2
クライアント例: max_adaptive_retries: 3
接続 URI 例: maxAdaptiveRetries=3

:read

読み込み設定 (read preference)オプション。詳細については、MongoDB Serverマニュアルの読み込み設定 (read preference)を参照してください。

データ型: Hash
デフォルト: { mode: :primary }
クライアント例: read: { mode: :primary }
接続 URI 例: readPreference=primary

:read_concern

読み取り保証 (read concern) オプションを指定します。詳細については、MongoDB Server マニュアルの「読み取り保証 (read concern)」を参照してください。

データ型: Hash
デフォルト: なし
クライアント例: read: { level: :majority }
接続 URI 例: readConcern=majority

:write_concern

クライアントの書込み保証 (write concern)を指定します。書込み保証 (write concern) の詳細については、MongoDB Server マニュアルの「書込み保証 (write concern)」を参照してください。

データ型: Hash
デフォルト: write_concern: { w: 1 }
クライアント例: write_concern: { w: 2 }
接続 URI 例: w=2

:local_threshold

レプリカセットのノードの選択対象となるまでのレイテンシ ウィンドウ（秒単位）。ノードの往復 ping 時間が、最速のサーバーの往復 ping 時間とこの値の合計より長い場合、そのサーバーは選択対象になりません。

データ型: Float
デフォルト: 0.015
クライアント例: local_threshold: 0.020
接続 URI 例: localThresholdMS=20