mongoc_gridfs_bucket_upload_from_stream_with_id

Synopsis

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);

Parameters

opts may be NULL or a BSON document with additional command options:

Description

Reads from the source stream and writes to a new file in GridFS. To have libmongoc generate an id, use mongoc_gridfs_bucket_upload_from_stream() <>.

Reads from the source stream using mongoc_stream_read() <> until the return value indicates end-of-file. The source stream is not closed after calling mongoc_gridfs_bucket_upload_from_stream() <>; call mongoc_stream_close() <> after.

Returns

True if the operation succeeded. False otherwise and sets error.

See also:

mongoc_stream_file_new() <> and mongoc_stream_file_new_for_path() <>, which can be used to create a source stream from a file.

Author

MongoDB, Inc

Info

Jan 27, 2026 1.30.6 libmongoc