HPCC-16850 Document expireDays for file spray

Signed-off-by: Jim DeFabia <jamesdefabia@lexisnexis.com>

docs/ECLStandardLibraryReference/SLR-Mods/SprayFixed.xml

@@ -21,7 +21,11 @@
   allowoverwrite </emphasis> <emphasis role="bold">]</emphasis> ,<emphasis
   role="bold"> [</emphasis> <emphasis> replicate </emphasis> <emphasis
   role="bold">]</emphasis> ,<emphasis role="bold"> [</emphasis> <emphasis>
-  compress </emphasis> <emphasis role="bold">])</emphasis></para>
+  compress </emphasis> <emphasis role="bold">] </emphasis>, <emphasis
+  role="bold">[</emphasis><emphasis>failIfNoSourceFile</emphasis><emphasis
+  role="bold">] </emphasis>,<emphasis
+  role="bold">[</emphasis><emphasis>expireDays</emphasis><emphasis
+  role="bold">])</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fSprayFixed<indexterm>
@@ -40,8 +44,12 @@
   </emphasis> <emphasis role="bold">]</emphasis> , <emphasis role="bold">
   [</emphasis> <emphasis> allowoverwrite </emphasis> <emphasis role="bold">] ,
   [</emphasis> <emphasis> replicate </emphasis> <emphasis role="bold">] ,
-  [</emphasis> <emphasis> compress </emphasis> <emphasis
-  role="bold">]);</emphasis></para>
+  [</emphasis> <emphasis> compress </emphasis><emphasis role="bold">]
+  </emphasis>, <emphasis
+  role="bold">[</emphasis><emphasis>failIfNoSourceFile</emphasis><emphasis
+  role="bold">]</emphasis>, <emphasis
+  role="bold">[</emphasis><emphasis>expireDays</emphasis><emphasis
+  role="bold">])</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -134,9 +142,25 @@
         </row>
 
         <row>
+          <entry><emphasis>failIfNoSourceFile</emphasis></entry>
+
+          <entry>Optional. A boolean TRUE or FALSE flag indicating whether a
+          missing file triggers a failure. If omitted, the default is
+          FALSE.</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>expireDays</emphasis></entry>
+
+          <entry>Optional. A integer value indicating the number of days
+          before automatically removing the file. If omitted, the default is
+          -1 (never expires).</entry>
+        </row>
+
+        <row>
           <entry><emphasis>dfuwuid</emphasis></entry>
 
-          <entry>The attribute name to recieve the null-terminated string
+          <entry>The attribute name to receive the null-terminated string
           containing the DFU workunit ID (DFUWUID) generated for the
           job.</entry>
         </row>

docs/ECLStandardLibraryReference/SLR-Mods/SprayVariable.xml

@@ -2,14 +2,16 @@
 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
 <sect1 id="SprayVariable">
-  <title>SprayVariable</title>
+  <title>SprayDelimited / SprayVariable</title>
 
-  <para><emphasis role="bold">STD.File.SprayVariable<indexterm>
+  <para><emphasis role="bold">STD.File.SprayDelimited<indexterm>
       <primary>STD.File.SprayVariable</primary>
     </indexterm><indexterm>
       <primary>File.SprayVariable</primary>
     </indexterm><indexterm>
       <primary>SprayVariable</primary>
+    </indexterm><indexterm>
+      <primary>SprayDelimited</primary>
     </indexterm>(</emphasis> <emphasis> sourceIP </emphasis> <emphasis
   role="bold">, </emphasis> <emphasis>sourcepath , </emphasis> <emphasis
   role="bold">[</emphasis> <emphasis> maxrecordsize </emphasis> <emphasis
@@ -28,17 +30,27 @@
   role="bold">]</emphasis> ,<emphasis role="bold"> [</emphasis>
   <emphasis>allowoverwrite</emphasis> <emphasis role="bold">] , [</emphasis>
   <emphasis>replicate</emphasis> <emphasis role="bold">] , [</emphasis>
-  <emphasis> compress </emphasis> <emphasis role="bold">] , [</emphasis>
-  <emphasis> sourceCsvEscape </emphasis> <emphasis role="bold">])</emphasis>
-  <emphasis></emphasis></para>
+  <emphasis> compress </emphasis><emphasis role="bold">]</emphasis> ,
+  <emphasis role="bold"> [</emphasis> <emphasis> sourceCsvEscape </emphasis>
+  <emphasis role="bold">]</emphasis>, <emphasis role="bold"> [</emphasis>
+  <emphasis> failIfNoSourceFile </emphasis> <emphasis
+  role="bold">]</emphasis>, <emphasis role="bold"> [</emphasis> <emphasis>
+  recordStructurePresent </emphasis> <emphasis role="bold">]</emphasis>,
+  <emphasis role="bold"> [</emphasis> <emphasis> quotedTerminator </emphasis>
+  <emphasis role="bold">]</emphasis>, <emphasis role="bold"> [</emphasis>
+  <emphasis> encoding </emphasis> <emphasis role="bold">]</emphasis><emphasis
+  role="bold">[</emphasis> <emphasis>expireDays</emphasis> <emphasis
+  role="bold">])</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
-  STD.File.fSprayVariable<indexterm>
+  STD.File.fSprayDelimited<indexterm>
       <primary>STD.File.fSprayVariable</primary>
     </indexterm><indexterm>
       <primary>File.fSprayVariable</primary>
     </indexterm><indexterm>
       <primary>fSprayVariable</primary>
