Merge pull request #16829 from JamesDeFabia/HPCC-26138SprayDesprayOpt…

…ions HPCC-26138 Document new parameters to spray and despray functions Reviewed-By: Attila Vamos <[email protected]> Merged-by: Gavin Halliday <[email protected]>
hpcc-systems · Jun 21, 2023 · 833be7a · 833be7a
2 parents 6861e1c + 66729a0
commit 833be7a
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 13 deletions.
diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/DeSpray.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/DeSpray.xml
@@ -17,9 +17,9 @@
   <emphasis>espserverIPport </emphasis> <emphasis role="bold">] </emphasis>
   ,<emphasis role="bold"> [</emphasis> <emphasis>maxConnections</emphasis>
   <emphasis role="bold">] </emphasis> ,<emphasis role="bold"> [</emphasis>
-  <emphasis>allowoverwrite</emphasis> <emphasis role="bold">] </emphasis> ,
-  <emphasis role="bold"> [</emphasis> <emphasis>destinationPlane</emphasis>
-  <emphasis role="bold">])</emphasis></para>
+  <emphasis>allowoverwrite</emphasis> <emphasis role="bold">],[</emphasis>
+  <emphasis>destinationPlane</emphasis> <emphasis
+  role="bold">])</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fDeSpray<indexterm>
@@ -35,13 +35,13 @@
   <emphasis>espserverIPport </emphasis> <emphasis role="bold">] </emphasis>
   ,<emphasis role="bold"> [</emphasis> <emphasis>maxConnections</emphasis>
   <emphasis role="bold">] </emphasis> ,<emphasis role="bold"> [</emphasis>
-  <emphasis>allowoverwrite</emphasis> <emphasis role="bold">] , [</emphasis>
+  <emphasis>allowoverwrite</emphasis> <emphasis role="bold">],[</emphasis>
   <emphasis>destinationPlane</emphasis> <emphasis
   role="bold">])</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
