MONGOC_GRIDFS_..._ONE_WITH_OPTS(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💅 MONGOC_GRIDFS_..._ONE_WITH_OPTS (3) — like, the libmongoc one 🦋

okay so bestie, welcome to the GridFS find-one-with-opts page ✨ this is a libmongoc manual page and it's lowkey short but every word is doing its job, so let's get into it 🎀

✨ SYNOPSIS ✨

mongoc_gridfs_file_t *
mongoc_gridfs_find_one_with_opts (mongoc_gridfs_t *gridfs,
                                  const bson_t *filter,
                                  const bson_t *opts,
                                  bson_error_t *error);

look at her. four arguments, one job. iconic 💅

🧚 PARAMETERS 🧚

  • gridfs — a mongoc_gridfs_t. like, the actual GridFS thing you're searching in, bestie 🫶
  • filter — a bson_t holding the query to execute. this is the "what am i even looking for" part 🔍
  • opts — a bson_t of query options, and yes that includes the sort order and which fields to return. it can be NULL, no stress 💖
  • error — an optional place to stash a bson_error_t, or NULL if you're feeling brave 🙈

🌸 DESCRIPTION 🌸

So what does she do? She finds the first GridFS file that matches filter. That's it. That's the whole vibe 🌈

Now the error choreography, because this part is important:

  • if there's an error → NULL is returned and error gets filled out 😭
  • if there's no error but no matching file is found → NULL is returned and the error code and domain are 0 ⭐

yes, both cases hand you NULL, so peek at that error struct to tell them apart. iykyk 💀

Also, go read mongoc_collection_find_with_opts() if you want the full description of the filter and opts parameters — she's the main character for that lore 👑

🔥 Retryable read alert!! This function is considered a retryable read operation. On a transient error (network error, errors due to replica set failover, etc.) the operation is safely retried once. BUT — if retryreads is false in the URI (see mongoc_uri_t), the retry behavior does not apply. no cap, that's the whole rule 🎀

💀 ERRORS 💀

Errors are propagated via the error parameter. that's the channel. that's where they live 🍓

👑 RETURNS 👑

Returns a newly allocated mongoc_gridfs_file_t if successful 🎉

You must free the resulting file with mongoc_gridfs_file_destroy() when no longer in use. not optional, bestie, that's a leak waiting to happen 😭💜

🎀 AUTHOR 🎀

MongoDB, Inc

2009-present, MongoDB, Inc.

and that's the page!! tysm for reading, mwah 💖✨

signing off — version 2.5.6, dated Oct 09, 2024, brought to you by the libmongoc girlies 🫶🎀

📦 where this page comes from