1MONGOC_AUTO_ENCRYPTION_OPTS_SET_EXTRlAi(b3mM)oOnNgGoOcC_AUTO_ENCRYPTION_OPTS_SET_EXTRA(3)
2
3
4

NAME

6       mongoc_auto_encryption_opts_set_extra       -       mongoc_auto_encryp‐
7       tion_opts_set_extra()
8

SYNOPSIS

10          void
11          mongoc_auto_encryption_opts_set_extra (mongoc_auto_encryption_opts_t *opts,
12                                                 const bson_t *extra);
13

PARAMETERS

15       • opts: The mongoc_auto_encryption_opts_t
16
17       • extra: A bson_t of additional options.
18
19       extra is a bson_t containing any of the following optional fields:
20
21       • mongocryptdURI set to a URI to connect  to  the  mongocryptd  process
22         (default is "mongodb://localhost:27020").
23
24       • mongocryptdBypassSpawn  set to true to prevent the driver from spawn‐
25         ing the mongocryptd process (default behavior is to spawn).
26
27       • mongocryptdSpawnPath set to a path (with trailing  slash)  to  search
28         for  mongocryptd  (defaults  to  empty string and uses default system
29         paths).
30
31       • mongocryptdSpawnArgs set to an array of string arguments to  pass  to
32         mongocryptd  when  spawning  (defaults  to  [ "--idleShutdownTimeout‐
33         Secs=60" ]).
34
35       • cryptSharedLibPath  -  Set  a  filepath   string   referring   to   a
36         crypt_shared library file. Unset by default.
37
38         • If  not  set  (the  default),  libmongocrypt  will  attempt to load
39           crypt_shared using the host system's default dynamic-library-search
40           system.
41
42         • If set, the given path should identify the crypt_shared dynamic li‐
43           brary file itself, not the directory that contains it.
44
45         • If the given path is a relative path and the first  path  component
46           is  $ORIGIN,  the $ORIGIN component will be replaced with the abso‐
47           lute path to the directory containing the libmongocrypt library  in
48           use by the application.
49
50           NOTE:
51              No other RPATH/RUNPATH-style substitutions are available.
52
53         • If  the  given  path  is a relative path, the path will be resolved
54           relative to the working directory of the operating system process.
55
56         • If this option is set and libmongocrypt fails to load  crypt_shared
57           from  the given filepath, libmongocrypt will fail to initialize and
58           will not attempt to search for crypt_shared in any other locations.
59
60       • cryptSharedLibRequired - If set to true, and libmongocrypt  fails  to
61         load  a  crypt_shared library, initialization of auto-encryption will
62         fail immediately and will not attempt to spawn mongocryptd.
63
64         If set to false (the default), cryptSharedLibPath  is  not  set,  and
65         libmongocrypt  fails  to  load  crypt_shared, then libmongocrypt will
66         proceed without crypt_shared and fall back to using mongocryptd.
67
68       SEE ALSO:
69          mongoc_client_enable_auto_encryption()
70
71          In-Use Encryption
72
73          MongoDB Manual documentation for crypt_shared: Automatic Encryption Shared Library
74
75          MongoDB Manual documentation for mongocryptd: Install and Configure mongocryptd
76
77

AUTHOR

79       MongoDB, Inc
80

82       2017-present, MongoDB, Inc
83
84
85
86
871.24.3                           Aug 17M,ON2G0O2C3_AUTO_ENCRYPTION_OPTS_SET_EXTRA(3)
Impressum