MONGOC_CLIENT_GET_GRIDFS(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💅 MONGOC_CLIENT_GET_GRIDFS(3) 💅

okay so bestie, this is the libmongoc page for mongoc_client_get_gridfs(3), and it's literally your go-to for getting a GridFS handle. no cap, the whole assignment is that this function shall create a brand-new mongoc_gridfs_t. let's get into it 💖

✨ SYNOPSIS ✨

mongoc_gridfs_t *
mongoc_client_get_gridfs (mongoc_client_t *client,
                          const char *db,
                          const char *prefix,
                          bson_error_t *error);

The mongoc_client_get_gridfs() function shall create a new mongoc_gridfs_t — main character behavior only. The db parameter is the name of the database which the gridfs instance should exist in. The prefix parameter corresponds to the gridfs collection namespacing; its default is "fs", thus the default GridFS collection names are "fs.files" and "fs.chunks". 🦋

🎀 PARAMETERS 🎀

  • client — A mongoc_client_t. your connection bestie, the one carrying the whole vibe.
  • db — The database name. this tells the gridfs instance where it should exist.
  • prefix — Optional prefix for gridfs collection names or NULL. leave it out and the default namespacing does its thing.
  • error — An optional location for a bson_error_t or NULL. if you want the tea when something goes wrong, pass this bestie.

💀 ERRORS 💀

Errors are propagated via the error parameter. no extra drama — the error info just travels through there.

🌈 RETURNS 🌈

On success, returns a mongoc_gridfs_t you must free with mongoc_gridfs_destroy(). Returns NULL upon failure and sets error. so yeah, if it works, remember to destroy it — don't just leave it lying around, that's not iconic.

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

xoxo, bestie — this little page is from libmongoc version 2.5.6, dated Oct 09, 2026 💜✨

📦 where this page comes from