ExcelCmdlets

19.0.7236.0

CData.ExcelCmdlets.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-Excel

    </command:name>

    <maml:description>

      <maml:para>Inserts Excel 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>Excel</command:noun>

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

  </command:details>

  <maml:description>

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

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Add-Excel [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-Excel

    </command:name>

    <maml:description>

      <maml:para>Closes a connection to Excel.</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>Excel</command:noun>

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

  </command:details>

  <maml:description>

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

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Disconnect-Excel [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-Excel

    </command:name>

    <maml:description>

      <maml:para>Searches and updates Excel 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>Excel</command:noun>

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

  </command:details>

  <maml:description>

    <maml:para>Searches and updates Excel data. The Invoke-Excel 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-Excel -Connection $connection -Query 'SELECT * FROM Sheet WHERE FirstName=@FirstName' -Params @{'@FirstName'='Bob'}</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-Excel -Connection $connection -Query 'EXEC CreateWorksheet sheet = @sheet' -Params @{"MyNewWorksheet"}</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-Excel [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-Excel

    </command:name>

    <maml:description>

      <maml:para>Deletes Excel 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>Excel</command:noun>

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

  </command:details>

  <maml:description>

    <maml:para>Deletes Excel data. The Remove-Excel cmdlet allows you to use a syntax similar to SQL DELETE statements to delete Excel data.</maml:para><maml:para>$conn = Connect-Excel -ExcelFile 'C:\MyExcelWorkbooks\SampleWorkbook.xlsx'</maml:para><maml:para>Remove-Excel -Connection $conn -Table "Sheet" -Id "5"</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-Excel -Connection $conn -Table "exTable;" -Where "RowId = 5"</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-Excel -Connection $conn -Table Sheet -Where "FirstName = 'Bob'" | Remove-Excel</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Remove-Excel [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-Excel

    </command:name>

    <maml:description>

      <maml:para>Opens a new connection to Excel</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>Excel</command:noun>

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

  </command:details>

  <maml:description>

    <maml:para>The Connect-Excel 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-Excel.</maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

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

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>AllowFormula</maml:name>

          <maml:description>

            <maml:para>Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <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>BufferChanges</maml:name>

          <maml:description>

            <maml:para>Indicates whether to hold changes to the data in memory until the connection is closed.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </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>DefineTables</maml:name>

          <maml:description>

            <maml:para>Map Excel ranges to table names.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>EmptyValueMode</maml:name>

          <maml:description>

            <maml:para>Indicates whether to read the empty values as empty or as null.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>ExcelFile</maml:name>

          <maml:description>

            <maml:para>The location of an Excel file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>HasCrossSheetReferences</maml:name>

          <maml:description>

            <maml:para>Indicates how cross sheet references are handled.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Header</maml:name>

          <maml:description>

            <maml:para>Indicates whether the first row should be used as a column header.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>IgnoreCalcError</maml:name>

          <maml:description>

            <maml:para>Indicates whether to ignore errors that occurred during the calculation.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </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>MaxLogFileCount</maml:name>

          <maml:description>

            <maml:para>A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.</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>NullValueMode</maml:name>

          <maml:description>

            <maml:para>Indicates whether to read empty cells as null or as empty.</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>Orientation</maml:name>

          <maml:description>

            <maml:para>Indicates whether the data in Excel is laid out horizontally or vertically.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </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>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 Excel from the provider.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Recalculate</maml:name>

          <maml:description>

            <maml:para>Indicates whether to recalculate all formulas when data is read.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>RowScanDepth</maml:name>

          <maml:description>

            <maml:para>Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ShowEmptyRows</maml:name>

          <maml:description>

            <maml:para>Indicates whether or not the empty rows should be pushed.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </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>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>TypeDetectionScheme</maml:name>

          <maml:description>

            <maml:para>Determines how the provider detects the data types of columns.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </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>AllowFormula</maml:name>

      <maml:description>

        <maml:para>Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.</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>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>BufferChanges</maml:name>

      <maml:description>

        <maml:para>Indicates whether to hold changes to the data in memory until the connection is closed.</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>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\\Excel 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>DefineTables</maml:name>

      <maml:description>

        <maml:para>Map Excel ranges to table names.</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>EmptyValueMode</maml:name>

      <maml:description>

        <maml:para>Indicates whether to read the empty values as empty or as null.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>ReadAsEmpty</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>ReadAsNull</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

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

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "ReadAsEmpty"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true">

      <maml:name>ExcelFile</maml:name>

      <maml:description>

        <maml:para>The location of an Excel file.</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>HasCrossSheetReferences</maml:name>

      <maml:description>

        <maml:para>Indicates how cross sheet references are handled.</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>Header</maml:name>

      <maml:description>

        <maml:para>Indicates whether the first row should be used as a column header.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </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>IgnoreCalcError</maml:name>

      <maml:description>

        <maml:para>Indicates whether to ignore errors that occurred during the calculation.</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>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\\Excel 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>MaxLogFileCount</maml:name>

      <maml:description>

        <maml:para>A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.</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>NullValueMode</maml:name>

      <maml:description>

        <maml:para>Indicates whether to read empty cells as null or as empty.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>ReadAsNull</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>ReadAsEmpty</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

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

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "ReadAsNull"

      </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>Orientation</maml:name>

      <maml:description>

        <maml:para>Indicates whether the data in Excel is laid out horizontally or vertically.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>Horizontal</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>Vertical</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

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

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "Vertical"

      </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>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 Excel 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 >

      <maml:name>Recalculate</maml:name>

      <maml:description>

        <maml:para>Indicates whether to recalculate all formulas when data is read.</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>RowScanDepth</maml:name>

      <maml:description>

        <maml:para>Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

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

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "15"

      </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 >

      <maml:name>ShowEmptyRows</maml:name>

      <maml:description>

        <maml:para>Indicates whether or not the empty rows should be pushed.</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>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>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>TypeDetectionScheme</maml:name>

      <maml:description>

        <maml:para>Determines how the provider detects the data types of columns.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>None</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>RowScan</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>ColumnFormat</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

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

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "ColumnFormat"

      </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.ExcelCmdlets.Commands.ExcelPSConnection</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The Excel connection object.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The ExcelConnection 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-Excel

    </command:name>

    <maml:description>

      <maml:para>Searches Excel 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>Excel</command:noun>

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

  </command:details>

  <maml:description>

    <maml:para>Searches Excel data. The Select-Excel cmdlet allows you to use a syntax similar to SQL SELECT statements to search Excel data.</maml:para><maml:para>$conn = Connect-Excel -ExcelFile 'C:\MyExcelWorkbooks\SampleWorkbook.xlsx'</maml:para><maml:para>Select-Excel -Connection $conn -Table "Sheet" -Columns @("RowId","LastName") -Where "FirstName='Bob'"</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Select-Excel [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-Excel

    </command:name>

    <maml:description>

      <maml:para>Syncs Excel 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>Excel</command:noun>

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

  </command:details>

  <maml:description>

    <maml:para>Syncs Excel data. The Sync-Excel 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-Excel -ExcelFile 'C:\MyExcelWorkbooks\SampleWorkbook.xlsx'</maml:para><maml:para>Sync-Excel -Connection $conn -Table "Sheet"</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Sync-Excel [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-Excel

    </command:name>

    <maml:description>

      <maml:para>Updates Excel 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>Excel</command:noun>

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

  </command:details>

  <maml:description>

    <maml:para>Updates Excel data. The Update-Excel cmdlet allows you to use a syntax similar to SQL UPDATE statements to update Excel data.</maml:para><maml:para>$conn = Connect-Excel -ExcelFile 'C:\MyExcelWorkbooks\SampleWorkbook.xlsx'</maml:para><maml:para>Update-Excel -Connection $conn -Table "Sheet" -Columns @("LastName") -Values @("Smith") -Id "5"</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-Excel -Connection $conn -Table "Sheet" -Columns @("LastName") -Values @("Smith") -Where "RowId = '5'"</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-Excel -Connection $conn -Table Sheet -Where "FirstName = 'Bob'" | Update-Excel -Columns @("FirstName") -Values @("Bob 2")</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Update-Excel [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>