瀏覽代碼

HPCC-21709 STD.File.SprayDelimited docs some parameters incorrectly named

Signed-off-by: Jim DeFabia <jamesdefabia@lexisnexis.com>
Jim DeFabia 6 年之前
父節點
當前提交
8bbdd5a438
共有 2 個文件被更改,包括 19 次插入16 次删除
  1. 16 16
      docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayVariable.xml
  2. 3 0
      ecllibrary/std/File.ecl

+ 16 - 16
docs/EN_US/ECLStandardLibraryReference/SLR-Mods/SprayVariable.xml

@@ -14,23 +14,23 @@
       <primary>SprayDelimited</primary>
     </indexterm>(</emphasis> <emphasis> sourceIP </emphasis> <emphasis
   role="bold">, </emphasis> <emphasis>sourcePath , </emphasis> <emphasis
-  role="bold">[</emphasis> <emphasis> sourceMaxrecordsize </emphasis>
+  role="bold">[</emphasis> <emphasis> sourceMaxRecordSize </emphasis>
   <emphasis role="bold">] </emphasis> <emphasis>, </emphasis> <emphasis
-  role="bold"> [</emphasis> <emphasis> sourceCSVseparate </emphasis> <emphasis
+  role="bold"> [</emphasis> <emphasis> sourceCsvSeparate </emphasis> <emphasis
   role="bold">] </emphasis> <emphasis>, </emphasis> <emphasis
-  role="bold">[</emphasis> <emphasis> sourceCSVterminate </emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis> sourceCsvTerminate </emphasis> <emphasis
   role="bold">] </emphasis> <emphasis>, </emphasis> <emphasis
-  role="bold">[</emphasis> <emphasis> sourceCSVquote </emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis> sourceCsvQuote </emphasis> <emphasis
   role="bold">] </emphasis> <emphasis>, </emphasis> <emphasis role="bold">
   </emphasis> <emphasis>destinationGroup, destinationLogicalName </emphasis>,
   <emphasis role="bold">[</emphasis> <emphasis>timeout</emphasis> <emphasis
   role="bold">]</emphasis> ,<emphasis role="bold"> [</emphasis>
-  <emphasis>espServerIPPort</emphasis> <emphasis role="bold">]</emphasis>
+  <emphasis>espServerIpPort</emphasis> <emphasis role="bold">]</emphasis>
   ,<emphasis> </emphasis> <emphasis role="bold">[</emphasis>
   <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 role="bold">] , [</emphasis> <emphasis>compress
   </emphasis><emphasis role="bold">]</emphasis> , <emphasis role="bold">
   [</emphasis> <emphasis> sourceCsvEscape </emphasis> <emphasis
   role="bold">]</emphasis>, <emphasis role="bold"> [</emphasis> <emphasis>
@@ -53,22 +53,22 @@
       <primary>fSprayDelimited</primary>
     </indexterm>(</emphasis> <emphasis> sourceIP </emphasis> <emphasis
   role="bold">, </emphasis> <emphasis>sourcePath , </emphasis> <emphasis
-  role="bold"> [</emphasis> <emphasis> sourceMaxrecordsize </emphasis>
+  role="bold"> [</emphasis> <emphasis> sourceMaxRecordSize </emphasis>
   <emphasis role="bold">] </emphasis> <emphasis>, </emphasis> <emphasis
-  role="bold">[</emphasis> <emphasis> sourceCSVseparate </emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis> sourceCsvSeparate </emphasis> <emphasis
   role="bold">] </emphasis> <emphasis>, </emphasis> <emphasis
-  role="bold">[</emphasis> <emphasis> sourceCSVterminate </emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis> sourceCsvTerminate </emphasis> <emphasis
   role="bold">] </emphasis> <emphasis>, </emphasis> <emphasis role="bold">
-  [</emphasis> <emphasis> sourceCSVquote </emphasis> <emphasis role="bold">]
+  [</emphasis> <emphasis> sourceCsvQuote </emphasis> <emphasis role="bold">]
   </emphasis> <emphasis>, destinationGroup, destinationLogicalName </emphasis>
   <emphasis role="bold">, [</emphasis> <emphasis>timeout</emphasis> <emphasis
-  role="bold">] , [</emphasis> <emphasis>espServerIPPort</emphasis> <emphasis
+  role="bold">] , [</emphasis> <emphasis>espServerIpPort</emphasis> <emphasis
   role="bold">]</emphasis> ,<emphasis> </emphasis> <emphasis
   role="bold">[</emphasis> <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> ,
+  <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
@@ -82,7 +82,7 @@
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
-      <colspec colwidth="80.50pt" />
+      <colspec colwidth="90.50pt" />
 
       <colspec />
 
@@ -102,14 +102,14 @@
         </row>
 
         <row>
-          <entry><emphasis>sourceMaxrecordsize</emphasis></entry>
+          <entry><emphasis>sourceMaxRecordSize</emphasis></entry>
 
           <entry>Optional. An integer containing the maximum size of the
           records in the file. If omitted, the default is 4096.</entry>
         </row>
 
         <row>
-          <entry><emphasis>sourceCSVseparate</emphasis></entry>
+          <entry><emphasis>sourceCsvSeparate</emphasis></entry>
 
           <entry>Optional. A null-terminated string containing the CSV field
           separator. If omitted, the default is '\\,'</entry>
@@ -153,7 +153,7 @@
         </row>
 
         <row>
-          <entry><emphasis>espServerIPPort</emphasis></entry>
+          <entry><emphasis>espServerIpPort</emphasis></entry>
 
           <entry>Optional. A null-terminated string containing the protocol,
           IP, port, and directory, or the DNS equivalent, of the ESP server

+ 3 - 0
ecllibrary/std/File.ecl

@@ -460,6 +460,9 @@ EXPORT SprayVariable(varstring sourceIP, varstring sourcePath, integer4 sourceMa
  * @param recordStructurePresent If TRUE derives the record structure from the header of the file.
  * @param quotedTerminator Can the terminator character be included in a quoted field.  Defaults to TRUE.
  *                      If FALSE it allows quicker partitioning of the file (avoiding a complete file scan).
+ * @param encoding      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.
  * @param expireDays    Number of days to auto-remove file. Default is -1, not expire.
  * @return              The DFU workunit id for the job.
  */