+    </indexterm><indexterm>
+      <primary>fSprayDelimited</primary>
     </indexterm>(</emphasis> <emphasis> sourceIP </emphasis> <emphasis
   role="bold">, </emphasis> <emphasis>sourcepath , </emphasis> <emphasis
   role="bold"> [</emphasis> <emphasis> maxrecordsize </emphasis> <emphasis
@@ -56,9 +68,17 @@
   role="bold">]</emphasis> ,<emphasis role="bold"> [</emphasis>
   <emphasis>allowoverwrite</emphasis> <emphasis role="bold">] , [</emphasis>
   <emphasis>replicate</emphasis> <emphasis role="bold">] , [</emphasis>
-  <emphasis> compress </emphasis> <emphasis role="bold">] , [</emphasis>
-  <emphasis> sourceCsvEscape </emphasis> <emphasis
-  role="bold">]);</emphasis></para>
+  <emphasis> compress </emphasis> <emphasis role="bold">]</emphasis> ,
+  <emphasis role="bold"> [</emphasis> <emphasis> sourceCsvEscape </emphasis>
+  <emphasis role="bold">]</emphasis>, <emphasis role="bold"> [</emphasis>
+  <emphasis> failIfNoSourceFile </emphasis> <emphasis
+  role="bold">]</emphasis>, <emphasis role="bold"> [</emphasis> <emphasis>
+  recordStructurePresent </emphasis> <emphasis role="bold">]</emphasis>,
+  <emphasis role="bold"> [</emphasis> <emphasis> quotedTerminator </emphasis>
+  <emphasis role="bold">]</emphasis>, <emphasis role="bold"> [</emphasis>
+  <emphasis> encoding </emphasis> <emphasis role="bold">]</emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis>expireDays</emphasis> <emphasis
+  role="bold">])</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -204,9 +224,17 @@
         </row>
 
         <row>
+          <entry><emphasis>expireDays</emphasis></entry>
+
+          <entry>Optional. A integer value indicating the number of days
+          before automatically removing the file. If omitted, the default is
+          -1 (never expires).</entry>
+        </row>
+
+        <row>
           <entry><emphasis>encoding</emphasis></entry>
 
-          <entry> A null-terminated string containing the encoding. Can be set
+          <entry>A null-terminated string containing the encoding. Can be set
           to one of the following: ascii, utf8, utf8n, utf16, utf16le,
           utf16be, utf32, utf32le,utf32be. If omitted, the default is
           ascii.</entry>
@@ -223,20 +251,26 @@
         <row>
           <entry>Return:<emphasis> </emphasis></entry>
 
-          <entry>fSprayVariable returns a null-terminated string containing
+          <entry>fSprayDelimited returns a null-terminated string containing
           the DFU workunit ID (DFUWUID).</entry>
         </row>
       </tbody>
     </tgroup>
   </informaltable>
 
-  <para>The <emphasis role="bold">SprayVariable </emphasis>function takes a
+  <para>The <emphasis role="bold">SprayDelimited </emphasis>function takes a
   variable length file from the landing zone and distributes it across the
   nodes of the destination supercomputer.</para>
 
+  <para>The <emphasis role="bold">SprayVariable</emphasis>function is now
+  called <emphasis role="bold">SprayDelimited</emphasis> and the <emphasis
+  role="bold">fSprayVariable</emphasis>function is now called <emphasis
+  role="bold">fSprayDelimited</emphasis>. The old names are still available
+  for backward compatibility.</para>
+
   <para>Example:</para>
 
