클라이언트 생성

3.4 이상 서버 버전에서 연결 설정 시 mongod 로그에 출력되는 애플리케이션 이름입니다.

String

none

사용할 인증 메커니즘을 지정합니다. :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 이상: 자격 증명이 제공되면 admin , 그렇지 않으면 현재 데이터베이스

자동 암호화를 구성하기 위한 Hash 옵션입니다.

• :key_vault_client - 암호화 데이터 키(Mongo::Client, 기본값은 최상위 클라이언트 인스턴스)를 저장하는 MongoDB 인스턴스에 연결된 클라이언트입니다.

• :key_vault_namespace - "database.collection" (String, 필수) 형식의 키 볼트 컬렉션 네임스페이스입니다.

• :kms_providers - 키 관리 서비스 구성 정보입니다. 키 :local 및 :aws 중 하나 또는 둘 다를 지정해야 합니다(Hash 필수). 이 옵션에 대한 자세한 내용은 클라이언트 사이드 암호화 튜토리얼 의 ' kms_providers 옵션' 섹션을 참조하세요.

• :schema_map - 암호화해야 하는 필드를 지정하는 하나 이상의 collection에 대한 JSONSchema(Hash, 선택 사항, 기본값은 nil)입니다.

• :bypass_auto_encryption - 데이터베이스 작업을 수행할 때 자동 암호화를 건너뛸지 여부를 지정합니다(Boolean, 기본값은 false).

• :extra_options - mongocryptd 생성과 관련된 옵션(Hash, 선택 사항, 기본값은 nil)입니다.

이러한 옵션의 서식을 지정하는 방법에 대한 자세한 내용은 클라이언트 사이드 암호화 튜토리얼의 "자동 암호화 옵션" 섹션을 참조하세요.

Hash

none

실험적입니다. 백그라운드 스레드에서 오류가 발생할 때 역추적을 기록할지 여부와 기록하는 방법을 제어합니다. true 인 경우 드라이버는 전체 역추적을 기록합니다. 양의 정수로 설정하면 드라이버는 그 만큼의 역추적 라인에 기록합니다. false 또는 nil 로 설정하면 역추적이 기록되지 않습니다. 다른 값은 오류입니다.

true, false, nil, Integer

none

사용할 수 있는 잠재적 압축기 목록을 선호도 순으로 정렬합니다. 드라이버가 압축을 구현하는 방법에 대한 자세한 내용은 아래를 참조하세요.

Array<String>

none

더 이상 사용되지 않습니다. 드라이버에서 일반적으로 수행하는 배포 토폴로지 검색을 비활성화하고 cluster 토폴로지를 특정 유형으로 강제 설정합니다. 유효한 값은 :direct, :load_balanced, :replica_set 또는 :sharded 입니다. :load_balanced 를 사용하면 클라이언트는 연결하는 서버가 자신을 로드 밸런서로 알릴지 여부에 관계없이 로드 밸런서에 연결된 것처럼 동작합니다.

Symbol

none

예외가 발생하기 전에 소켓 연결을 설정하기 위해 대기하는 시간(초)입니다. 이 시간 제한은 SRV DNS 레코드 확인에도 사용됩니다. nil 및 0 은 시간 초과가 없음을 MEAN. 잘못된 시간 초과 값(예: 음수 값 또는 숫자가 아닌 값)이 전달되면 오류와 함께 클라이언트 생성이 실패합니다.

Float

10

연결할 데이터베이스의 이름입니다.

String

관리자

배포 토폴로지를 검색하지 않고 지정된 호스트에 직접 연결합니다.

Boolean

거짓

서버 모니터가 서버 상태를 비동기적으로 새로 고치는 데 걸리는 시간(초)입니다.

Float

10

문서의 ID를 생성하는 사용자 지정 객체입니다. #generate에 응답해야 합니다.

Object

none

로드 밸런서에 연결할지 여부입니다.

Boolean

거짓

가장 가까운 서버와 작동하도록 선택할 수 있는 서버 간의 최대 지연 시간(초)을 지정합니다.

Float

0.015

사용자 지정 로거.

Object

Logger

연결 풀이 병렬로 설정을 시도할 최대 연결 수입니다.

Integer

2

