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 In-Use Encryption. See
17       In-Use Encryption for instructions to enable In-Use Encryption in  lib‐
18       mongoc.
19
20       Automatic encryption is an enterprise-only feature that only applies to
21       operations on a collection. Automatic encryption is not  supported  for
22       operations  on a database or view, and operations that are not bypassed
23       will result in error. To bypass automatic  encryption  for  all  opera‐
24       tions,         bypass         automatic         encryption         with
25       mongoc_auto_encryption_opts_set_bypass_auto_encryption() in opts.
26
27       Automatic encryption  requires  the  authenticated  user  to  have  the
28       listCollections privilege action.
29
30       Enabling  automatic encryption reduces the maximum message size and may
31       have a negative performance impact.
32

PARAMETERS

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

RETURNS

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

AUTHOR

56       MongoDB, Inc
57

59       2017-present, MongoDB, Inc
60
61
62
63
641.24.3                           AuMgON1G7O,C_2C0L2I3ENT_POOL_ENABLE_AUTO_ENCRYPTION(3)
Impressum