MongoDB C++ Driver mongocxx-4.0.0
Loading...
Searching...
No Matches
auto_encryption.hpp
Go to the documentation of this file.
1// Copyright 2009-present MongoDB, Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <string>
18
21#include <mongocxx/pool-fwd.hpp>
22
25
27
28namespace mongocxx {
29namespace v_noabi {
30namespace options {
31
36 public:
41
60
67 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::client*>&)
69
92
99 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::pool*>&)
101
105 using ns_pair = std::pair<std::string, std::string>;
106
125
133 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<ns_pair>&)
135
181 kms_providers(bsoncxx::v_noabi::document::view_or_value kms_providers);
182
190 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
192
217 tls_opts(bsoncxx::v_noabi::document::view_or_value tls_opts);
218
226 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
227 tls_opts() const;
228
253 schema_map(bsoncxx::v_noabi::document::view_or_value schema_map);
254
262 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
263 schema_map() const;
264
285 encrypted_fields_map(bsoncxx::v_noabi::document::view_or_value encrypted_fields_map);
286
294 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
296
311
319
334
342
394 extra_options(bsoncxx::v_noabi::document::view_or_value extra);
395
403 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
405
406 private:
407 friend ::mongocxx::v_noabi::client;
408 friend ::mongocxx::v_noabi::pool;
409
410 void* convert() const;
411
412 bool _bypass;
413 bool _bypass_query_analysis;
414 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::client*> _key_vault_client;
415 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::pool*> _key_vault_pool;
416 bsoncxx::v_noabi::stdx::optional<ns_pair> _key_vault_namespace;
417 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _kms_providers;
418 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _tls_opts;
419 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _schema_map;
420 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>
421 _encrypted_fields_map;
422 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _extra_options;
423};
424
425} // namespace options
426} // namespace v_noabi
427} // namespace mongocxx
428
429#include <mongocxx/config/postlude.hpp>
430
Declares mongocxx::v_noabi::options::auto_encryption.
Class representing options for automatic client-side encryption.
Definition auto_encryption.hpp:35
const bsoncxx::v_noabi::stdx::optional< ns_pair > & key_vault_namespace() const
Gets the key vault namespace.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & extra_options() const
Gets extra options related to the mongocryptd process.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & tls_opts() const
Gets the TLS options.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & schema_map() const
Gets the schema map.
bool bypass_query_analysis() const
Gets a boolean specifying whether or not query analysis is bypassed.
bool bypass_auto_encryption() const
Gets a boolean specifying whether or not auto encryption is bypassed.
std::pair< std::string, std::string > ns_pair
Represents the name of a database and a collection.
Definition auto_encryption.hpp:105
const bsoncxx::v_noabi::stdx::optional< mongocxx::v_noabi::pool * > & key_vault_pool() const
Gets the key vault pool.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & kms_providers() const
Gets the KMS providers.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & encrypted_fields_map() const
Get encrypted fields map.
const bsoncxx::v_noabi::stdx::optional< mongocxx::v_noabi::client * > & key_vault_client() const
Gets the key vault client.
Class representing the optional arguments to a MongoDB driver client object.
Definition client.hpp:39
Class representing the optional arguments to a MongoDB driver pool object. Pool options logically ext...
Definition pool.hpp:31
Declares mongocxx::v_noabi::client.
Provides bsoncxx::v_noabi::document::view_or_value.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:204
The mongocxx macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
The top-level namespace within which all mongocxx library entities are declared.
The top-level namespace reserved for the C++ standard library.
Provides std::optional-related polyfills for library API usage.
Declares mongocxx::v_noabi::pool.