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

SYNOPSIS

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

PARAMETERS

30       • client: A mongoc_client_t.
31
32       • opts: A required mongoc_auto_encryption_opts_t.
33
34       • error: A bson_error_t which is set on error.
35

RETURNS

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

AUTHOR

52       MongoDB, Inc
53

55       2017-present, MongoDB, Inc
56
57
58
59
601.25.1                           NoMvON0G8O,C_2C0L2I3ENT_POOL_ENABLE_AUTO_ENCRYPTION(3)
Impressum