manpages

mongoc_gridfs_bucket_open_upload_stream(3)

MONGOC_GRIDFS_BUCKET_OPEN_UPLOAD_STREAM(3) libmongoc MONGOC_GRIDFS_BUCKET_OPEN_UPLOAD_STREAM(3)

SYNOPSIS

mongoc_stream_t *
mongoc_gridfs_bucket_open_upload_stream (mongoc_gridfs_bucket_t *bucket,


                                         const char *filename,


                                         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.
  • opts: A bson_t <https://www.mongoc.org/libbson/current/bson_t.html> or NULL.
  • file_id: A bson_value_t <https://www.mongoc.org/libbson/current/bson_value_t.html> to receive the generated id of the file or NULL.
  • error: A bson_error_t <https://www.mongoc.org/libbson/current/bson_error_t.html> 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 <https://www.mongoc.org/libbson/current/bson_t.html> representing metadata to include with the file.

DESCRIPTION

Opens a stream for writing to a new file in GridFS. The file id is generated automatically. To specify an explicit file id, use mongoc_gridfs_bucket_open_upload_stream_with_id() <>.

RETURNS

A mongoc_stream_t <> that can be written to or NULL on failure. Errors on this stream can be retrieved with mongoc_gridfs_bucket_stream_error() <>. After calling mongoc_stream_close() <> the file is completely written in GridFS.

See also:

mongoc_gridfs_bucket_open_upload_stream_with_id() <>

mongoc_gridfs_bucket_stream_error() <>



Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

February 10, 2026 1.30.7