encryptexpression.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 344035 $ -->

<refentry xml:id="mongodb-driver-clientencryption.encryptexpression" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoDB\Driver\ClientEncryption::encryptExpression</refname>
  <refpurpose>Encrypts a match or aggregate expression</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <type>object</type><methodname>MongoDB\Driver\ClientEncryption::encryptExpression</methodname>
   <methodparam><type class="union"><type>array</type><type>object</type></type><parameter>expr</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Encrypts a match or aggregate expression to query a range index.
  </para>
  <para>To query with a range encrypted payload, the <classname>MongoDB\Driver\Manager</classname> must be configured with the <literal>"autoEncryption"</literal> driver option. The <literal>"bypassQueryAnalysis"</literal> auto encryption option may be &true;. The <literal>"bypassAutoEncryption"</literal> auto encryption option must be &false;.</para>
  <note>
   <para>The range algorithm is experimental only. It is not intended for public use.</para>
   <para>The PHP driver does not yet support range queries for decimal128 BSON field types.</para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>expr</parameter></term>
    <listitem>
     <para>
      The match or aggregate expression to be encrypted. Expressions must use at
      least one of the <literal>$gt</literal>, <literal>$gte</literal>,
      <literal>$lt</literal>, or <literal>$lte</literal> operators. A top-level
      <literal>$and</literal> operator is required, even if only a single
      comparison operator is used.
     </para>
     <para>
      An example of a supported match expression (applies to queries and the
      <literal>$match</literal> aggregation stage) is as follows:
     </para>
     <programlisting role="text">
<![CDATA[
[
    '$and' => [
        [ '<field>' => [ '$gt'  => '<value1>' ] ],
        [ '<field>' => [ '$lte' => '<value2>' ] ],
    ],
]
]]>
     </programlisting>
     <para>
      An example of a supported aggregate expression is as follows:
     </para>
     <programlisting role="text">
<![CDATA[
[
    '$and' => [
        [ '$gte' => [ '<fieldPath>', '<value1>' ] ],
        [ '$lt'  => [ '<fieldPath>', '<value2>' ] ],
    ],
]
]]>
     </programlisting>
    </listitem>
   </varlistentry>
   &mongodb.parameter.encryptOpts;
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the encrypted expression as an object.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simplelist>
   &mongodb.throws.argumentparsing;
   <member>Throws <classname>MongoDB\Driver\Exception\EncryptionException</classname> if an error occurs while encrypting the expression</member>
  </simplelist>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>MongoDB\Driver\Manager::__construct</function></member>
  </simplelist>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->