Big-Data-HPC-Platform/docs/ECLStandardLibraryReference/SLR-Mods/Copy.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<sect1 id="Copy">
  <title>Copy</title>

  <para><emphasis role="bold">STD.File.Copy<indexterm>
      <primary>STD.File.Copy</primary>
    </indexterm><indexterm>
      <primary>File.Copy</primary>
    </indexterm><indexterm>
      <primary>Copy</primary>
    </indexterm>(</emphasis> <emphasis> logicalname,
  destinationGroup</emphasis> <emphasis role="bold">, </emphasis>
  <emphasis>destinationLogicalname, </emphasis> <emphasis role="bold">
  [</emphasis> <emphasis>,scrDali</emphasis> <emphasis role="bold">]
  [</emphasis> <emphasis>,timeout</emphasis> <emphasis role="bold">]
  [</emphasis> <emphasis>,espserverIPport </emphasis> <emphasis
  role="bold">]</emphasis> <emphasis role="bold"> [</emphasis>
  <emphasis>,maxConnections</emphasis> <emphasis role="bold">] [</emphasis>
  <emphasis>,allowoverwrite</emphasis> <emphasis role="bold">]</emphasis>
  <emphasis role="bold"> [</emphasis> <emphasis>,replicate</emphasis>
  <emphasis role="bold">] [</emphasis> <emphasis>,asSuperfile</emphasis>
  <emphasis role="bold">] );</emphasis><emphasis></emphasis></para>

  <para><emphasis>dfuwuid</emphasis> <emphasis role="bold"> :=
  STD.File.fCopy<indexterm>
      <primary>STD.File.fCopy</primary>
    </indexterm><indexterm>
      <primary>File.fCopy</primary>
    </indexterm><indexterm>
      <primary>fCopy</primary>
    </indexterm>(</emphasis> <emphasis> logicalname,
  destinationGroup</emphasis> <emphasis role="bold">,</emphasis> <emphasis
  role="bold"> </emphasis> <emphasis>destinationLogicalname, </emphasis>
  <emphasis role="bold"> [</emphasis> <emphasis>,scrDali</emphasis> <emphasis
  role="bold">] [</emphasis> <emphasis>,timeout</emphasis> <emphasis
  role="bold">] [</emphasis> <emphasis>,espserverIPport </emphasis> <emphasis
  role="bold">]</emphasis> <emphasis role="bold"> [</emphasis>
  <emphasis>,maxConnections</emphasis> <emphasis role="bold">] [</emphasis>
  <emphasis>,allowoverwrite</emphasis> <emphasis role="bold">]</emphasis>
  <emphasis role="bold"> [</emphasis> <emphasis>,replicate</emphasis>
  <emphasis role="bold">] [</emphasis> <emphasis>,asSuperfile</emphasis>
  <emphasis role="bold">] );</emphasis></para>

  <informaltable colsep="0" frame="none" rowsep="0">
    <tgroup cols="2">
      <colspec colwidth="80.50pt" />

      <colspec />

      <tbody>
        <row>
          <entry><emphasis>logicalname</emphasis></entry>

          <entry>A null-terminated string containing the logical name of the
          file.</entry>
        </row>

        <row>
          <entry><emphasis>destinationGroup</emphasis></entry>

          <entry>A null-terminated string containing the destination cluster
          for the file.</entry>
        </row>

        <row>
          <entry><emphasis>destinationLogicalname</emphasis></entry>

          <entry>A null-terminated string containing the new logical name of
          the file.</entry>
        </row>

        <row>
          <entry><emphasis>srcDali</emphasis></entry>

          <entry>Optional. A null-terminated string containing the IP and Port
          of the Dali containing the file to copy. If omitted, the default is
          an intra-Dali copy.</entry>
        </row>

        <row>
          <entry><emphasis>timeout</emphasis></entry>

          <entry>Optional. An integer value indicating the timeout setting. If
          omitted, the default is -1. If set to zero (0), execution control
          returns immediately to the ECL workunit without waiting for the DFU
          workunit to complete.</entry>
        </row>

        <row>
          <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
          program. This is usually the same IP and port as ECL Watch, with
          “/FileSpray” appended. If omitted, the default is the value
          contained in the lib_system.ws_fs_server attribute.</entry>
        </row>

        <row>
          <entry><emphasis>maxConnections</emphasis></entry>

          <entry>Optional. An integer specifying the maximum number of
          connections. If omitted, the default is one (1).</entry>
        </row>

        <row>
          <entry><emphasis>allowoverwrite</emphasis></entry>

          <entry>Optional. A boolean TRUE or FALSE flag indicating whether to
          allow the new file to overwrite an existing file of the same name.
          If omitted, the default is FALSE.</entry>
        </row>

        <row>
          <entry><emphasis>replicate</emphasis></entry>

          <entry>Optional. A boolean TRUE or FALSE flag indicating whether to
          automatically replicate the new file. If omitted, the default is
          FALSE.</entry>
        </row>

        <row>
          <entry><emphasis>asSuperfile</emphasis></entry>

          <entry>Optional. A boolean TRUE or FALSE flag indicating whether to
          treat the file as a superfile. If omitted, the default is FALSE. If
          TRUE and the file to copy is a superfile, then the operation creates
          a superfile on the target, creating subfiles as needed while
          overwriting only those already existing subfiles whose content has
          changed. If FALSE and the file to copy is a superfile, then the
          operation consolidates all the superfile content into a single
          logical file on the target, not a superfile.</entry>
        </row>

        <row>
          <entry><emphasis>dfuwuid</emphasis></entry>

          <entry>The attribute name to recieve the null-terminated string
          containing the DFU workunit ID (DFUWUID) generated for the
          job.</entry>
        </row>

        <row>
          <entry>Return:<emphasis> </emphasis></entry>

          <entry>fCopy returns a null-terminated string containing the DFU
          workunit ID (DFUWUID).</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>The <emphasis role="bold">Copy </emphasis>function takes a logical
  file and copies it to another logical file. This may be done within the same
  cluster, or to another cluster, or to a cluster in a completely separate
  Dali.</para>

  <para>Example:</para>

  <programlisting format="linespecific">STD.File.Copy('OUT::MyFile','400way','OUT::MyNewFile');
</programlisting>
</sect1>