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

NAME

6       mongoc_client_enable_auto_encryption               -               mon‐
7       goc_client_enable_auto_encryption()
8

SYNOPSIS

10          bool
11          mongoc_client_enable_auto_encryption (mongoc_client_t *client,
12                                                mongoc_auto_encryption_opts_t* opts,
13                                                bson_error_t* error);
14
15       Enable automatic client side encryption on a mongoc_client_t.  Requires
16       libmongoc  to be built with support for Client-Side Field Level Encryp‐
17       tion. 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
32       Only  applies  to a single-threaded mongoc_client_t. To use with client
33       pools, see mongoc_client_pool_enable_auto_encryption().
34

PARAMETERS

36       · client: A mongoc_client_t.
37
38       · opts: A required mongoc_auto_encryption_opts_t.
39
40       · error: A bson_error_t which is set on error.
41

RETURNS

43       True on success. False on error. On error, error is set.
44

SEE ALSO

46       · mongoc_auto_encryption_opts_t
47
48       · mongoc_client_pool_enable_auto_encryption()
49
50       · The guide for Using Client-Side Field Level Encryption for libmongoc
51
52       · The MongoDB Manual for Client-Side Field Level Encryption
53

AUTHOR

55       MongoDB, Inc
56

58       2017-present, MongoDB, Inc
59
60
61
62
631.16.2                           Feb 25,MO2N0G2O0C_CLIENT_ENABLE_AUTO_ENCRYPTION(3)
Impressum