DB2Cmdlets

23.0.8839.1

lib/netstandard2.1/CData.DB2Cmdlets.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-DB2
    </command:name>
    <maml:description>
      <maml:para>Inserts DB2 data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Add</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Inserts DB2 data. The Add-DB2 cmdlet allows you to use a syntax similar to SQL INSERT statements to create new DB2 records.</maml:para><maml:para>Add-DB2 -Connection $connection -Table "`"Sample`".`"DB2INST1`".Books" -Columns @("Author") -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-DB2 [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-DB2
    </command:name>
    <maml:description>
      <maml:para>Closes a connection to DB2.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Disconnect</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Closes a connection to DB2. The Disconnect-DB2 cmdlet is used to close a connection that was opened by the Connect-DB2 cmdlet.</maml:para><maml:para>Disconnect-DB2 -Connection $connection</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Disconnect-DB2 [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-DB2
    </command:name>
    <maml:description>
      <maml:para>Searches and updates DB2 data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Invoke</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Searches and updates DB2 data. The Invoke-DB2 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-DB2 -Connection $connection -Query 'SELECT * FROM "Sample"."DB2INST1".Books WHERE Category=@Category' -Params @{'@Category'='US'}</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-DB2 -Connection $connection -Query 'EXEC CleanCar Url = @Url' -Params @{"http://myserver/myfeed/"}</maml:para><maml:para></maml:para><maml:para>To pass multiple</maml:para><maml:para><B></maml:para><maml:para>Params</maml:para><maml:para></B></maml:para><maml:para>parameters, use a semicolon (;) as a delimiter. The code below outlines the structure of an EXEC command with two parameters (</maml:para><maml:para><I></maml:para><maml:para>param1</maml:para><maml:para></I></maml:para><maml:para>and</maml:para><maml:para><I></maml:para><maml:para>param2</maml:para><maml:para></I></maml:para><maml:para>):</maml:para><maml:para></maml:para><maml:para>$query = Invoke-DB2 -Connection $connection -Query 'EXEC MyStoredProc Input1=@param1, Input2=@param2' -Params @{'@param1' = 'value1'; '@param2' = 'value2'}</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Invoke-DB2 [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-DB2
    </command:name>
    <maml:description>
      <maml:para>Deletes DB2 data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Remove</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Deletes DB2 data. The Remove-DB2 cmdlet allows you to use a syntax similar to SQL DELETE statements to delete DB2 data.</maml:para><maml:para>$conn =</maml:para><maml:para>Remove-DB2 -Connection $conn -Table "`"Sample`".`"DB2INST1`".Books" -Id "22"</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-DB2 -Connection $conn -Table "exTablePowershell;" -Where "Id = 22"</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-DB2 -Connection $conn -Table "Sample"."DB2INST1".Books -Where "Category = 'US'" | Remove-DB2</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Remove-DB2 [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-DB2
    </command:name>
    <maml:description>
      <maml:para>Opens a new connection to DB2</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Connect</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>The Connect-DB2 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-DB2.</maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
        <maml:name>$conn = Connect-DB2</maml:name>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>AllowPreparedStatement</maml:name>
          <maml:description>
            <maml:para>Prepare a query statement before its execution.</maml:para>
          </maml:description>
          <command:parameterValue >
            bool
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>AlternateServers</maml:name>
          <maml:description>
            <maml:para>This property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>AuthScheme</maml:name>
          <maml:description>
            <maml:para>The authentication mechanism that the provider will use to authenticate with DB2.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </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>BatchSize</maml:name>
          <maml:description>
            <maml:para>The maximum size of each batch operation to submit.</maml:para>
          </maml:description>
          <command:parameterValue >
            int
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>BrowsableSchemas</maml:name>
          <maml:description>
            <maml:para>This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </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 >
            int
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>CharBitDataAsString</maml:name>
          <maml:description>
            <maml:para>A Boolean value used to indicate whether parameters, result data, and schema information for iDB2CharBitData and iDB2VarCharBitData objects are treated as String values or as Byte array values.</maml:para>
          </maml:description>
          <command:parameterValue >
            SwitchParameter
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>CharBitDataCcsid</maml:name>
          <maml:description>
            <maml:para>An Int32 value used to indicate which CCSID is used to translate iDB2CharBitData and iDB2VarCharBitData types when the CharBitDataAsString property is set to true. This property is ignored when CharBitDataAsString is set to false.</maml:para>
          </maml:description>
          <command:parameterValue >
            int
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="true"
          pipelineInput="false"
          position="named">
          <maml:name>Database</maml:name>
          <maml:description>
            <maml:para>The name of the DB2 database.</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 >
            int
          </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 filepath which designates the name and location of the log file.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>LogModules</maml:name>
          <maml:description>
            <maml:para>Core modules to be 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>MaxLogFileCount</maml:name>
          <maml:description>
            <maml:para>A string specifying the maximum file count of log files.</maml:para>
          </maml:description>
          <command:parameterValue >
            int
          </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).</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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.</maml:para>
          </maml:description>
          <command:parameterValue >
            int
          </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="true"
          pipelineInput="false"
          position="named">
          <maml:name>Password</maml:name>
          <maml:description>
            <maml:para>The user's password.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="true"
          pipelineInput="false"
          position="named">
          <maml:name>Port</maml:name>
          <maml:description>
            <maml:para>The port used to connect to the server hosting the DB2 database.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>QueryPassthrough</maml:name>
          <maml:description>
            <maml:para>This option passes the query to the DB2 server as is.</maml:para>
          </maml:description>
          <command:parameterValue >
            SwitchParameter
          </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 DB2 from the provider.</maml:para>
          </maml:description>
          <command:parameterValue >
            SwitchParameter
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>RTK</maml:name>
          <maml:description>
            <maml:para>The runtime key used for licensing.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>Schema</maml:name>
          <maml:description>
            <maml:para>The schema which will be used by default.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="true"
          pipelineInput="false"
          position="named">
          <maml:name>Server</maml:name>
          <maml:description>
            <maml:para>The name of the DB2 server.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHAuthMode</maml:name>
          <maml:description>
            <maml:para>The authentication method used when establishing an SSH Tunnel to the service.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHClientCert</maml:name>
          <maml:description>
            <maml:para>A certificate to be used for authenticating the SSHUser.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHClientCertPassword</maml:name>
          <maml:description>
            <maml:para>The password of the SSHClientCert key if it has one.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHClientCertSubject</maml:name>
          <maml:description>
            <maml:para>The subject of the SSH client certificate.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHClientCertType</maml:name>
          <maml:description>
            <maml:para>The type of SSHClientCert private key.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHPassword</maml:name>
          <maml:description>
            <maml:para>The SSH password.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHPort</maml:name>
          <maml:description>
            <maml:para>The SSH port.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHServer</maml:name>
          <maml:description>
            <maml:para>The SSH server.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHServerFingerprint</maml:name>
          <maml:description>
            <maml:para>The SSH server fingerprint.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SSHUser</maml:name>
          <maml:description>
            <maml:para>The SSH user.</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>SwitchMode</maml:name>
          <maml:description>
            <maml:para>This property allows you to specify a switching mode to select a server from AlternateServers as the active server.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>SwitchStrategy</maml:name>
          <maml:description>
            <maml:para>This property allows you to specify a switching strategy to select a server from AlternateServers as the active server.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </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 >
            int
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>TruncateString</maml:name>
          <maml:description>
            <maml:para>This property specifies whether to truncate characters when INSERT or UPDATE is executed with a string that exceeds the column size.</maml:para>
          </maml:description>
          <command:parameterValue >
            SwitchParameter
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="true"
          pipelineInput="false"
          position="named">
          <maml:name>User</maml:name>
          <maml:description>
            <maml:para>A database user.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>UseSSH</maml:name>
          <maml:description>
            <maml:para>Whether to tunnel the DB2 connection over SSH. Use SSH.</maml:para>
          </maml:description>
          <command:parameterValue >
            SwitchParameter
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>UseSSL</maml:name>
          <maml:description>
            <maml:para>This field sets whether SSL is enabled.</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>AllowPreparedStatement</maml:name>
      <maml:description>
        <maml:para>Prepare a query statement before its execution.</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>AlternateServers</maml:name>
      <maml:description>
        <maml:para>This property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.</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>AuthScheme</maml:name>
      <maml:description>
        <maml:para>The authentication mechanism that the provider will use to authenticate with DB2.</maml:para>
      </maml:description>
      <command:parameterValue >
        string
      </command:parameterValue>
      <dev:possibleValues>
        <dev:possibleValue>
          <dev:value>USRIDPWD</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>EUSRIDPWD</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>IBMIAMAuth</dev:value>
        </dev:possibleValue>
   
      </dev:possibleValues>
       
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        "USRIDPWD"
      </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>BrowsableSchemas</maml:name>
      <maml:description>
        <maml:para>This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.</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>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\\DB2 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 >
        int
      </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>CharBitDataAsString</maml:name>
      <maml:description>
        <maml:para>A Boolean value used to indicate whether parameters, result data, and schema information for iDB2CharBitData and iDB2VarCharBitData objects are treated as String values or as Byte array values.</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>CharBitDataCcsid</maml:name>
      <maml:description>
        <maml:para>An Int32 value used to indicate which CCSID is used to translate iDB2CharBitData and iDB2VarCharBitData types when the CharBitDataAsString property is set to true. This property is ignored when CharBitDataAsString is set to false.</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 required="true">
      <maml:name>Database</maml:name>
      <maml:description>
        <maml:para>The name of the DB2 database.</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>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 >
        int
      </command:parameterValue>
 
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        0
      </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\\DB2 Data Provider\\Schema"
      </dev:defaultValue>
    </command:parameter>
      <command:parameter >
      <maml:name>Logfile</maml:name>
      <maml:description>
        <maml:para>A filepath which designates the name and location of 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>LogModules</maml:name>
      <maml:description>
        <maml:para>Core modules to be 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>
        ""
      </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.</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>MaxLogFileSize</maml:name>
      <maml:description>
        <maml:para>A string specifying the maximum size in bytes for a log file (for example, 10 MB).</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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.</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>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 required="true">
      <maml:name>Password</maml:name>
      <maml:description>
        <maml:para>The user's password.</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">
      <maml:name>Port</maml:name>
      <maml:description>
        <maml:para>The port used to connect to the server hosting the DB2 database.</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>
        "50000"
      </dev:defaultValue>
    </command:parameter>
      <command:parameter >
      <maml:name>QueryPassthrough</maml:name>
      <maml:description>
        <maml:para>This option passes the query to the DB2 server as is.</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>Readonly</maml:name>
      <maml:description>
        <maml:para>You can use this property to enforce read-only access to DB2 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>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>Schema</maml:name>
      <maml:description>
        <maml:para>The schema which will be used by default.</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>Server</maml:name>
      <maml:description>
        <maml:para>The name of the DB2 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>SSHAuthMode</maml:name>
      <maml:description>
        <maml:para>The authentication method used when establishing an SSH Tunnel to the service.</maml:para>
      </maml:description>
      <command:parameterValue >
        string
      </command:parameterValue>
      <dev:possibleValues>
        <dev:possibleValue>
          <dev:value>None</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>Password</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>Public_Key</dev:value>
        </dev:possibleValue>
   
      </dev:possibleValues>
       
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        "Password"
      </dev:defaultValue>
    </command:parameter>
      <command:parameter >
      <maml:name>SSHClientCert</maml:name>
      <maml:description>
        <maml:para>A certificate to be used for authenticating the SSHUser.</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>SSHClientCertPassword</maml:name>
      <maml:description>
        <maml:para>The password of the SSHClientCert key if it has one.</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>SSHClientCertSubject</maml:name>
      <maml:description>
        <maml:para>The subject of the SSH client certificate.</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>SSHClientCertType</maml:name>
      <maml:description>
        <maml:para>The type of SSHClientCert private key.</maml:para>
      </maml:description>
      <command:parameterValue >
        string
      </command:parameterValue>
      <dev:possibleValues>
        <dev:possibleValue>
          <dev:value>USER</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>MACHINE</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>PFXFILE</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>PFXBLOB</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>JKSFILE</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>JKSBLOB</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>PEMKEY_FILE</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>PEMKEY_BLOB</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>PPKFILE</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>PPKBLOB</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>XMLFILE</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>XMLBLOB</dev:value>
        </dev:possibleValue>
   
      </dev:possibleValues>
       
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        "PEMKEY_FILE"
      </dev:defaultValue>
    </command:parameter>
      <command:parameter >
      <maml:name>SSHPassword</maml:name>
      <maml:description>
        <maml:para>The SSH password.</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>SSHPort</maml:name>
      <maml:description>
        <maml:para>The SSH port.</maml:para>
      </maml:description>
      <command:parameterValue >
        string
      </command:parameterValue>
 
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        "22"
      </dev:defaultValue>
    </command:parameter>
      <command:parameter >
      <maml:name>SSHServer</maml:name>
      <maml:description>
        <maml:para>The SSH 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>SSHServerFingerprint</maml:name>
      <maml:description>
        <maml:para>The SSH server fingerprint.</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>SSHUser</maml:name>
      <maml:description>
        <maml:para>The SSH 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>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>SwitchMode</maml:name>
      <maml:description>
        <maml:para>This property allows you to specify a switching mode to select a server from AlternateServers as the active server.</maml:para>
      </maml:description>
      <command:parameterValue >
        string
      </command:parameterValue>
      <dev:possibleValues>
        <dev:possibleValue>
          <dev:value>None</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>Failover</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>LoadBalance</dev:value>
        </dev:possibleValue>
   
      </dev:possibleValues>
       
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        "Failover"
      </dev:defaultValue>
    </command:parameter>
      <command:parameter >
      <maml:name>SwitchStrategy</maml:name>
      <maml:description>
        <maml:para>This property allows you to specify a switching strategy to select a server from AlternateServers as the active server.</maml:para>
      </maml:description>
      <command:parameterValue >
        string
      </command:parameterValue>
      <dev:possibleValues>
        <dev:possibleValue>
          <dev:value>Sequence</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>Random</dev:value>
        </dev:possibleValue>
        <dev:possibleValue>
          <dev:value>BestResponse</dev:value>
        </dev:possibleValue>
   
      </dev:possibleValues>
       
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        "sequence"
      </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 >
        int
      </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>TruncateString</maml:name>
      <maml:description>
        <maml:para>This property specifies whether to truncate characters when INSERT or UPDATE is executed with a string that exceeds the column size.</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>User</maml:name>
      <maml:description>
        <maml:para>A database user.</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>UseSSH</maml:name>
      <maml:description>
        <maml:para>Whether to tunnel the DB2 connection over SSH. Use SSH.</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>UseSSL</maml:name>
      <maml:description>
        <maml:para>This field sets whether SSL is enabled.</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.DB2Cmdlets.Commands.DB2PSConnection</maml:name>
        <maml:uri />
        <maml:description>
          <maml:para>
            The DB2 connection object.
          </maml:para>
        </maml:description>
      </dev:type>
      <maml:description>
        The DB2Connection 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-DB2
    </command:name>
    <maml:description>
      <maml:para>Searches DB2 data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Select</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Searches DB2 data. The Select-DB2 cmdlet allows you to use a syntax similar to SQL SELECT statements to search DB2 data.</maml:para><maml:para>$conn =</maml:para><maml:para>Select-DB2 -Connection $conn -Table "`"Sample`".`"DB2INST1`".Books" -Columns @("Id","Author") -Where "Category='US'"</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Select-DB2 [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-DB2
    </command:name>
    <maml:description>
      <maml:para>Syncs DB2 data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Sync</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Syncs DB2 data. The Sync-DB2 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 =</maml:para><maml:para>Sync-DB2 -Connection $conn -Table "`"Sample`".`"DB2INST1`".Books"</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Sync-DB2 [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-DB2
    </command:name>
    <maml:description>
      <maml:para>Updates DB2 data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2024 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Update</command:verb>
    <command:noun>DB2</command:noun>
    <dev:version>23.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Updates DB2 data. The Update-DB2 cmdlet allows you to use a syntax similar to SQL UPDATE statements to update DB2 data.</maml:para><maml:para>$conn =</maml:para><maml:para>Update-DB2 -Connection $conn -Table "`"Sample`".`"DB2INST1`".Books" -Columns @("Author") -Values @("Jon Doe") -Id "22"</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-DB2 -Connection $conn -Table "`"Sample`".`"DB2INST1`".Books" -Columns @("Author") -Values @("Jon Doe") -Where "Id = '22'"</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-DB2 -Connection $conn -Table "Sample"."DB2INST1".Books -Where "Category = 'US'" | Update-DB2 -Columns @("Category") -Values @("US 2")</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Update-DB2 [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>