Bladeren bron

Merge pull request #6895 from JamesDeFabia/12924PreloadNotVaildForIndex

HPCC-12924 Docs: Remove references to PRELOAD on INDEX

Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>
Richard Chapman 10 jaren geleden
bovenliggende
commit
1d3df5d9b1

+ 3 - 4
docs/ECLLanguageReference/ECLR_mods/BltInFunc-PRELOAD.xml

@@ -22,7 +22,7 @@
           <row>
             <entry><emphasis>file</emphasis></entry>
 
-            <entry>The name of a DATASET or INDEX definition.</entry>
+            <entry>The name of a DATASET definition.</entry>
           </row>
 
           <row>
@@ -46,13 +46,12 @@
   <para>The <emphasis role="bold">PRELOAD </emphasis>function leaves the
   <emphasis>file </emphasis>in memory after loading (valid only for Data
   Delivery Engine use). This is exactly equivalent to using the PRELOAD option
-  on the DATASET or INDEX definition.</para>
+  on the DATASET definition.</para>
 
   <para>Example:</para>
 
   <programlisting>MyFile := DATASET('MyFile',{STRING20 F1, STRING20 F2},THOR);
   COUNT(PRELOAD(MyFile))</programlisting>
 
-  <para>See Also: <link linkend="DATASET">DATASET</link>, <link
-  linkend="INDEX_record_structure">INDEX</link></para>
+  <para>See Also: <link linkend="DATASET">DATASET</link></para>
 </sect1>

+ 3 - 13
docs/ECLLanguageReference/ECLR_mods/Recrd-Index.xml

@@ -10,9 +10,7 @@
   role="bold">]</emphasis><emphasis> keys, indexfile </emphasis><emphasis
   role="bold">[,SORTED<indexterm>
       <primary>SORTED</primary>
-    </indexterm>] [,PRELOAD<indexterm>
-      <primary>PRELOAD</primary>
-    </indexterm>]</emphasis><emphasis role="bold"> [,OPT<indexterm>
+    </indexterm>] [,OPT<indexterm>
       <primary>OPT</primary>
     </indexterm>] [,COMPRESSED<indexterm>
       <primary>COMPRESSED</primary>
@@ -34,8 +32,8 @@
   <para><emphasis> attr</emphasis><emphasis role="bold"> :=
   INDEX([</emphasis><emphasis> baserecset, </emphasis><emphasis
   role="bold">]</emphasis><emphasis> keys, payload, indexfile
-  </emphasis><emphasis role="bold">[,SORTED] [,PRELOAD][,OPT] [,COMPRESSED(
-  LZW | ROW | FIRST) ] [,DISTRIBUTED] [,FILEPOSITION( [
+  </emphasis><emphasis role="bold">[,SORTED] [,OPT] [,COMPRESSED( LZW | ROW |
+  FIRST) ] [,DISTRIBUTED] [,FILEPOSITION( [
   </emphasis><emphasis>flag</emphasis><emphasis role="bold">] ) ] [,
   MAXLENGTH<indexterm>
       <primary>MAXLENGTH</primary>
@@ -120,14 +118,6 @@
         </row>
 
         <row>
-          <entry><emphasis role="bold">PRELOAD</emphasis></entry>
-
-          <entry>Optional. Specifies that the <emphasis>indexfile</emphasis>
-          is left in memory after loading (valid only for Data Delivery Engine
-          use).</entry>
-        </row>
-
-        <row>
           <entry><emphasis role="bold">OPT</emphasis></entry>
 
           <entry><para>Optional. Specifies that using the index when the