Queryable Encryption를 위한 MongoClient 옵션
개요
이 페이지에서는 MongoClient 인스턴스에 대한 Queryable Encryption 관련 구성 옵션에 대해 알아볼 수 있습니다.
자동 암호화 옵션
다음 표에서는 AutoEncryptionOptions 객체의 구조를 설명합니다.
속성 | 데이터 유형 | 필수 사항입니다. | 설명 |
|---|---|---|---|
keyVaultNamespace | String | 예 | 키 볼트 컬렉션 의 전체 네임스페이스 입니다. |
kmsProviders | Object | 예 | 고객 마스터 키(CMK)를 관리하기 위해 Queryable Encryption 에서 사용하는 키 관리 시스템( KMS )입니다.
고객 마스터 키에 대해 자세히 알아보려면 키 및 키 볼트를 참조하세요. |
bypassAutoEncryption | Boolean | No | 자동 암호화 규칙을 우회하고 명시적(수동) 필드별 암호화 를 수행하려면 true 를 지정합니다. |
bypassQueryAnalysis | Boolean | No | 발신 명령의 자동 분석을 비활성화합니다. 자동 암호화 공유 라이브러리 없이 명시적 암호화를 사용하려면 true 를 지정합니다. |
encryptedFieldsMap | Object | No | 자동으로 암호화할 필드와 해당 필드에 허용되는 쿼리 유형을 지정하는 스키마입니다. 암호화 스키마를 구성하는 방법을 알아보려면 필드 암호화 및 쿼리 가능성을 참조하세요. |
extraOptions | Object | No | 암호화 라이브러리의 구성 옵션입니다.
운전자 가 이 경로에서 자동 암호화 공유 라이브러리를 로드할 수 없는 경우 |
keyVaultClient | MongoClient | No | 키 볼트 컬렉션 을 호스팅하는 MongoDB 인스턴스 에 연결해야 하는 이 옵션을 생략하면 드라이버는 현재 키 볼트 컬렉션에 학습 보려면 키 볼트 컬렉션을 참조하세요 . |
tlsOptions | Object | No | KMS 제공자 에 연결할 때 사용할 TLS 옵션입니다. |
다음 표에서는 AutoEncryptionOptions 객체 의 속성에 대해 설명합니다.
속성 | 데이터 유형 | 필수 사항입니다. | 설명 |
|---|---|---|---|
KeyVaultNamespace | CollectionNamespace | 예 | 키 볼트 컬렉션 의 전체 네임스페이스 입니다. |
KmsProviders | IReadOnlyDictionary | 예 | 고객 마스터 키(CMK)를 관리하기 위해 Queryable Encryption 에서 사용하는 키 관리 시스템( KMS )입니다.
고객 마스터 키에 대해 자세히 알아보려면 키 및 키 볼트를 참조하세요. |
BypassAutoEncryption | Boolean | No | 자동 암호화 규칙을 우회하고 명시적(수동) 필드별 암호화 를 수행하려면 true 를 지정합니다. |
BypassQueryAnalysis | Boolean | No | 발신 명령의 자동 분석을 비활성화합니다. 자동 암호화 공유 라이브러리 없이 명시적 암호화 를 사용하려면 이 속성 을 true 로 설정합니다. |
EncryptedFieldsMap | IReadOnlyDictionary | No | 자동으로 암호화할 필드와 해당 필드에 허용되는 쿼리 유형을 지정하는 스키마입니다. 암호화 스키마를 구성하는 방법을 알아보려면 필드 암호화 및 쿼리 가능성을 참조하세요. |
ExtraOptions | IReadOnlyDictionary | No | 암호화 라이브러리의 구성 옵션입니다.
운전자 가 이 경로에서 자동 암호화 공유 라이브러리를 로드할 수 없는 경우 |
KeyVaultClient | IMongoClient | No | 키 볼트 컬렉션 을 호스팅하는 MongoDB 인스턴스 에 연결해야 하는 이 옵션을 생략하면 드라이버는 현재 키 볼트 컬렉션에 학습 보려면 키 볼트 컬렉션을 참조하세요 . |
TlsOptions | IReadOnlyDictionary | No | KMS 제공자 에 연결할 때 사용할 TLS 옵션입니다. |
다음 표에서는 AutoEncryptionOptions 객체 의 옵션에 대해 설명합니다.
옵션 | 데이터 유형 | 필수 사항입니다. | 설명 |
|---|---|---|---|
KeyVaultNamespace | String | 예 | 키 볼트 컬렉션 의 전체 네임스페이스 입니다. |
KmsProviders | map[string]map[string]interface{} | 예 | 고객 마스터 키(CMK)를 관리하기 위해 Queryable Encryption 에서 사용하는 키 관리 시스템( KMS )입니다.
고객 마스터 키에 대해 자세히 알아보려면 키 및 키 볼트를 참조하세요. |
BypassAutoEncryption | *bool | No | 자동 암호화 규칙을 우회하고 명시적(수동) 필드별 암호화 를 수행하려면 true 를 지정합니다. |
BypassQueryAnalysis | *bool | No | 발신 명령의 자동 분석을 비활성화합니다. 자동 암호화 공유 라이브러리 없이 명시적 암호화를 사용하려면 true 를 지정합니다. |
EncryptedFieldsMap | map[string]interface{} | No | 자동으로 암호화할 필드와 해당 필드에 허용되는 쿼리 유형을 지정하는 스키마입니다. 암호화 스키마를 구성하는 방법을 알아보려면 필드 암호화 및 쿼리 가능성을 참조하세요. |
ExtraOptions | map[string]interface{} | No | 암호화 라이브러리의 구성 옵션입니다.
운전자 가 이 경로에서 자동 암호화 공유 라이브러리를 로드할 수 없는 경우 |
KeyVaultClientOptions | *ClientOptions | No | 키 볼트 컬렉션 을 호스팅하는 MongoDB 인스턴스 에 연결하기 위한 새 내부 이 옵션을 생략하면 드라이버는 현재 키 볼트 컬렉션에 학습 보려면 키 볼트 컬렉션을 참조하세요 . |
TlsConfig | map[string]*tls.Config | No | KMS 제공자 에 연결할 때 사용할 TLS 옵션입니다. |
다음 표에서는 AutoEncryptionSettings 빌더에서 사용할 수 있는 메서드에 대해 설명합니다.
메서드 | 데이터 유형 | 필수 사항입니다. | 설명 |
|---|---|---|---|
keyVaultNamespace | String | 예 | 키 볼트 컬렉션 의 전체 네임스페이스 입니다. |
kmsProviders | Map | 예 | 고객 마스터 키(CMK)를 관리하기 위해 Queryable Encryption 에서 사용하는 키 관리 시스템( KMS )입니다.
고객 마스터 키에 대해 자세히 알아보려면 키 및 키 볼트를 참조하세요. |
bypassAutoEncryption | Boolean | No | 자동 암호화 규칙을 우회하고 명시적(수동) 필드별 암호화 를 수행하려면 true 를 지정합니다. |
bypassQueryAnalysis | Boolean | No | 발신 명령의 자동 분석을 비활성화합니다. 자동 암호화 공유 라이브러리 없이 명시적 암호화를 사용하려면 true 를 지정합니다. |
encryptedFieldsMap | Map | No | 자동으로 암호화할 필드와 해당 필드에 허용되는 쿼리 유형을 지정하는 스키마입니다. 암호화 스키마를 구성하는 방법을 알아보려면 필드 암호화 및 쿼리 가능성을 참조하세요. |
extraOptions | Map | No | 암호화 라이브러리의 구성 옵션입니다.
|
keyVaultMongoClientSettings | MongoClientSettings | No | 키 볼트 컬렉션 을 호스팅하는 MongoDB 인스턴스 에 연결하기 위한 새 이 옵션을 생략하면 드라이버는 현재 키 볼트 컬렉션에 학습 보려면 키 볼트 컬렉션을 참조하세요 . |
kmsProviderPropertySuppliers | Map | No | kmsProviders() 메서드와 유사하지만 대신 각 속성 에 대해 Supplier 를 구성합니다. |
kmsProviderSslContextMap | Map | No | 인증 에 사용할 SSL 컨텍스트입니다. |
다음 표에서는 AutoEncryptionOptions 객체의 구조를 설명합니다.
속성 | 데이터 유형 | 필수 사항입니다. | 설명 |
|---|---|---|---|
keyVaultNamespace | String | 예 | 키 볼트 컬렉션 의 전체 네임스페이스 입니다. |
kmsProviders | Object | 예 | 고객 마스터 키(CMK)를 관리하기 위해 Queryable Encryption 에서 사용하는 키 관리 시스템( KMS )입니다.
고객 마스터 키에 대해 자세히 알아보려면 키 및 키 볼트를 참조하세요. |
bypassAutoEncryption | Boolean | No | 자동 암호화 규칙을 우회하고 명시적(수동) 필드별 암호화 를 수행하려면 true 를 지정합니다. |
bypassQueryAnalysis | Boolean | No | 발신 명령의 자동 분석을 비활성화합니다. 자동 암호화 공유 라이브러리 없이 명시적 암호화 를 사용하려면 true 를 지정합니다. 지정하지 않으면 기본값은 false 입니다. |
encryptedFieldsMap | Object | No | 자동으로 암호화할 필드와 해당 필드에 허용되는 쿼리 유형을 지정하는 스키마입니다. 암호화 스키마를 구성하는 방법을 알아보려면 필드 암호화 및 쿼리 가능성을 참조하세요. |
extraOptions | Object | No | 암호화 라이브러리의 구성 옵션입니다.
운전자 가 이 경로에서 자동 암호화 공유 라이브러리를 로드할 수 없는 경우 |
keyVaultClient | MongoClient | No | 키 볼트 컬렉션 을 호스팅하는 MongoDB 인스턴스 에 연결해야 하는 이 옵션을 생략하면 드라이버는 현재 키 볼트 컬렉션에 학습 보려면 키 볼트 컬렉션을 참조하세요 . |
tlsOptions | Object | No | KMS 제공자 에 연결할 때 사용할 TLS 옵션입니다. |
다음 표에서는 AutoEncryptionOpts 클래스의 매개변수에 대해 설명합니다.
Parameter | 데이터 유형 | 필수 사항입니다. | 설명 |
|---|---|---|---|
key_vault_namespace | String | 예 | 키 볼트 컬렉션 의 전체 네임스페이스 입니다. |
kms_providers | Mapping[string, Any] | 예 | 고객 마스터 키(CMK)를 관리하기 위해 Queryable Encryption 에서 사용하는 키 관리 시스템( KMS )입니다.
고객 마스터 키에 대해 자세히 알아보려면 키 및 키 볼트를 참조하세요. |
bypass_auto_encryption | Boolean | No | 자동 암호화 규칙을 우회하고 명시적(수동) 필드별 암호화 를 수행하려면 True 를 지정합니다. |
bypass_query_analysis | Boolean | No | 발신 명령의 자동 분석을 비활성화합니다. 자동 암호화 공유 라이브러리 없이 명시적 암호화를 사용하려면 True 를 지정합니다. |
encrypted_fields_map | Mapping | No | 자동으로 암호화할 필드와 해당 필드에 허용되는 쿼리 유형을 지정하는 스키마입니다. 암호화 스키마를 구성하는 방법을 알아보려면 필드 암호화 및 쿼리 가능성을 참조하세요. |
crypt_shared_lib_path | String | No |
운전자 가 이 경로에서 자동 암호화 공유 라이브러리를 로드할 수 없으면 오류가 발생합니다. |
crypt_shared_lib_required | Boolean | No | True 지정하면 libmongocrypt 자동 암호화 공유 라이브러리를 로드할 수 없는 경우 운전자 에서 오류가 발생합니다. |
key_vault_client | MongoClient | No | 키 볼트 컬렉션 을 호스팅하는 MongoDB 인스턴스 에 연결해야 하는 이 옵션을 생략하면 드라이버는 현재 키 볼트 컬렉션에 학습 보려면 키 볼트 컬렉션을 참조하세요 . |
kms_tls_options | Mapping[string, Any] | No | KMS 제공자 에 연결할 때 사용할 TLS 옵션입니다. |
mongocryptd_uri | String | No | 암호화 에 mongocryptd 을(를) 사용하는 경우 로컬 mongocryptd 프로세스 에 연결하는 데 사용되는 MongoDB URI입니다. |
mongocryptd_bypass_spawn | Boolean | No | 이 매개 변수에 True 을 지정하면 암호화에 mongocryptd 을 사용하는 경우 암호화된 MongoClient 는 mongocryptd 프로세스를 생성하려고 시도하지 않습니다. |
mongocryptd_spawn_path | String | No | 암호화 에 mongocryptd 을(를) 사용하는 경우 mongocryptd 프로세스 를 생성하는 데 사용됩니다. |
mongocryptd_spawn_args | String | No | 암호화 에 mongocryptd 을 사용하는 경우 mongocryptd 프로세스 를 생성할 때 사용할 string 인수 목록입니다. |