Skip to content

[mongodb] Document stringOpts and String algorithm constants for ClientEncryption::encrypt() #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GromNaN wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[mongodb] Document stringOpts and String algorithm constants for ClientEncryption::encrypt() #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fac5fa5
[mongodb] Document stringOpts and String algorithm constants for Clie…
GromNaN Oct 26, 2026
29f1285
[mongodb] Complete the changelog for versions 2.3 to 2.5
GromNaN Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 106 additions & 4 deletions reference/mongodb/entities.mongodb.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,7 @@ local: {
<member><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant></member>
<member><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</constant></member>
<member><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant></member>
<member><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant></member>
</simplelist>
</entry>
</row>
Expand All @@ -555,9 +556,10 @@ local: {
<simpara>
This option only applies and may only be specified when
<literal>algorithm</literal> is
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>,
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>,
or
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>.
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
</entry>
</row>
Expand Down Expand Up @@ -595,12 +597,17 @@ local: {
<simplelist>
<member><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</constant></member>
<member><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE</constant></member>
<member><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_PREFIX</constant></member>
<member><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUFFIX</constant></member>
<member><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUBSTRING</constant></member>
</simplelist>
<simpara>
This option only applies and may only be specified when
<literal>algorithm</literal> is
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>
or <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>.
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>,
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>,
or
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
</entry>
</row>
Expand Down Expand Up @@ -669,6 +676,101 @@ local: {
</para>
</entry>
</row>
<row>
<entry>stringOpts</entry>
<entry><type>array</type></entry>
<entry>
<simpara>
Index options for a queryable encryption field supporting "prefix",
"suffix", or "substring" queries. This option may only be specified
when <literal>algorithm</literal> is
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
The options below must match the values set in the
<literal>encryptedFields</literal> of the target collection. Length
options are 32-bit integers.
</simpara>
<para>
<table>
<title>String index options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Option</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>caseSensitive</entry>
<entry><type>bool</type></entry>
<entry>
Whether queries are case sensitive. If &false;, letter case is
ignored, so a query for <literal>"hello"</literal> also
matches <literal>"Hello"</literal>.
</entry>
</row>
<row>
<entry>diacriticSensitive</entry>
<entry><type>bool</type></entry>
<entry>
Whether queries are diacritic sensitive. If &false;, diacritical
marks are ignored, so a query for <literal>"resume"</literal>
also matches <literal>"résumé"</literal>.
</entry>
</row>
<row>
<entry>prefix</entry>
<entry><type>array</type></entry>
<entry>
<simpara>
Options for "prefix" queries. Requires
<literal>algorithm</literal> to be
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
<simplelist>
<member><literal>strMinQueryLength</literal> (<type>int</type>)</member>
<member><literal>strMaxQueryLength</literal> (<type>int</type>)</member>
</simplelist>
</entry>
</row>
<row>
<entry>suffix</entry>
<entry><type>array</type></entry>
<entry>
<simpara>
Options for "suffix" queries. Requires
<literal>algorithm</literal> to be
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
<simplelist>
<member><literal>strMinQueryLength</literal> (<type>int</type>)</member>
<member><literal>strMaxQueryLength</literal> (<type>int</type>)</member>
</simplelist>
</entry>
</row>
<row>
<entry>substring</entry>
<entry><type>array</type></entry>
<entry>
<simpara>
Options for "substring" queries. Requires
<literal>algorithm</literal> to be
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
<simplelist>
<member><literal>strMaxLength</literal> (<type>int</type>)</member>
<member><literal>strMinQueryLength</literal> (<type>int</type>)</member>
<member><literal>strMaxQueryLength</literal> (<type>int</type>)</member>
</simplelist>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down
77 changes: 77 additions & 0 deletions reference/mongodb/mongodb/driver/clientencryption.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@
<varname linkend="mongodb-driver-clientencryption.constants.algorithm-range">MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</varname>
<initializer>Range</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="mongodb-driver-clientencryption.constants.algorithm-string">MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</varname>
<initializer>String</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
Expand All @@ -79,6 +85,24 @@
<varname linkend="mongodb-driver-clientencryption.constants.query-type-range">MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE</varname>
<initializer>range</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="mongodb-driver-clientencryption.constants.query-type-prefix">MongoDB\Driver\ClientEncryption::QUERY_TYPE_PREFIX</varname>
<initializer>prefix</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="mongodb-driver-clientencryption.constants.query-type-suffix">MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUFFIX</varname>
<initializer>suffix</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="mongodb-driver-clientencryption.constants.query-type-substring">MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUBSTRING</varname>
<initializer>substring</initializer>
</fieldsynopsis>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-driver-clientencryption')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
Expand Down Expand Up @@ -142,6 +166,18 @@
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.algorithm-string">
<term><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant></term>
<listitem>
<simpara>
Specifies an algorithm for a string encrypted payload, which can be used
with queryable encryption for prefix, suffix, and substring queries. The
<literal>"stringOpts"</literal> encryption option configures the
supported queries.
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.query-type-equality">
<term><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</constant></term>
<listitem>
Expand All @@ -162,6 +198,36 @@
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.query-type-prefix">
<term><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_PREFIX</constant></term>
<listitem>
<simpara>
Specifies a prefix query type, which is used in conjunction with
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.query-type-suffix">
<term><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUFFIX</constant></term>
<listitem>
<simpara>
Specifies a suffix query type, which is used in conjunction with
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="mongodb-driver-clientencryption.constants.query-type-substring">
<term><constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUBSTRING</constant></term>
<listitem>
<simpara>
Specifies a substring query type, which is used in conjunction with
<constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>.
</simpara>
</listitem>
</varlistentry>

</variablelist>
</section>
<!-- }}} -->
Expand All @@ -177,6 +243,17 @@
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.6.0</entry>
<entry>
<simpara>
Added <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_STRING</constant>,
<constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_PREFIX</constant>,
<constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUFFIX</constant>,
and <constant>MongoDB\Driver\ClientEncryption::QUERY_TYPE_SUBSTRING</constant>.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 2.0.0</entry>
<entry>
Expand Down
6 changes: 6 additions & 0 deletions reference/mongodb/mongodb/driver/clientencryption/encrypt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.6.0</entry>
<entry>
Added the <literal>"stringOpts"</literal> option.
</entry>
</row>
<row>
<entry>PECL mongodb 1.20.0</entry>
<entry>
Expand Down
20 changes: 20 additions & 0 deletions reference/mongodb/mongodb/driver/manager/construct.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,26 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.5.0</entry>
<entry>
<simpara>
If a <literal>SystemOverloadedError</literal> response includes a
positive <literal>baseBackoffMS</literal> value, the driver uses this
server-supplied base backoff in place of its default base backoff when
calculating the delay before a retry.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 2.3.0</entry>
<entry>
<simpara>
Added the <literal>"maxAdaptiveRetries"</literal> and
<literal>"enableOverloadRetargeting"</literal> URI options.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 2.0.0</entry>
<entry>
Expand Down
8 changes: 8 additions & 0 deletions reference/mongodb/mongodb/driver/readconcern.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,14 @@
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.4.0</entry>
<entry>
<simpara>
<classname>MongoDB\Driver\ReadConcern</classname> objects can now be cloned.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 2.3.0</entry>
<entry>
Expand Down
17 changes: 16 additions & 1 deletion reference/mongodb/mongodb/driver/readpreference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,25 @@
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.4.0</entry>
<entry>
<simpara>
<classname>MongoDB\Driver\ReadPreference</classname> objects can now be cloned.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 2.3.0</entry>
<entry>
Added public <modifier>readonly</modifier> properties.
<simpara>
Added public <modifier>readonly</modifier> properties.
</simpara>
<simpara>
Deprecated the <literal>"hedge"</literal> option and the
<varname>hedge</varname> property, as hedged reads are deprecated in
MongoDB 8.0.
</simpara>
</entry>
</row>
<row>
Expand Down
8 changes: 8 additions & 0 deletions reference/mongodb/mongodb/driver/writeconcern.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,14 @@
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.4.0</entry>
<entry>
<simpara>
<classname>MongoDB\Driver\WriteConcern</classname> objects can now be cloned.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 2.3.0</entry>
<entry>
Expand Down
Loading