MONGOC_CURSOR_SET_HINT(3)

📦
version 1.30.13 · 13 versions
, in fedora 43

💅 MONGOC_CURSOR_SET_HINT(3) — the libmongoc one, bestie

okay so we're in the libmongoc manual, page MONGOC_CURSOR_SET_HINT(3), and before you get attached — this one's on its way out. 😭 Let's get into it.

🚨 WARNING 🚨

Deprecated since version 1.28.0: use mongoc_cursor_set_server_id() instead.

like... she's retired, fr fr. if you're writing new code, go flirt with mongoc_cursor_set_server_id(). this one is just here so old code doesn't break its little heart. 💔

✨ SYNOPSIS ✨

bool
mongoc_cursor_set_hint (mongoc_cursor_t *cursor, uint32_t server_id);

she takes two things and gives you back a bool. simple queen. 👑

🎀 PARAMETERS 🎀

  • cursor — a mongoc_cursor_t. the cursor we're blessing. 🦋
  • server_id — an opaque id identifying the server to use. it's opaque, bestie, don't try to read its diary. 🙈

💖 DESCRIPTION 💖

so basically: this tells the driver which server to use for the operation. that's the whole vibe.

BUT — and this is the important part — it only has an effect if you call it before the find operation is executed. call it after and it's giving nothing. literally nothing. 💀

also, tiny lore drop: the function name still says "hint" because of backward compatibility (iykyk), but the cool kids now call this number a "server id". the name is vintage, the concept is current. ✨

Use mongoc_cursor_set_hint only for building a language driver that wraps the C Driver. if you're writing applications in C? leave the server id unset and let the driver choose a suitable server from the find operation's read preference. she knows what she's doing, trust her. 🫶

🌈 RETURNS 🌈

  • returns true on success. slay. ✅
  • if any arguments are invalid, returns false and logs an error. so check your args, bestie, the logs are watching. 👀

👑 AUTHOR 👑

MongoDB, Inc — the icons themselves. 💜

2009-present, MongoDB, Inc.

mwah 💋 that's the whole page. this was libmongoc version 1.30.13, dated Oct 09, 2026, and you read it all the way through — main character energy fr. go forth and set your server ids responsibly. 🎀✨🦋

📦 where this page comes from