1MONGOC_CLIENT_POOL_ENABLE_AUTO_ENCRMYlOPiNTbGImOOoCNn_(gC3oL)cIENT_POOL_ENABLE_AUTO_ENCRYPTION(3)
2
3
4

NAME

6       mongoc_client_pool_enable_auto_encryption    -   mongoc_client_pool_en‐
7       able_auto_encryption()
8

SYNOPSIS

10          bool
11          mongoc_client_pool_enable_auto_encryption (mongoc_client_pool_t *pool,
12                                                     mongoc_auto_encryption_opts_t* opts,
13                                                     bson_error_t* error);
14
15       Enable automatic client side encryption on a mongoc_client_pool_t.  Re‐
16       quires  libmongoc  to be built with support for Client-Side Field Level
17       Encryption. See the guide for Using Client-Side Field Level Encryption.
18
19       Automatic encryption is an enterprise-only feature that only applies to
20       operations  on  a collection. Automatic encryption is not supported for
21       operations on a database or view, and operations that are not  bypassed
22       will  result  in  error.  To bypass automatic encryption for all opera‐
23       tions,   bypass   automatic   encryption    with    mongoc_auto_encryp‐
24       tion_opts_set_bypass_auto_encryption() in opts.
25
26       Automatic  encryption  requires  the  authenticated  user  to  have the
27       listCollections privilege action.
28
29       Enabling automatic encryption reduces the maximum message size and  may
30       have a negative performance impact.
31

PARAMETERS

33       • client: A mongoc_client_t.
34
35       • opts: A required mongoc_auto_encryption_opts_t.
36
37       • error: A bson_error_t which is set on error.
38

RETURNS

40       Returns true if successful. Returns false and sets error otherwise.
41
42       SEE ALSO:
43          mongoc_auto_encryption_opts_t
44
45          mongoc_client_enable_auto_encryption()
46
47          The guide for Using Client-Side Field Level Encryption for libmongoc
48
49          The MongoDB Manual for Client-Side Field Level Encryption
50
51

AUTHOR

53       MongoDB, Inc
54

56       2017-present, MongoDB, Inc
57
58
59
60
611.20.0                           NoMvON1G8O,C_2C0L2I1ENT_POOL_ENABLE_AUTO_ENCRYPTION(3)
Impressum