연결 풀에서 연결이 닫히기 전에 연결이 유휴 상태일 수 있는 최대 시간(초)입니다.

경고: 로드 밸런서에 연결된 경우 드라이버는 커서를 반복하고(change stream 포함) 트랜잭션을 실행하기 위해 기존 연결을 사용합니다. 이 옵션을 통해 유휴 시간을 설정하면 드라이버가 후속 작업에 필요한 연결을 닫게 되어 해당 작업이 실패할 수 있습니다.

Integer

none

각 서버에 대한 연결 풀의 최대 크기입니다. 이 옵션을 0으로 설정하면 연결 풀에서 최대 크기 제한이 제거되어 연결 풀을 원하는 수로 늘릴 수 있습니다.

Integer

20

레거시 읽기 재시도가 사용되는 경우 최대 읽기 재시도 횟수입니다. 레거시 읽기 재시도를 비활성화하려면 0으로 설정합니다.

Integer

1

레거시 쓰기 재시도가 사용되는 경우 최대 쓰기 재시도 횟수입니다. 레거시 쓰기 재시도를 비활성화하려면 0으로 설정합니다.

Integer

1

각 서버에 대한 연결 풀의 최소 연결 수입니다. 드라이버는 풀에 이렇게 많은 연결이 포함될 때까지 백그라운드에서 연결을 설정합니다.

Integer

0

모니터링 객체입니다.

Object

none

인증할 사용자의 비밀번호입니다.

String

none

서버 버전 3.4 이상에서 연결 설정 시 mongod 로그에 출력되는 메타데이터에 포함할 플랫폼 정보입니다.

String

none

Hash 으로 서버를 선택하기 위한 읽기 설정 (read preference) 모드 및 태그 세트를 지정합니다. 해시에 허용되는 키는 :mode, :tag_sets 및 :max_staleness 입니다.

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

태그 세트가 제공되는 경우 해시 배열이어야 합니다. 서버는 해당 태그가 제공된 태그 세트의 해시 중 하나와 일치하는 경우 읽기 설정을 충족합니다.

각 태그 세트는 해시여야 하며 서버 선택에 사용되기 전에 내부적으로 BSON::Document 인스턴스로 변환됩니다. 해시 키는 문자열 또는 기호일 수 있습니다. 키는 대소문자를 구분합니다. 해시 값은 문자열이어야 하며 복제본 세트 구성의 값과 정확히 일치해야 합니다.

Hash

{ :mode => :primary }

읽기 고려 (read concern) 옵션을 지정합니다. 유일한 유효한 키는 level 이며, 이 경우 유효한 값은 :local, :available, :majority, :snapshot 및 :linearizable 입니다.

Hash

none

mongos에서 읽기를 재시도하는 간격(초)입니다.

Integer

5

복제본 세트에 연결할 때 서버를 필터링하는 기준이 되는 세트의 이름입니다.

String

none

네트워크 오류로 인해 단일 문 쓰기 작업이 실패하면 드라이버는 서버 버전 3.6 이상에 연결될 때 자동으로 한 번 재시도합니다.

Boolean

true

클라이언트는 배포가 생성되는 즉시 백그라운드에서 배포를 모니터링하기 시작하므로 클라이언트를 구성한 다음 별도의 성명서에서 SDAM 이벤트를 구독하면 구독자가 일부 SDAM 이벤트를 수신하지 못할 수 있습니다. :sdam_proc 옵션을 사용하면 SDAM 이벤트가 게시되기 전에 생성 중인 클라이언트에서 이벤트 구독자를 추가할 수 있습니다.

클라이언트의 이벤트 구독 메커니즘이 초기화된 후 클라이언트에 서버가 추가되기 전에 Client 를 인수로 사용하여 호출될 Proc 을 전달합니다. 이 Proc 를 사용하여 클라이언트에서 SDAM 이벤트 구독자를 설정합니다.

참고: :sdam_proc is invoked, in particular the cluster is nil at this time. ``:sdam_proc 절차에서 제공된 Proc 가 전달된 클라이언트에서만 Client#subscribe 및 Client#unsubscribe 메서드를 호출하도록 제한해야 하는 경우 클라이언트가 완전히 구성되지 않습니다.

Proc

none

