.\" 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_GRIDFS_BUCKET_UPLOAD_FROM_STREAM_WITH_ID" "3" "May 07, 2024" "1.27.1" "libmongoc"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
bool
mongoc_gridfs_bucket_upload_from_stream_with_id (mongoc_gridfs_bucket_t *bucket,
                                                 const bson_value_t *file_id,
                                                 const char *filename,
                                                 mongoc_stream_t *source,
                                                 const bson_t *opts,
                                                 bson_error_t *error);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbucket\fP: A \fI\%mongoc_gridfs_bucket_t\fP\&.
.IP \(bu 2
\fBfile_id\fP: A \fI\%bson_value_t\fP specifying the id of the created file.
.IP \(bu 2
\fBfilename\fP: The name of the file to create.
.IP \(bu 2
\fBsource\fP: A \fI\%mongoc_stream_t\fP used as the source of the data to upload.
.IP \(bu 2
\fBopts\fP: A \fI\%bson_t\fP or \fBNULL\fP\&.
.IP \(bu 2
\fBerror\fP: A \fI\%bson_error_t\fP to receive any error or \fBNULL\fP\&.
.UNINDENT
.sp
\fBopts\fP may be NULL or a BSON document with additional command options:
.INDENT 0.0
.IP \(bu 2
\fBchunkSizeBytes\fP: An \fBint32\fP chunk size to use for this file. Overrides the \fBchunkSizeBytes\fP set on \fBbucket\fP\&.
.IP \(bu 2
\fBmetadata\fP: A \fI\%bson_t\fP representing metadata to include with the file.
.UNINDENT
.SH DESCRIPTION
.sp
Reads from the \fBsource\fP stream and writes to a new file in GridFS.
To have libmongoc generate an id, use \fI\%mongoc_gridfs_bucket_upload_from_stream()\fP\&.
.sp
Reads from the \fBsource\fP stream using \fI\%mongoc_stream_read()\fP until the return value indicates end\-of\-file.
The \fBsource\fP stream is not closed after calling \fI\%mongoc_gridfs_bucket_upload_from_stream()\fP; call \fI\%mongoc_stream_close()\fP after.
.SH RETURNS
.sp
True if the operation succeeded. False otherwise and sets \fBerror\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
.nf
\fI\%mongoc_stream_file_new()\fP and \fI\%mongoc_stream_file_new_for_path()\fP, which can be used to create a source stream from a file.
.fi
.sp
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.