mongoc_auto_encryption_opts_set_extra()¶
Synopsis¶
void
mongoc_auto_encryption_opts_set_extra (mongoc_auto_encryption_opts_t *opts,
const bson_t *extra);
Parameters¶
opts: The mongoc_auto_encryption_opts_textra: Abson_tof additional options.
extra is a bson_t containing any of the following optional fields:
mongocryptdURIset to a URI to connect to the mongocryptd process (default is “mongodb://localhost:27020”).mongocryptdBypassSpawnset to true to prevent the driver from spawning the mongocryptd process (default behavior is to spawn).mongocryptdSpawnPathset to a path (with trailing slash) to search for mongocryptd (defaults to empty string and uses default system paths).mongocryptdSpawnArgsset to an array of string arguments to pass tomongocryptdwhen spawning (defaults to[ "--idleShutdownTimeoutSecs=60" ]).cryptSharedLibPath- Set a filepath string referring to acrypt_sharedlibrary file. Unset by default.If not set (the default),
libmongocryptwill attempt to loadcrypt_sharedusing the host system’s default dynamic-library-search system.If set, the given path should identify the
crypt_shareddynamic library file itself, not the directory that contains it.If the given path is a relative path and the first path component is
$ORIGIN, the$ORIGINcomponent will be replaced with the absolute path to the directory containing thelibmongocryptlibrary in use by the application.Note
No other
RPATH/RUNPATH-style substitutions are available.If the given path is a relative path, the path will be resolved relative to the working directory of the operating system process.
If this option is set and
libmongocryptfails to loadcrypt_sharedfrom the given filepath,libmongocryptwill fail to initialize and will not attempt to search forcrypt_sharedin any other locations.
cryptSharedLibRequired- If set totrue, andlibmongocryptfails to load acrypt_sharedlibrary, initialization of auto-encryption will fail immediately and will not attempt to spawnmongocryptd.If set to
false(the default),cryptSharedLibPathis not set, andlibmongocryptfails to loadcrypt_shared, thenlibmongocryptwill proceed withoutcrypt_sharedand fall back to usingmongocryptd.
See also
crypt_shared: Automatic Encryption Shared Librarymongocryptd: Install and Configure mongocryptd