요청된 서버 API 버전입니다. 허용되는 항목은 다음과 같은 해시입니다: - :version (문자열) - :strict (참 또는 거짓) - :deprecation_errors (참 또는 거짓)

서버 API 버전은 URI 옵션이 아닌 Ruby 옵션으로만 지정할 수 있으며 데이터베이스 및 collection 객체에 대해 재정의할 수 없습니다.

클라이언트에서 서버 API 버전이 변경된 경우(예: with 호출을 통해), 전체 API 버전 해시가 새 사양으로 대체됩니다(이전 개별 필드와 새 개별 필드는 병합되지 않음).

Hash

none

예외가 발생하기 전에 작업이 실행되도록 적절한 서버가 선택될 때까지 기다리는 시간(초)입니다.

Float

30

예외가 발생하기 전에 소켓에서 작업이 실행될 때까지 기다리는 시간(초)입니다. nil 및 0 은 시간 초과가 없음을 의미합니다. 잘못된 시간 초과 값(예: 음수 값 또는 숫자가 아닌 값)이 전달되면 오류와 함께 클라이언트 생성이 실패합니다.

Float

none

샤드 토폴로지를 위해 드라이버가 통신할 mongoses의 최대 개수입니다. 이 옵션을 0으로 설정하면 최대 mongoses 수에 제한이 없습니다. 지정된 URI가 :srv_max_hosts 보다 많은 호스트로 확인되면 클라이언트는 임의로 :srv_max_hosts 크기의 호스트 하위 집합을 선택합니다. 클라이언트 구성 중에 드라이버가 무시하는 호스트는 사용되지 않습니다. 드라이버에서 선택한 호스트를 사용할 수 없게 되면 배포서버에 다른 기능적 mongoses가 있더라도 클라이언트의 작업이 완전히 종료됩니다.

Integer

0

SRV DNS 쿼리에 사용할 서비스 이름입니다.

String

mongodb

클라이언트에게 TLS를 통해 서버에 연결하도록 지시합니다.

Boolean

거짓

연결의 다른 쪽 끝에서 전달된 인증서의 유효성을 검사하는 데 사용되는 연결된 인증 기관 인증서가 포함된 파일 경로입니다. 에는 :ssl_ca_cert, :ssl_ca_cert_string 또는 :ssl_ca_cert_object (우선순위순) 중 하나가 필요합니다.:ssl_verify

String

none

연결의 다른 쪽 끝에서 전달된 인증서의 유효성을 검사하는 데 사용되는 인증 기관 인증서를 나타내는 OpenSSL::X509::Certificate 의 배열입니다. 에는 :ssl_ca_cert, :ssl_ca_cert_string 또는 :ssl_ca_cert_object (우선 순위 순) 중 하나가 필요합니다.:ssl_verify

Array< OpenSSL::X509::Certificate >

none

연결의 다른 쪽 끝에서 전달된 인증서의 유효성을 검사하는 데 사용되는 연결된 인증 기관 인증서가 포함된 문자열입니다. 에는 :ssl_ca_cert, :ssl_ca_cert_string 또는 :ssl_ca_cert_object (우선 순위 순) 중 하나가 필요합니다.:ssl_verify

String

none

MongoDB 서버에서 애플리케이션을 식별하는 데 사용되는 클라이언트 인증서 파일의 경로입니다. 파일에는 인증서의 개인 키도 포함될 수 있습니다. 이 경우 이 옵션에서는 개인 키를 무시합니다. 파일에는 클라이언트 인증서에서 CA 인증서까지 인증서 체인을 형성하는 중간 인증서도 포함될 수 있습니다. 모든 중간 인증서는 드라이버에 의해 구문 분석되어 extra_chain_cert 속성의 OpenSSL 컨텍스트에 제공됩니다. 중간 인증서가 제공되는 경우 파일의 첫 번째 인증서여야 하는 클라이언트 인증서를 따라야 합니다.

이 옵션은 있는 경우 :ssl_cert_string 및 :ssl_cert_object 옵션보다 우선합니다.

String

none

MongoDB Server에서 애플리케이션을 식별하는 데 사용되는 OpenSSL::X509::Certificate입니다. 이 옵션을 통해 전달할 수 있는 인증서는 단 하나뿐입니다.

OpenSSL::X509::Certificate

none

