MONGOC_CLIENT..._SNAPSHOT_TIME(3)

📦
version 2.5.6 · 2 versions
, in epel 10

💅 MONGOC_CLIENT..._SNAPSHOT_TIME(3) ✨

okay so bestie, this one lives in libmongoc and it's literally the glow-up for your session's snapshot time 👑 like, no cap.

🌸 SYNOPSIS 🌸

          bool
          mongoc_client_session_get_snapshot_time (const mongoc_client_session_t *session,
                                                   uint32_t *timestamp,
                                                   uint32_t *increment,
                                                   bson_error_t *error);

🎀 DESCRIPTION 🎀

So this function pulls the session's snapshot time and hands it to you as a BSON Timestamp, split all cute into a timestamp component and an increment component 🫶.

Now, where does that snapshot time even come from? Two vibes only:

  • it's the value you passed to mongoc_session_opts_set_snapshot_time() when the session was started, or
  • it's the atClusterTime the server handed back on the session's very first read operation — and by read op I mean "find", "aggregate" or "distinct" 👀
🚨 real talk: calling this function on a session that was not started with mongoc_session_opts_set_snapshot() set to true is an error. periodt.

And if the session is a snapshot session but no snapshot time has been established yet — like, no read operation has completed and no snapshot time was configured — this function returns false without setting error. she just says nope, quietly 💀 no drama, no error message.

🦋 PARAMETERS 🦋

  • session — A mongoc_client_session_t. the main character 💜
  • timestamp — A pointer to a uint32_t to receive the timestamp component ✨
  • increment — A pointer to a uint32_t to receive the increment component ✨
  • error — An optional location for a bson_error_t, or NULL 🙈

🌈 RETURNS 🌈

Returns true and populates timestamp and increment if the snapshot time is available — slay, it worked 💖. Returns false otherwise, and sets error if the session is not a snapshot session 👑

⭐ AUTHOR ⭐

MongoDB, Inc — the icons behind it all 👑

2009-present, MongoDB, Inc. 🫶

and that's the whole tea, bestie 🧚💅 — this page was brought to you by libmongoc 2.5.6, dated Oct 09, 2026, ilysm, go forth and snapshot responsibly ✨🎀

📦 where this page comes from