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

SYNOPSIS

6          void
7          mongoc_auto_encryption_opts_set_extra (mongoc_auto_encryption_opts_t *opts,
8                                                 const bson_t *extra);
9

PARAMETERS

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

AUTHOR

75       MongoDB, Inc
76

78       2017-present, MongoDB, Inc
79
80
81
82
831.25.1                           Nov 08M,ON2G0O2C3_AUTO_ENCRYPTION_OPTS_SET_EXTRA(3)
Impressum