MongoDB Server에서 애플리케이션을 식별하는 데 사용되는 PEM 인코딩 인증서가 포함된 문자열입니다. 이 문자열에는 인증서의 비공개 키도 포함될 수 있습니다. 이 경우 이 옵션에서는 개인 키를 무시합니다. 이 문자열에는 클라이언트 인증서에서 CA 인증서까지의 인증서 체인을 형성하는 중간 인증서도 포함될 수 있습니다. 모든 중간 인증서는 드라이버에 의해 구문 분석되어 extra_chain_cert 속성의 OpenSSL 컨텍스트에 제공됩니다. 중간 인증서가 제공되는 경우 클라이언트 인증서 뒤에 있어야 하며, 이 인증서는 문자열의 첫 번째 인증서여야 합니다.

이 옵션은 있는 경우 :ssl_cert_object 옵션보다 우선합니다.

String

none

MongoDB에 대한 연결을 식별하는 데 사용되는 비공개 키 파일입니다. 키가 인증서와 동일한 파일에 저장되어 있더라도 둘 다 명시적으로 지정해야 합니다. 이 옵션(있는 경우)은 :ssl_key_string 및 :ssl_key_object의 값보다 우선합니다.

String

none

MongoDB에 대한 연결을 식별하는 데 사용되는 비공개 키입니다.

OpenSSL::PKey

none

비공개 키의 암호입니다.

String

none

MongoDB에 대한 연결을 식별하는 데 사용되는 PEM 인코딩된 비공개 키가 포함된 문자열입니다. 이 매개변수(있는 경우)는 ssl_key_object 옵션의 값보다 우선합니다.

String

none

Peering 인증서, 호스트 이름 및 OCSP 엔드포인트 유효성 검사를 수행할지 여부입니다. :ssl_verify_certificate 이 설정된 경우 인증서 유효성 검사 여부에 대한 결정이 재정의되고, :ssl_verify_hostname 이 설정된 경우 호스트 이름의 유효성 검사 여부에 대한 결정이 재정의되며, :ssl_verify_ocsp_endpoint 2}이 설정된 경우 OCSP 엔드포인트의 유효성 검사 여부에 대한 결정이 재정의됩니다. 이(가) 설정되었습니다.

Boolean

true

Peering 인증서 유효성 검사를 수행할지 여부입니다. 이 설정은 인증서 유효성 검사 수행 여부와 관련하여 :ssl_verify 설정을 재정의합니다.

Boolean

true

피어 호스트 이름 유효성 검사를 수행할지 여부입니다. 이 설정은 호스트 이름 유효성 검사의 수행 여부와 관련하여 :ssl_verify 설정을 재정의합니다.

Boolean

true

OCSP 엔드포인트가 인증서에 지정된 경우 인증서에 지정된 OCSP 엔드포인트에 대해 서버 제공 인증서의 유효성을 검사할지 여부입니다. 이 설정은 OCSP 엔드포인트 유효성 검사 수행 여부와 관련하여 :ssl_verify를 재정의합니다.

Boolean

true

로그를 기본값 250자에서 자를지 여부입니다.

Boolean

true

인증할 사용자의 이름입니다.

String

none

연결 풀의 연결이 사용 가능해질 때까지 기다리는 시간(초)입니다.

Float

10

드라이버를 래핑하는 라이브러리(예: ODM)에 대한 정보입니다. 더 낮은 수준의 라이브러리를 먼저 지정합니다. 허용되는 해시 키: :name, :version, :platform. 예: [name: 'Mongoid', version: '7.1.2']

Array<Hash>

none

더 이상 사용되지 않습니다. :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

none

: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보다 작은 숫자 값은 Client 생성자에서 허용되지만 서버 선택이 실패하게 합니다(예: 이전에 with 메서드를 통해 옵션을 변경하지 않는 한 드라이버에서 수행 중인 모든 작업에 적용). 옵션 값이 숫자가 아닌 경우 무시되며 드라이버는 이 사례를 옵션이 전혀 제공되지 않은 것처럼 처리합니다.

:max_pool_size => Integer

:min_pool_size => Integer

:read_concern => Hash

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

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

readPreferenceTags 필드의 각 인스턴스는 쉼표로 구분된 키:값 쌍으로, 지정된 순서대로 :tag_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