MONGOC_CLIENT_...BSTRING_OPTS_T(3)

📦 version 2.2.2, in ubuntu resolute

💖 MONGOC_CLIENT_ENCRYPTION_ENCRYPT_TEXT_SUBSTRING_OPTS_T 💖

okay bestie, sit down, we're doing a libmongoc one today — this is the manual page for MONGOC_CLIENT_...BSTRING_OPTS_T(3) (the full name is a whole mouthful, hence the dramatic ellipsis, slay). it's the Text Substring Opts situation. let's get into it 💅

✨ SYNOPSIS ✨

typedef struct _mongoc_client_encryption_encrypt_text_substring_opts_t mongoc_client_encryption_encrypt_text_substring_opts_t;

added in version 2.2.0, so if you're on something older, no substring opts for you babe 🫶

🌸 THE VIBES (aka what even is this) 🌸

TextSubstringOpts is the options struct for a Queryable Encryption field that supports "substringPreview" queries. it's literally the thing you hand over to set options for mongoc_client_encryption_encrypt_text_opts_set_substring().

like, that's the whole job. it holds the options. it's giving ✨options✨.

🚨 BESTIE. READ THIS PART. ACTUALLY READ IT. 🚨 the "TextPreview" algorithm is in preview and should be used for experimental workloads only. these features are unstable and their security is not guaranteed until they get released as Generally Available (GA). and — and this is the part that gets people — the GA version of these features may not be backwards compatible with the preview version. so if you build your whole little house on preview land, don't come crying when GA moves the furniture. 😭

👀 SEE ALSO 👀

  • mongoc_client_encryption_encrypt()
  • mongoc_client_encryption_encrypt_opts_t

iykyk, go read those next, they're the neighbors 🦋

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

that's the whole page, no notes 💜 it was libmongoc version 2.2.2, dated Feb 13, 202 (yes the page literally cuts off there, the manpage said "that's all you get"), and it came to you from the MONGOC_CLIENT_...BSTRING_OPTS_T(3) page in the libmongoc manual. periodt. 🎀✨

📦 where this page comes from