Mark factorial operator, and postfix operators in general, as deprecated.
authorTom Lane <tgl@sss.pgh.pa.us>
Sun, 30 Aug 2020 20:03:19 +0000 (16:03 -0400)
committerTom Lane <tgl@sss.pgh.pa.us>
Sun, 30 Aug 2020 20:03:19 +0000 (16:03 -0400)
Back-patch key parts of 4c5cf5431 and 6ca547cf7 into stable branches.
I didn't touch pg_description entries here, so it's purely a docs
change; and I didn't fool with any examples either.  The main point
is so that anyone who's wondering if factorial() exists in the stable
branches will be reassured.

Mark Dilger and John Naylor, with some adjustments by me

Discussion: https://postgr.es/m/BE2DF53D-251A-4E26-972F-930E523580E9@enterprisedb.com

doc/src/sgml/func.sgml
doc/src/sgml/ref/create_operator.sgml

index 970d8d99e0c473bc0ca1c45faca6f8db79f46fbc..0c5f8068c7b36eb0f6c4f20709f5aaaa4874ca50 100644 (file)
 
       <row>
        <entry> <literal>!</literal> </entry>
-       <entry>factorial</entry>
+       <entry>factorial
+        (deprecated, use <function>factorial()</function> instead)</entry>
        <entry><literal>5 !</literal></entry>
        <entry><literal>120</literal></entry>
       </row>
 
       <row>
        <entry> <literal>!!</literal> </entry>
-       <entry>factorial (prefix operator)</entry>
+       <entry>factorial as a prefix operator
+        (deprecated, use <function>factorial()</function> instead)</entry>
        <entry><literal>!! 5</literal></entry>
        <entry><literal>120</literal></entry>
       </row>
        <entry><literal>2.71828182845905</literal></entry>
       </row>
 
+      <row>
+       <entry>
+        <indexterm>
+         <primary>factorial</primary>
+        </indexterm>
+        <literal><function>factorial(<type>bigint</type>)</function></literal>
+       </entry>
+       <entry><type>numeric</type></entry>
+       <entry>factorial</entry>
+       <entry><literal>factorial(5)</literal></entry>
+       <entry><literal>120</literal></entry>
+      </row>
+
       <row>
        <entry>
         <indexterm>
index 818e3a2315a569227933d48bde8358042d10b5cf..73ccac7fecf6f8245423b23227073aadbff5dee3 100644 (file)
@@ -87,11 +87,18 @@ CREATE OPERATOR <replaceable>name</replaceable> (
 
   <para>
    At least one of <literal>LEFTARG</> and <literal>RIGHTARG</> must be defined.  For
-   binary operators, both must be defined. For right  unary
+   binary operators, both must be defined. For right unary
    operators, only <literal>LEFTARG</> should be defined, while for left
    unary operators only <literal>RIGHTARG</> should be defined.
   </para>
 
+  <note>
+   <para>
+    Right unary, also called postfix, operators are deprecated and will be
+    removed in <productname>PostgreSQL</productname> version 14.
+   </para>
+  </note>
+
   <para>
    The <replaceable class="parameter">function_name</replaceable>
    procedure must have been previously defined using <command>CREATE