Update ext-mongodb docs for queryable encryption range V2

php/doc-en@850a936
php · Jun 19, 2024 · e9ec4e4 · e9ec4e4
1 parent f8bcfe2
commit e9ec4e4
Showing 1 changed file with 27 additions and 12 deletions.
diff --git a/language-snippets.ent b/language-snippets.ent
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: e9214a2619efc5906fab59cd42fb7404c4dc49a5 Maintainer: takagi Status: working -->
+<!-- EN-Revision: 850a9367b8ff7fe0ba91042daf9d61d58c985b1e Maintainer: takagi Status: working -->
 <!-- Credits: hirokawa,haruki,shimooka,mumumu -->
 
 <!ENTITY installation.enabled.disable 'この拡張モジュールはデフォルトで有効になっています。無効にしたい場合は、次のオプションを指定してコンパイルします。'>
@@ -3348,7 +3348,7 @@ local: {
             <member><constant>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</constant></member>
             <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_PREVIEW</constant></member>
+            <member><constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant></member>
            </simplelist>
           </entry>
          </row>
@@ -3365,7 +3365,7 @@ local: {
             <literal>algorithm</literal> is
             <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</constant>
             or
-            <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</constant>.
+            <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>.
            </para>
           </entry>
          </row>
@@ -3407,7 +3407,7 @@ local: {
            <para>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_PREVIEW</constant>.
+            or <constant>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</constant>.
            </para>
           </entry>
          </row>
@@ -3416,10 +3416,10 @@ local: {
           <entry><type>array</type></entry>
           <entry>
            <para>
-            Index options for a queryable encryption field supporting
-            "rangePreview" queries. The options below must match the values set
-            in the <literal>encryptedFields</literal> of the target collection.
-            For double and decimal128 BSON field types, <literal>min</literal>,
+            Index options for a queryable encryption field supporting "range"
+            queries. The options below must match the values set in the
+            <literal>encryptedFields</literal> of the target collection. For
+            double and decimal128 BSON field types, <literal>min</literal>,
             <literal>max</literal>, and <literal>precision</literal> must all be
             set, or all be unset.
            </para>
@@ -3438,22 +3438,37 @@ local: {
                <row>
                 <entry>min</entry>
                 <entry><type>mixed</type></entry>
-                <entry>Required if <literal>precision</literal> is set.</entry>
+                <entry>
+                 Required if <literal>precision</literal> is set. The minimum
+                 BSON value of the range.
+                </entry>
                </row>
                <row>
                 <entry>max</entry>
                 <entry><type>mixed</type></entry>
-                <entry>Required if <literal>precision</literal> is set.</entry>
+                <entry>
+                 Required if <literal>precision</literal> is set. The maximum
+                 BSON value of the range.
+                </entry>
                </row>
                <row>
                 <entry>sparsity</entry>
                 <entry><type>int</type></entry>
-                <entry>Required.</entry>
+                <entry>Required. Positive 64-bit integer.</entry>
                </row>
                <row>
                 <entry>precision</entry>
                 <entry><type>int</type></entry>
-                <entry>Optional. May only be set for double or decimal128 BSON field types.</entry>
+                <entry>
+                 Optional. Positive 32-bit integer specifying precision to use
+                 for explicit encryption. May only be set for double or
+                 decimal128 BSON field types.
+                </entry>
+               </row>
+               <row>
+                <entry>trimFactor</entry>
+                <entry><type>int</type></entry>
+                <entry>Required. Positive 32-bit integer.</entry>
                </row>
               </tbody>
              </tgroup>