-      <colspec colwidth="105.50pt" />
+      <colspec colwidth="130.50pt" />
 
       <colspec />
 

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayFixed.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayFixed.xml
@@ -29,7 +29,10 @@
   <emphasis>dfuServerQueue</emphasis> <emphasis role="bold">] ,
   </emphasis><emphasis role="bold">[</emphasis> <emphasis>noSplit</emphasis>
   <emphasis role="bold">] , </emphasis><emphasis role="bold">[</emphasis>
-  <emphasis>noCommon</emphasis> <emphasis role="bold">])</emphasis></para>
+  <emphasis>noCommon</emphasis> <emphasis role="bold">],[</emphasis>
+  <emphasis>sourcePlane</emphasis> <emphasis role="bold">]<emphasis
+  role="bold">,[</emphasis> <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fSprayFixed<indexterm>
@@ -58,7 +61,10 @@
   </emphasis><emphasis role="bold">[</emphasis>
   <emphasis>noSplit</emphasis><emphasis role="bold">] , </emphasis><emphasis
   role="bold">[</emphasis> <emphasis>noCommon</emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  role="bold">],[</emphasis> <emphasis>sourcePlane</emphasis> <emphasis
+  role="bold">]<emphasis role="bold">,[</emphasis>
+  <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -198,6 +204,20 @@
           significant impact on performance.</entry>
         </row>
 
+        <row>
+          <entry><emphasis>sourcePlane</emphasis></entry>
+
+          <entry>The name of the landing zone containing the file</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>destinationNumParts</emphasis></entry>
+
+          <entry>Override the number of parts to be created when spraying. The
+          default is 0 which means it will create the same number of parts as
+          the target cluster. </entry>
+        </row>
+
         <row>
           <entry><emphasis>dfuwuid</emphasis></entry>
 

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayJson.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayJson.xml
@@ -36,7 +36,10 @@
   </emphasis><emphasis role="bold">[</emphasis>
   <emphasis>noSplit</emphasis><emphasis role="bold">], </emphasis><emphasis
   role="bold">[</emphasis><emphasis>noCommon</emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  role="bold">],[</emphasis> <emphasis>sourcePlane</emphasis> <emphasis
+  role="bold">]<emphasis role="bold">,[</emphasis>
+  <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fSprayJson<indexterm>
@@ -70,7 +73,10 @@
   </emphasis><emphasis role="bold">[</emphasis>
   <emphasis>noSplit</emphasis><emphasis role="bold">], </emphasis><emphasis
   role="bold">[</emphasis><emphasis>noCommon</emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  role="bold">],[</emphasis> <emphasis>sourcePlane</emphasis> <emphasis
+  role="bold">]<emphasis role="bold">,[</emphasis>
+  <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -225,6 +231,20 @@
           significant impact on performance.</entry>
         </row>
 
+        <row>
+          <entry><emphasis>sourcePlane</emphasis></entry>
+
+          <entry>The name of the landing zone containing the file</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>destinationNumParts</emphasis></entry>
+
+          <entry>Override the number of parts to be created when spraying. The
+          default is 0 which means it will create the same number of parts as
+          the target cluster. </entry>
+        </row>
+
         <row>
           <entry><emphasis>dfuwuid</emphasis></entry>
 

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayVariable.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayVariable.xml
@@ -46,7 +46,10 @@
   </emphasis><emphasis role="bold">[</emphasis>
   <emphasis>noSplit</emphasis><emphasis role="bold">] , </emphasis> <emphasis
   role="bold">[</emphasis><emphasis>noCommon</emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  role="bold">],[</emphasis> <emphasis>sourcePlane</emphasis> <emphasis
+  role="bold">]<emphasis role="bold">,[</emphasis>
+  <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fSprayDelimited<indexterm>
@@ -89,7 +92,10 @@
   </emphasis><emphasis role="bold">[</emphasis>
   <emphasis>noSplit</emphasis><emphasis role="bold">] , </emphasis><emphasis
   role="bold">[</emphasis><emphasis>noCommon</emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  role="bold">],[</emphasis> <emphasis>sourcePlane</emphasis> <emphasis
+  role="bold">],<emphasis role="bold">[</emphasis>
+  <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -283,6 +289,20 @@
           significant impact on performance.</entry>
         </row>
 
+        <row>
+          <entry><emphasis>sourcePlane</emphasis></entry>
+
+          <entry>The name of the landing zone containing the file</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>destinationNumParts</emphasis></entry>
+
+          <entry>Override the number of parts to be created when spraying. The
+          default is 0 which means it will create the same number of parts as
+          the target cluster. </entry>
+        </row>
+
         <row>
           <entry><emphasis>dfuwuid</emphasis></entry>
 

diff --git a/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayXML.xml b/docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayXML.xml
@@ -36,7 +36,10 @@
   </emphasis><emphasis role="bold">[</emphasis>
   <emphasis>noSplit</emphasis><emphasis role="bold">], </emphasis><emphasis
   role="bold">[</emphasis><emphasis>noCommon</emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  role="bold">],[</emphasis> <emphasis>sourcePlane</emphasis> <emphasis
+  role="bold">]<emphasis role="bold">,[</emphasis>
+  <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fSprayXML<indexterm>
@@ -70,7 +73,10 @@
   </emphasis><emphasis role="bold">[</emphasis>
   <emphasis>noSplit</emphasis><emphasis role="bold">], </emphasis><emphasis
   role="bold">[</emphasis><emphasis>noCommon</emphasis> <emphasis
-  role="bold">])</emphasis></para>
+  role="bold">],[</emphasis> <emphasis>sourcePlane</emphasis> <emphasis
+  role="bold">]<emphasis role="bold">,[</emphasis>
+  <emphasis>destinationNumParts</emphasis> <emphasis
+  role="bold">]</emphasis>)</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -224,6 +230,20 @@
           significant impact on performance.</entry>
         </row>
 
+        <row>
+          <entry><emphasis>sourcePlane</emphasis></entry>
+
+          <entry>The name of the landing zone containing the file</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>destinationNumParts</emphasis></entry>
+
+          <entry>Override the number of parts to be created when spraying. The
+          default is 0 which means it will create the same number of parts as
+          the target cluster. </entry>
+        </row>
+
         <row>
           <entry><emphasis>dfuwuid</emphasis></entry>