1MONGOC_CLIENT_ENABLE_AUTO_ENCRYPTIONl(i3b)moMnOgNoGcOC_CLIENT_ENABLE_AUTO_ENCRYPTION(3)
2
3
4

SYNOPSIS

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

PARAMETERS

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

RETURNS

39       True on success. False on error. On error, error is set.
40
41       SEE ALSO:
42          mongoc_auto_encryption_opts_t
43
44          mongoc_client_pool_enable_auto_encryption()
45
46          In-Use Encryption for libmongoc
47
48          The MongoDB Manual for Client-Side Field Level Encryption
49
50          The MongoDB Manual for Queryable Encryption
51
52

AUTHOR

54       MongoDB, Inc
55

57       2017-present, MongoDB, Inc
58
59
60
61
621.25.1                           Nov 08,MO2N0G2O3C_CLIENT_ENABLE_AUTO_ENCRYPTION(3)
Impressum