-  <programlisting format="linespecific">STD.File.SprayVariable('10.150.50.14',
+  <programlisting format="linespecific">STD.File.SprayDelimited('10.150.50.14',
        'c:\\InputData\\MyFile.txt',
        ,,,,
        '400way',

docs/ECLStandardLibraryReference/SLR-Mods/SprayXML.xml

@@ -26,8 +26,12 @@
   <emphasis>maxConnections</emphasis> <emphasis role="bold">]</emphasis>
   <emphasis role="bold"> [</emphasis> <emphasis>allowoverwrite</emphasis>
   <emphasis role="bold">] [</emphasis> <emphasis>replicate</emphasis>
-  <emphasis role="bold">] [</emphasis> <emphasis> compress </emphasis>
-  <emphasis role="bold">])</emphasis></para>
+  <emphasis role="bold">] [</emphasis> <emphasis> compress
+  </emphasis><emphasis role="bold">] </emphasis>, <emphasis
+  role="bold">[</emphasis><emphasis>failIfNoSourceFile</emphasis><emphasis
+  role="bold">]</emphasis>, <emphasis
+  role="bold">[</emphasis><emphasis>expireDays</emphasis><emphasis
+  role="bold">])</emphasis></para>
 
   <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
   STD.File.fSprayXML<indexterm>
@@ -51,7 +55,12 @@
   <emphasis>maxConnections</emphasis> <emphasis role="bold">] , [</emphasis>
   <emphasis>allowoverwrite</emphasis> <emphasis role="bold">] , [</emphasis>
   <emphasis>replicate</emphasis> <emphasis role="bold">] , [</emphasis>
-  <emphasis> compress </emphasis> <emphasis role="bold">]);</emphasis></para>
+  <emphasis> compress </emphasis> <emphasis role="bold">] </emphasis>,
+  <emphasis
+  role="bold">[</emphasis><emphasis>failIfNoSourceFile</emphasis><emphasis
+  role="bold">]</emphasis>, <emphasis
+  role="bold">[</emphasis><emphasis>expireDays</emphasis><emphasis
+  role="bold">])</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -85,7 +94,7 @@
           <entry><emphasis>srcRowTag</emphasis></entry>
 
           <entry>A null-terminated string containing the row delimiting XML
-          tag. Required. </entry>
+          tag. Required.</entry>
         </row>
 
         <row>
@@ -106,7 +115,7 @@
           <entry><emphasis>destinationlogicalname</emphasis></entry>
 
           <entry>A null-terminated string containing the logical name of the
-          file.</entry>
+          file. </entry>
         </row>
 
         <row>
@@ -158,6 +167,22 @@
         </row>
 
         <row>
+          <entry><emphasis>failIfNoSourceFile</emphasis></entry>
+
+          <entry>Optional. A boolean TRUE or FALSE flag indicating whether a
+          missing file triggers a failure. If omitted, the default is
+          FALSE.</entry>
+        </row>
+
+        <row>
+          <entry><emphasis>expireDays</emphasis></entry>
+
+          <entry>Optional. A integer value indicating the number of days
+          before automatically removing the file. If omitted, the default is
+          -1 (never expires).</entry>
+        </row>
+
+        <row>
           <entry><emphasis>dfuwuid</emphasis></entry>
 
           <entry>The attribute name to recieve the null-terminated string

docs/HPCCClientTools/CT_Mods/CT_Comm_Line_DFU.xml

@@ -418,6 +418,14 @@ replicate=1</programlisting>
                   </row>
 
                   <row>
+                    <entry><emphasis>expireDays</emphasis></entry>
+
+                    <entry>Optional. A integer value indicating the number of
+                    days before automatically removing the file. If omitted,
+                    the default is -1 (never expires).</entry>
+                  </row>
+
+                  <row>
                     <entry><emphasis>format</emphasis></entry>
 
                     <entry>Optional. One of the following values: <emphasis
@@ -803,7 +811,7 @@ dfuplus action=dspray srcname=le::imagedb
           <title>Remove Operations:</title>
 
           <para>The <emphasis role="bold">remove</emphasis> operation deletes
-          a logical file from the system data store, optionally leavingthe
+          a logical file from the system data store, optionally leaving the
           physical files in place.</para>
 
           <para>These <emphasis>options </emphasis>are used by the <emphasis