FTPCmdlets

19.0.7156.0

CData.FTPCmdlets.Commands.dll-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns="http://msh" schema="maml">

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Add-FTP

    </command:name>

    <maml:description>

      <maml:para>Inserts FTP data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Add</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Inserts FTP data. The Add-FTP cmdlet allows you to use a syntax similar to SQL INSERT statements to create new FTP records.</maml:para><maml:para>Add-FTP -Connection $connection -Table "Notes" -Columns @("Filename") -Values @("Jon Doe")</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Add-FTP [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>Values</maml:name>

          <maml:description>

            <maml:para>The values that will be used to update the table.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="false"

  position="named" >

      <maml:name>Values</maml:name>

      <maml:description>

        <maml:para>The values that will be used to update the table.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>InsertedRowId</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The unique Id of the inserted row.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The unique Id of the inserted row.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Disconnect-FTP

    </command:name>

    <maml:description>

      <maml:para>Closes a connection to FTP.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Disconnect</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Closes a connection to FTP. The Disconnect-FTP cmdlet is used to close a connection that was opened by the Connect-FTP cmdlet.</maml:para><maml:para>Disconnect-FTP -Connection $connection</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Disconnect-FTP [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Invoke-FTP

    </command:name>

    <maml:description>

      <maml:para>Searches and updates FTP data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Invoke</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Searches and updates FTP data. The Invoke-FTP cmdlet allows you to use SQL statements to execute any SQL statement directly. Below is the syntax for a parameterized query:</maml:para><maml:para>$query = Invoke-FTP -Connection $connection -Query 'SELECT * FROM Notes WHERE FilePath=@FilePath' -Params @{'@FilePath'='/documnets/doc.txt'}</maml:para><maml:para></maml:para><maml:para>This cmdlet is also useful for executing stored procedures. Use the EXEC keyword to call a stored procedure:</maml:para><maml:para></maml:para><maml:para>$query = Invoke-FTP -Connection $connection -Query 'EXEC Download RemoteFile = @RemoteFile' -Params @{"test.txt"}</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-FTP [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Params</maml:name>

          <maml:description>

            <maml:para>The parameters that will be used for the query.</maml:para>

          </maml:description>

          <command:parameterValue >

            Hashtable

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>Query</maml:name>

          <maml:description>

            <maml:para>The SQL query to execute.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Params</maml:name>

      <maml:description>

        <maml:para>The parameters that will be used for the query.</maml:para>

      </maml:description>

      <command:parameterValue  >

        Hashtable

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="false"

  position="named" >

      <maml:name>Query</maml:name>

      <maml:description>

        <maml:para>The SQL query to execute.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

      <command:returnValue>

      <dev:type>

        <maml:name>InsertedRowId</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The unique Id of the inserted row.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The unique Id of the inserted row.

      </maml:description> 

    </command:returnValue>

      <command:returnValue>

      <dev:type>

        <maml:name>QueryResults</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The results of the query.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The results of the query.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Remove-FTP

    </command:name>

    <maml:description>

      <maml:para>Deletes FTP data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Remove</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Deletes FTP data. The Remove-FTP cmdlet allows you to use a syntax similar to SQL DELETE statements to delete FTP data.</maml:para><maml:para>$conn = Connect-FTP -RemoteHost 'MyFTPServer'</maml:para><maml:para>Remove-FTP -Connection $conn -Table "Notes" -Id "1"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key:</maml:para><maml:para></maml:para><maml:para>Remove-FTP -Connection $conn -Table "exTable;" -Where "Id = 1"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-FTP -Connection $conn -Table Notes -Where "FilePath = '/documnets/doc.txt'" | Remove-FTP</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Remove-FTP [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="true"

          position="named">

          <maml:name>Id</maml:name>

          <maml:description>

            <maml:para>The Id of the item on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Where</maml:name>

          <maml:description>

            <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="true"

  position="named" >

      <maml:name>Id</maml:name>

      <maml:description>

        <maml:para>The Id of the item on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Where</maml:name>

      <maml:description>

        <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Connect-FTP

    </command:name>

    <maml:description>

      <maml:para>Opens a new connection to FTP</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Connect</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>The Connect-FTP cmdlet is used to create a persistent connection object to be used with related cmdlets. When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object. To disconnect, call Disconnect-FTP.</maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>$conn = Connect-FTP</maml:name>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>AutoCache</maml:name>

          <maml:description>

            <maml:para>Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheConnection</maml:name>

          <maml:description>

            <maml:para>The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheLocation</maml:name>

          <maml:description>

            <maml:para>Specifies the path to the cache when caching to a file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheMetadata</maml:name>

          <maml:description>

            <maml:para>This property determines whether or not to cache the table metadata to a file store.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheProvider</maml:name>

          <maml:description>

            <maml:para>The name of the provider to be used to cache data.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheTolerance</maml:name>

          <maml:description>

            <maml:para>The tolerance for stale data in the cache specified in seconds when using AutoCache .</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FileRetrievalDepth</maml:name>

          <maml:description>

            <maml:para>Specify the depth level of folders you want to query from the Root table.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallPassword</maml:name>

          <maml:description>

            <maml:para>A password used to authenticate to a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallPort</maml:name>

          <maml:description>

            <maml:para>The TCP port for a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallServer</maml:name>

          <maml:description>

            <maml:para>The name or IP address of a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallType</maml:name>

          <maml:description>

            <maml:para>The protocol used by a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallUser</maml:name>

          <maml:description>

            <maml:para>The user name to use to authenticate with a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Location</maml:name>

          <maml:description>

            <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Logfile</maml:name>

          <maml:description>

            <maml:para>A path to the log file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>MaxLogFileSize</maml:name>

          <maml:description>

            <maml:para>A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>MaxRows</maml:name>

          <maml:description>

            <maml:para>Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Offline</maml:name>

          <maml:description>

            <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Other</maml:name>

          <maml:description>

            <maml:para>These hidden properties are used only in specific use cases.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Passive</maml:name>

          <maml:description>

            <maml:para>Controls whether to direct the server into passive mode. Recommended if behind a firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Password</maml:name>

          <maml:description>

            <maml:para>The password of the user.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>PseudoColumns</maml:name>

          <maml:description>

            <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Readonly</maml:name>

          <maml:description>

            <maml:para>You can use this property to enforce read-only access to FTP from the provider.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>RemoteHost</maml:name>

          <maml:description>

            <maml:para>Set this to the host name or address of the server.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>RemotePath</maml:name>

          <maml:description>

            <maml:para>The current path in the FTP server.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>RemotePort</maml:name>

          <maml:description>

            <maml:para>The port the FTP server is running on.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>SSLMode</maml:name>

          <maml:description>

            <maml:para>The authentication mechanism to be used when connecting to the FTP server.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SSLServerCert</maml:name>

          <maml:description>

            <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SupportEnhancedSQL</maml:name>

          <maml:description>

            <maml:para>This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>TableDepth</maml:name>

          <maml:description>

            <maml:para>The depth level to display subfolders as views.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Tables</maml:name>

          <maml:description>

            <maml:para>This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Timeout</maml:name>

          <maml:description>

            <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>UseMLSD</maml:name>

          <maml:description>

            <maml:para>Uses listings for machine processing. Used only for FTP servers.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>User</maml:name>

          <maml:description>

            <maml:para>The name of a user.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>UseSimpleNames</maml:name>

          <maml:description>

            <maml:para>Boolean determining if simple names should be used for tables and columns.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Verbosity</maml:name>

          <maml:description>

            <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Views</maml:name>

          <maml:description>

            <maml:para>Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter >

      <maml:name>AutoCache</maml:name>

      <maml:description>

        <maml:para>Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>CacheLocation</maml:name>

      <maml:description>

        <maml:para>Specifies the path to the cache when caching to a file.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "%APPDATA%\\CData\\FTP Data Provider"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>CacheMetadata</maml:name>

      <maml:description>

        <maml:para>This property determines whether or not to cache the table metadata to a file store.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>CacheTolerance</maml:name>

      <maml:description>

        <maml:para>The tolerance for stale data in the cache specified in seconds when using AutoCache .</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "600"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FileRetrievalDepth</maml:name>

      <maml:description>

        <maml:para>Specify the depth level of folders you want to query from the Root table.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "5"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallPassword</maml:name>

      <maml:description>

        <maml:para>A password used to authenticate to a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallPort</maml:name>

      <maml:description>

        <maml:para>The TCP port for a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallServer</maml:name>

      <maml:description>

        <maml:para>The name or IP address of a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallType</maml:name>

      <maml:description>

        <maml:para>The protocol used by a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>NONE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>TUNNEL</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>SOCKS4</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>SOCKS5</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "NONE"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallUser</maml:name>

      <maml:description>

        <maml:para>The user name to use to authenticate with a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Location</maml:name>

      <maml:description>

        <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "%APPDATA%\\CData\\FTP Data Provider\\Schema"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Logfile</maml:name>

      <maml:description>

        <maml:para>A path to the log file.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>MaxLogFileSize</maml:name>

      <maml:description>

        <maml:para>A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "100MB"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>MaxRows</maml:name>

      <maml:description>

        <maml:para>Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "-1"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Offline</maml:name>

      <maml:description>

        <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Other</maml:name>

      <maml:description>

        <maml:para>These hidden properties are used only in specific use cases.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Passive</maml:name>

      <maml:description>

        <maml:para>Controls whether to direct the server into passive mode. Recommended if behind a firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        bool

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        true

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Password</maml:name>

      <maml:description>

        <maml:para>The password of the user.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>PseudoColumns</maml:name>

      <maml:description>

        <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Readonly</maml:name>

      <maml:description>

        <maml:para>You can use this property to enforce read-only access to FTP from the provider.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true">

      <maml:name>RemoteHost</maml:name>

      <maml:description>

        <maml:para>Set this to the host name or address of the server.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>RemotePath</maml:name>

      <maml:description>

        <maml:para>The current path in the FTP server.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>RemotePort</maml:name>

      <maml:description>

        <maml:para>The port the FTP server is running on.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>RTK</maml:name>

      <maml:description>

        <maml:para>The runtime key used for licensing.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true">

      <maml:name>SSLMode</maml:name>

      <maml:description>

        <maml:para>The authentication mechanism to be used when connecting to the FTP server.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>AUTOMATIC</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>NONE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>IMPLICIT</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>EXPLICIT</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "AUTOMATIC"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SSLServerCert</maml:name>

      <maml:description>

        <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SupportEnhancedSQL</maml:name>

      <maml:description>

        <maml:para>This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.</maml:para>

      </maml:description>

      <command:parameterValue  >

        bool

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        true

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>TableDepth</maml:name>

      <maml:description>

        <maml:para>The depth level to display subfolders as views.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        1

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Tables</maml:name>

      <maml:description>

        <maml:para>This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Timeout</maml:name>

      <maml:description>

        <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "60"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>UseMLSD</maml:name>

      <maml:description>

        <maml:para>Uses listings for machine processing. Used only for FTP servers.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>User</maml:name>

      <maml:description>

        <maml:para>The name of a user.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>UseSimpleNames</maml:name>

      <maml:description>

        <maml:para>Boolean determining if simple names should be used for tables and columns.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Verbosity</maml:name>

      <maml:description>

        <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "1"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Views</maml:name>

      <maml:description>

        <maml:para>Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

    <command:returnValue>

      <dev:type>

        <maml:name>CData.FTPCmdlets.Commands.FTPPSConnection</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The FTP connection object.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The FTPConnection object may be passed to related cmdlets to use the connection.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Select-FTP

    </command:name>

    <maml:description>

      <maml:para>Searches FTP data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Select</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Searches FTP data. The Select-FTP cmdlet allows you to use a syntax similar to SQL SELECT statements to search FTP data.</maml:para><maml:para>$conn = Connect-FTP -RemoteHost 'MyFTPServer'</maml:para><maml:para>Select-FTP -Connection $conn -Table "Notes" -Columns @("Filesize","Filename") -Where "FilePath='/documnets/doc.txt'"</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Select-FTP [parameters]</maml:name>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns to return.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>GroupBy</maml:name>

          <maml:description>

            <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>OrderBy</maml:name>

          <maml:description>

            <maml:para>The order in which columns will be returned.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Params</maml:name>

          <maml:description>

            <maml:para>The parameters that will be used for the query.</maml:para>

          </maml:description>

          <command:parameterValue >

            Hashtable

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Where</maml:name>

          <maml:description>

            <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns to return.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>GroupBy</maml:name>

      <maml:description>

        <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>OrderBy</maml:name>

      <maml:description>

        <maml:para>The order in which columns will be returned.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Params</maml:name>

      <maml:description>

        <maml:para>The parameters that will be used for the query.</maml:para>

      </maml:description>

      <command:parameterValue  >

        Hashtable

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Where</maml:name>

      <maml:description>

        <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>QueryResults</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The results of the query.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The results of the query.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Sync-FTP

    </command:name>

    <maml:description>

      <maml:para>Syncs FTP data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Sync</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Syncs FTP data. The Sync-FTP cmdlet allows you to replicate a data source locally and maintain it with the full caching functionality of the provider.</maml:para><maml:para>$conn = Connect-FTP -RemoteHost 'MyFTPServer'</maml:para><maml:para>Sync-FTP -Connection $conn -Table "Notes"</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Sync-FTP [parameters]</maml:name>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns to sync.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="true"

          position="named">

          <maml:name>DestinationTable</maml:name>

          <maml:description>

            <maml:para>The table where the data will be placed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Params</maml:name>

          <maml:description>

            <maml:para>The parameters that will be used for the query.</maml:para>

          </maml:description>

          <command:parameterValue >

            Hashtable

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns to sync.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="true"

  position="named" >

      <maml:name>DestinationTable</maml:name>

      <maml:description>

        <maml:para>The table where the data will be placed.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Params</maml:name>

      <maml:description>

        <maml:para>The parameters that will be used for the query.</maml:para>

      </maml:description>

      <command:parameterValue  >

        Hashtable

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Update-FTP

    </command:name>

    <maml:description>

      <maml:para>Updates FTP data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2019 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Update</command:verb>

    <command:noun>FTP</command:noun>

    <dev:version>19.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Updates FTP data. The Update-FTP cmdlet allows you to use a syntax similar to SQL UPDATE statements to update FTP data.</maml:para><maml:para>$conn = Connect-FTP -RemoteHost 'MyFTPServer'</maml:para><maml:para>Update-FTP -Connection $conn -Table "Notes" -Columns @("Filename") -Values @("Jon Doe") -Id "1"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key of the table:</maml:para><maml:para></maml:para><maml:para>Update-FTP -Connection $conn -Table "Notes" -Columns @("Filename") -Values @("Jon Doe") -Where "Id = '1'"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-FTP -Connection $conn -Table Notes -Where "FilePath = '/documnets/doc.txt'" | Update-FTP -Columns @("FilePath") -Values @("/documnets/doc.txt 2")</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Update-FTP [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="true"

          position="named">

          <maml:name>Id</maml:name>

          <maml:description>

            <maml:para>The Id of the item on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>Values</maml:name>

          <maml:description>

            <maml:para>The values that will be used to update the table.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Where</maml:name>

          <maml:description>

            <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="true"

  position="named" >

      <maml:name>Id</maml:name>

      <maml:description>

        <maml:para>The Id of the item on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="false"

  position="named" >

      <maml:name>Values</maml:name>

      <maml:description>

        <maml:para>The values that will be used to update the table.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Where</maml:name>

      <maml:description>

        <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

</helpItems>