mongoc_gridfs_bucket_upload_from_stream()¶

Synopsis¶

bool
mongoc_gridfs_bucket_upload_from_stream (mongoc_gridfs_bucket_t *bucket,
                                         const char *filename,
                                         mongoc_stream_t *source,
                                         const bson_t *opts,
                                         bson_value_t *file_id,
                                         bson_error_t *error);

Parameters¶

bucket: A mongoc_gridfs_bucket_t.
filename: The name of the file to create.
source: A mongoc_stream_t used as the source of the data to upload.
opts: A bson_t or NULL.
file_id: A bson_value_t to receive the generated id of the file or NULL.
error: A bson_error_t to receive any error or NULL.

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

chunkSizeBytes: An int32 chunk size to use for this file. Overrides the chunkSizeBytes set on bucket.
metadata: A bson_t representing metadata to include with the file.

Description¶

Reads from the source stream and writes to a new file in GridFS. The file id is generated automatically. To specify an explicit file id, use mongoc_gridfs_bucket_upload_from_stream_with_id().

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.