.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MONGOC_AUTO_ENCRYPTION_OPTS_SET_EXTRA" "3" "May 07, 2024" "1.27.1" "libmongoc"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
void
mongoc_auto_encryption_opts_set_extra (mongoc_auto_encryption_opts_t *opts,
                                       const bson_t *extra);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBopts\fP: The \fI\%mongoc_auto_encryption_opts_t\fP
.IP \(bu 2
\fBextra\fP: A \fI\%bson_t\fP of additional options.
.UNINDENT
.sp
\fBextra\fP is a \fI\%bson_t\fP containing any of the following optional fields:
.INDENT 0.0
.IP \(bu 2
\fBmongocryptdURI\fP set to a URI to connect to the mongocryptd process (default is \(dqmongodb://localhost:27020\(dq).
.IP \(bu 2
\fBmongocryptdBypassSpawn\fP set to true to prevent the driver from spawning the mongocryptd process (default behavior is to spawn).
.IP \(bu 2
\fBmongocryptdSpawnPath\fP set to a path (with trailing slash) to search for mongocryptd (defaults to empty string and uses default system paths).
.IP \(bu 2
\fBmongocryptdSpawnArgs\fP set to an array of string arguments to pass to \fBmongocryptd\fP when spawning (defaults to \fB[ \(dq\-\-idleShutdownTimeoutSecs=60\(dq ]\fP).
.IP \(bu 2
\fBcryptSharedLibPath\fP \- Set a filepath string referring to a \fBcrypt_shared\fP
library file. Unset by default.
.INDENT 2.0
.IP \(bu 2
If not set (the default), \fBlibmongocrypt\fP will attempt to load
\fBcrypt_shared\fP using the host system\(aqs default dynamic\-library\-search
system.
.IP \(bu 2
If set, the given path should identify the \fBcrypt_shared\fP dynamic library
file itself, not the directory that contains it.
.IP \(bu 2
If the given path is a relative path and the first path component is
\fB$ORIGIN\fP, the \fB$ORIGIN\fP component will be replaced with the absolute
path to the directory containing the \fBlibmongocrypt\fP library in use by the
application.
.sp
\fBNOTE:\fP
.INDENT 2.0
.INDENT 3.5
No other \fBRPATH\fP/\fBRUNPATH\fP\-style substitutions are available.
.UNINDENT
.UNINDENT
.IP \(bu 2
If the given path is a relative path, the path will be resolved relative to
the working directory of the operating system process.
.IP \(bu 2
If this option is set and \fBlibmongocrypt\fP fails to load \fBcrypt_shared\fP from the
given filepath, \fBlibmongocrypt\fP will fail to initialize and will not
attempt to search for \fBcrypt_shared\fP in any other locations.
.UNINDENT
.IP \(bu 2
\fBcryptSharedLibRequired\fP \- If set to \fBtrue\fP, and \fBlibmongocrypt\fP fails
to load a \fBcrypt_shared\fP library, initialization of auto\-encryption will
fail immediately and will not attempt to spawn \fBmongocryptd\fP\&.
.sp
If set to \fBfalse\fP (the default), \fBcryptSharedLibPath\fP is not set, \fIand\fP
\fBlibmongocrypt\fP fails to load \fBcrypt_shared\fP, then \fBlibmongocrypt\fP will
proceed without \fBcrypt_shared\fP and fall back to using \fBmongocryptd\fP\&.
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
.nf
\fI\%mongoc_client_enable_auto_encryption()\fP
.fi
.sp
.nf
\fI\%In\-Use Encryption\fP
.fi
.sp
.nf
MongoDB Manual documentation for \fBcrypt_shared\fP: \fI\%Automatic Encryption Shared Library\fP
.fi
.sp
.nf
MongoDB Manual documentation for \fBmongocryptd\fP: \fI\%Install and Configure mongocryptd\fP
.fi
.sp
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.