Browse Source

HPCC-15113 Add DEDUP MANY option to docs

Signed-off-by: Jim DeFabia <jamesdefabia@lexisnexis.com>
Jim DeFabia 8 years ago
parent
commit
3e9c4c7a63
1 changed files with 46 additions and 12 deletions
  1. 46 12
      docs/ECLLanguageReference/ECLR_mods/BltInFunc-DEDUP.xml

+ 46 - 12
docs/ECLLanguageReference/ECLR_mods/BltInFunc-DEDUP.xml

@@ -10,7 +10,7 @@
       <primary>DEDUP function</primary>
     </indexterm>(</emphasis><emphasis>recordset </emphasis><emphasis
   role="bold">[,</emphasis><emphasis> condition </emphasis><emphasis
-  role="bold">[, ALL<indexterm>
+  role="bold">[[MANY], ALL<indexterm>
       <primary>ALL</primary>
     </indexterm>[, HASH<indexterm>
       <primary>HASH</primary>
@@ -20,7 +20,11 @@
   [</emphasis>,<emphasis> keeper </emphasis><emphasis role="bold">] ]
   [</emphasis><emphasis>, </emphasis><emphasis role="bold">LOCAL<indexterm>
       <primary>LOCAL</primary>
-    </indexterm>]</emphasis> <emphasis role="bold">[, UNORDERED | ORDERED(</emphasis> <emphasis>bool </emphasis><emphasis role="bold">) ] [, STABLE | UNSTABLE ] [, PARALLEL [ (</emphasis> <emphasis>numthreads </emphasis><emphasis role="bold">) ] ] [, ALGORITHM(</emphasis> <emphasis>name </emphasis><emphasis role="bold">) ] )</emphasis></para>
+    </indexterm>]</emphasis> <emphasis role="bold">[, UNORDERED |
+  ORDERED(</emphasis> <emphasis>bool </emphasis><emphasis role="bold">) ] [,
+  STABLE | UNSTABLE ] [, PARALLEL [ (</emphasis> <emphasis>numthreads
+  </emphasis><emphasis role="bold">) ] ] [, ALGORITHM(</emphasis>
+  <emphasis>name </emphasis><emphasis role="bold">) ] )</emphasis></para>
 
   <para><informaltable colsep="1" frame="all" rowsep="1">
       <tgroup cols="2">
@@ -52,6 +56,14 @@
           </row>
 
           <row>
+            <entry><emphasis role="bold">MANY</emphasis></entry>
+
+            <entry>Optional. Specifies or perform a local sort/dedup before
+            finding duplicates globally. This is most useful when many
+            duplicates are expected.</entry>
+          </row>
+
+          <row>
             <entry><emphasis role="bold">ALL</emphasis></entry>
 
             <entry>Optional. Matches the condition against all records, not
@@ -96,50 +108,70 @@
             with all other nodes to acquire data; the operation maintains the
             distribution of any previous DISTRIBUTE.</entry>
           </row>
+
           <row>
             <entry><emphasis role="bold">UNORDERED</emphasis></entry>
 
-            <entry>Optional. Specifies the output record order is not significant.</entry>
+            <entry>Optional. Specifies the output record order is not
+            significant.</entry>
           </row>
+
           <row>
             <entry><emphasis role="bold">ORDERED</emphasis></entry>
 
-            <entry>Specifies the significance of the output record order.</entry>
+            <entry>Specifies the significance of the output record
+            order.</entry>
           </row>
+
           <row>
             <entry><emphasis>bool</emphasis></entry>
 
-            <entry>When False, specifies the output record order is not significant. When True, specifies the default output record order.</entry>
+            <entry>When False, specifies the output record order is not
+            significant. When True, specifies the default output record
+            order.</entry>
           </row>
+
           <row>
             <entry><emphasis role="bold">STABLE</emphasis></entry>
 
-            <entry>Optional. Specifies the input record order is significant.</entry>
+            <entry>Optional. Specifies the input record order is
+            significant.</entry>
           </row>
+
           <row>
             <entry><emphasis role="bold">UNSTABLE</emphasis></entry>
 
-            <entry>Optional. Specifies the input record order is not significant.</entry>
+            <entry>Optional. Specifies the input record order is not
+            significant.</entry>
           </row>
+
           <row>
             <entry><emphasis role="bold">PARALLEL</emphasis></entry>
 
-            <entry>Optional. Try to evaluate this activity in parallel.</entry>
+            <entry>Optional. Try to evaluate this activity in
+            parallel.</entry>
           </row>
+
           <row>
             <entry><emphasis>numthreads</emphasis></entry>
 
-            <entry>Optional. Try to evaluate this activity using <emphasis>numthreads</emphasis> threads.</entry>
+            <entry>Optional. Try to evaluate this activity using
+            <emphasis>numthreads</emphasis> threads.</entry>
           </row>
+
           <row>
             <entry><emphasis role="bold">ALGORITHM</emphasis></entry>
 
-            <entry>Optional. Override the algorithm used for this activity.</entry>
+            <entry>Optional. Override the algorithm used for this
+            activity.</entry>
           </row>
+
           <row>
             <entry><emphasis>name</emphasis></entry>
 
-            <entry>The algorithm to use for this activity. Must be from the list of supported algorithms for the SORT function's STABLE and UNSTABLE options.</entry>
+            <entry>The algorithm to use for this activity. Must be from the
+            list of supported algorithms for the SORT function's STABLE and
+            UNSTABLE options.</entry>
           </row>
 
           <row>
@@ -242,6 +274,8 @@ DedupedInqs := DEDUP(inquiry, LEFT.inq_ind_code='BB' AND
 InqCount := COUNT(Inquiry) - COUNT(DedupedInqs);
 OUTPUT(person(InqCount &gt;0),{InqCount});  </programlisting>
 
-    <para>See Also: <link linkend="SORT">SORT</link>, <link linkend="ROLLUP">ROLLUP</link>, <link linkend="TABLE">TABLE</link>, <link linkend="FUNCTION_Structure">FUNCTION Structure</link></para>
+    <para>See Also: <link linkend="SORT">SORT</link>, <link
+    linkend="ROLLUP">ROLLUP</link>, <link linkend="TABLE">TABLE</link>, <link
+    linkend="FUNCTION_Structure">FUNCTION Structure</link></para>
   </sect2>
 </sect1>