Merge pull request #9997 from JamesDeFabia/15027DENORMALIZE_Options

HPCC-15027 Document DENORMALIZE Options

Reviewed-By: Richard Taylor <richard.taylor@lexisnexis.com>
Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>

docs/ECLLanguageReference/ECLR_mods/BltInFunc-DENORMALIZE.xml

@@ -13,13 +13,22 @@
       <primary>LOCAL</primary>
     </indexterm>] [,NOSORT<indexterm>
       <primary>NOSORT</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><emphasis role="bold">DENORMALIZE(</emphasis><emphasis>parentrecset,
   childrecset, condition, </emphasis><emphasis
   role="bold">GROUP</emphasis><emphasis><indexterm>
       <primary>GROUP</primary>
-    </indexterm>, transform </emphasis><emphasis role="bold"> [,LOCAL] [,NOSORT] </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>, transform </emphasis><emphasis role="bold"> [,LOCAL]
+  [,NOSORT] </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">
@@ -83,50 +92,70 @@
             records are passed as a dataset parameter to the
             transform.</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>
@@ -155,7 +184,10 @@
   <para>Because DENORMALIZE is basically a specialized form of JOIN, the
   various join types (LEFT OUTER, RIGHT OUTER, FULL OUTER, LEFT ONLY, RIGHT
   ONLY, FULL ONLY) are also available for use on DENORMALIZE and act just as
-  they do with JOIN.</para>
+  they do with JOIN. </para>
+
+  <para>All JOIN options are available for DENORMALIZE. See <link
+  linkend="JoinOptions">Join Options</link> for details. </para>
 
   <sect2 id="TRANSFORM_Function_Requirements_Denormalize">
     <title>DENORMALIZE TRANSFORM Function Requirements</title>

docs/ECLLanguageReference/ECLR_mods/BltInFunc-JOIN.xml

@@ -197,7 +197,7 @@
       </indexterm></emphasis>.</para>
   </sect2>
 
-  <sect2 id="Options">
+  <sect2 id="JoinOptions">
     <title>Options</title>
 
     <para>The following <emphasis>joinflags</emphasis><indexterm>
@@ -232,8 +232,8 @@
         <primary>LOCAL</primary>
       </indexterm> | HASH<indexterm>
         <primary>HASH</primary>
-      </indexterm> ]]</emphasis><emphasis role="bold"></emphasis><?linebreak?><emphasis role="bold">[</emphasis>,<emphasis role="bold">
-    KEEP<indexterm>
+      </indexterm> ]]</emphasis><emphasis role="bold"></emphasis><?linebreak ?><emphasis
+    role="bold">[</emphasis>,<emphasis role="bold"> KEEP<indexterm>
         <primary>KEEP</primary>
       </indexterm>(</emphasis><emphasis>n</emphasis><emphasis role="bold">) ]
     [</emphasis><emphasis>, </emphasis><emphasis role="bold">ATMOST<indexterm>
@@ -257,7 +257,11 @@
       </indexterm>( </emphasis><emphasis>size</emphasis><emphasis role="bold">
     ) ] ] [, SMART<indexterm>
         <primary>SMART</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>
 
     <informaltable colsep="1" frame="all" rowsep="1">
       <tgroup cols="2">
@@ -554,47 +558,66 @@
           <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>
         </tbody>
       </tgroup>
@@ -894,7 +917,11 @@ SEQUENTIAL(PtblOut,Bld1,Bld2,OUTPUT(FilledRecs1),OUTPUT(FilledRecs2))
         <primary>SORTED</primary>
       </indexterm>( </emphasis><emphasis>fields</emphasis><emphasis
     role="bold">) [</emphasis><emphasis>, jointype</emphasis><emphasis
-    role="bold">] </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>
+    role="bold">] </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><emphasis role="bold"><emphasis>The second form of JOIN is similar
     to the MERGEJOIN function<indexterm>