lib/net40/CData.WooCommerceCmdlets.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-WooCommerce </command:name> <maml:description> <maml:para>Inserts WooCommerce 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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>Inserts WooCommerce data. The Add-WooCommerce cmdlet allows you to use a syntax similar to SQL INSERT statements to create new WooCommerce records.</maml:para><maml:para>Add-WooCommerce -Connection $connection -Table "Orders" -Columns @("Total") -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-WooCommerce [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-WooCommerce </command:name> <maml:description> <maml:para>Closes a connection to WooCommerce.</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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>Closes a connection to WooCommerce. The Disconnect-WooCommerce cmdlet is used to close a connection that was opened by the Connect-WooCommerce cmdlet.</maml:para><maml:para>Disconnect-WooCommerce -Connection $connection</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-WooCommerce [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-WooCommerce </command:name> <maml:description> <maml:para>Searches and updates WooCommerce 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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>Searches and updates WooCommerce data. The Invoke-WooCommerce 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-WooCommerce -Connection $connection -Query 'SELECT * FROM Orders WHERE ParentId=@ParentId' -Params @{'@ParentId'='3'}</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-WooCommerce -Connection $connection -Query 'EXEC RunSystemStatusTool Id = @Id' -Params @{"clear_transients"}</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-WooCommerce -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-WooCommerce [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-WooCommerce </command:name> <maml:description> <maml:para>Deletes WooCommerce 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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>Deletes WooCommerce data. The Remove-WooCommerce cmdlet allows you to use a syntax similar to SQL DELETE statements to delete WooCommerce data.</maml:para><maml:para>$conn = Connect-WooCommerce -ConsumerKey 'ConsumerKey' -ConsumerSecret 'ConsumerSecret' -Url 'http://localhost/woocommerce/'</maml:para><maml:para>Remove-WooCommerce -Connection $conn -Table "Orders" -Id "6"</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-WooCommerce -Connection $conn -Table "exTablePowershell;" -Where "Id = 6"</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-WooCommerce -Connection $conn -Table Orders -Where "ParentId = '3'" | Remove-WooCommerce</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-WooCommerce [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-WooCommerce </command:name> <maml:description> <maml:para>Opens a new connection to WooCommerce</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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>The Connect-WooCommerce 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-WooCommerce.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>$conn = Connect-WooCommerce</maml:name> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>AuthScheme</maml:name> <maml:description> <maml:para>Whether to use Basic Authentication, the one-legged OAuth 1.0 Authentication or the OAuth 2.0 Authentication when connecting to WooCommerce.</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>CallbackURL</maml:name> <maml:description> <maml:para>The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ConsumerKey</maml:name> <maml:description> <maml:para>The consumer key assigned by WooCommerce when creating the authentication credentials. If this property is set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ConsumerSecret</maml:name> <maml:description> <maml:para>The consumer secret assigned by WooCommerce when creating the authentication credentials. If this and the ConsumerKey properties are set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.</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>InitiateOAuth</maml:name> <maml:description> <maml:para>Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.</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>OAuthAccessToken</maml:name> <maml:description> <maml:para>The access token for connecting using OAuth.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>OAuthClientId</maml:name> <maml:description> <maml:para>The client Id assigned when you register your application with an OAuth authorization server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>OAuthClientSecret</maml:name> <maml:description> <maml:para>The client secret assigned when you register your application with an OAuth authorization server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthExpiresIn</maml:name> <maml:description> <maml:para>The lifetime in seconds of the OAuth AccessToken.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthRefreshToken</maml:name> <maml:description> <maml:para>The OAuth refresh token for the corresponding OAuth access token.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthSettingsLocation</maml:name> <maml:description> <maml:para>The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthTokenTimestamp</maml:name> <maml:description> <maml:para>The Unix epoch timestamp in milliseconds when the current Access Token was created.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthVerifier</maml:name> <maml:description> <maml:para>The verifier code returned from the OAuth authorization URL.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Other</maml:name> <maml:description> <maml:para>These hidden properties are used only in specific use cases.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Pagesize</maml:name> <maml:description> <maml:para>The maximum number of results to return per page from WooCommerce.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyAuthScheme</maml:name> <maml:description> <maml:para>The authentication type to use to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyAutoDetect</maml:name> <maml:description> <maml:para>This indicates whether to use the system proxy settings or not.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyExceptions</maml:name> <maml:description> <maml:para>A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>A password to be used to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>The TCP port the ProxyServer proxy is running on.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>The hostname or IP address of a proxy to route HTTP traffic through.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxySSLType</maml:name> <maml:description> <maml:para>The SSL type to use when connecting to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyUser</maml:name> <maml:description> <maml:para>A user name to be used to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>PseudoColumns</maml:name> <maml:description> <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Readonly</maml:name> <maml:description> <maml:para>You can use this property to enforce read-only access to WooCommerce from the provider.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>RowScanDepth</maml:name> <maml:description> <maml:para>The maximum number of rows to scan to look for the columns available in a table.</maml:para> </maml:description> <command:parameterValue > int </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>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>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="true" pipelineInput="false" position="named"> <maml:name>URL</maml:name> <maml:description> <maml:para>The URL of the WooCommerce instance.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>UserDefinedViews</maml:name> <maml:description> <maml:para>A filepath pointing to the JSON configuration file containing your custom views.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Views</maml:name> <maml:description> <maml:para>Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter > <maml:name>AuthScheme</maml:name> <maml:description> <maml:para>Whether to use Basic Authentication, the one-legged OAuth 1.0 Authentication or the OAuth 2.0 Authentication when connecting to WooCommerce.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>Auto</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>Basic</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>OAuth</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>OAuthOneLegged</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "Auto" </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\\WooCommerce 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>CallbackURL</maml:name> <maml:description> <maml:para>The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.</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>ConsumerKey</maml:name> <maml:description> <maml:para>The consumer key assigned by WooCommerce when creating the authentication credentials. If this property is set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.</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>ConsumerSecret</maml:name> <maml:description> <maml:para>The consumer secret assigned by WooCommerce when creating the authentication credentials. If this and the ConsumerKey properties are set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.</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>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>InitiateOAuth</maml:name> <maml:description> <maml:para>Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OFF</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>GETANDREFRESH</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>REFRESH</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "OFF" </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\\WooCommerce 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>OAuthAccessToken</maml:name> <maml:description> <maml:para>The access token for connecting using OAuth.</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>OAuthClientId</maml:name> <maml:description> <maml:para>The client Id assigned when you register your application with an OAuth authorization 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 required="true"> <maml:name>OAuthClientSecret</maml:name> <maml:description> <maml:para>The client secret assigned when you register your application with an OAuth authorization 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>OAuthExpiresIn</maml:name> <maml:description> <maml:para>The lifetime in seconds of the OAuth AccessToken.</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>OAuthRefreshToken</maml:name> <maml:description> <maml:para>The OAuth refresh token for the corresponding OAuth access token.</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>OAuthSettingsLocation</maml:name> <maml:description> <maml:para>The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.</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\\WooCommerce Data Provider\\OAuthSettings.txt" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthTokenTimestamp</maml:name> <maml:description> <maml:para>The Unix epoch timestamp in milliseconds when the current Access Token was created.</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>OAuthVerifier</maml:name> <maml:description> <maml:para>The verifier code returned from the OAuth authorization URL.</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>Offline</maml:name> <maml:description> <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Other</maml:name> <maml:description> <maml:para>These hidden properties are used only in specific use cases.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Pagesize</maml:name> <maml:description> <maml:para>The maximum number of results to return per page from WooCommerce.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> 100 </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyAuthScheme</maml:name> <maml:description> <maml:para>The authentication type to use to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>BASIC</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>DIGEST</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NONE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NEGOTIATE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NTLM</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PROPRIETARY</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "BASIC" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyAutoDetect</maml:name> <maml:description> <maml:para>This indicates whether to use the system proxy settings or not.</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>ProxyExceptions</maml:name> <maml:description> <maml:para>A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .</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>ProxyPassword</maml:name> <maml:description> <maml:para>A password to be used to authenticate to the ProxyServer proxy.</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>ProxyPort</maml:name> <maml:description> <maml:para>The TCP port the ProxyServer proxy is running on.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> 80 </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>The hostname or IP address of a proxy to route HTTP traffic through.</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>ProxySSLType</maml:name> <maml:description> <maml:para>The SSL type to use when connecting to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>AUTO</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>ALWAYS</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NEVER</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>TUNNEL</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "AUTO" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyUser</maml:name> <maml:description> <maml:para>A user name to be used to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>PseudoColumns</maml:name> <maml:description> <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Readonly</maml:name> <maml:description> <maml:para>You can use this property to enforce read-only access to WooCommerce 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>RowScanDepth</maml:name> <maml:description> <maml:para>The maximum number of rows to scan to look for the columns available in a table.</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>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>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>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 required="true"> <maml:name>URL</maml:name> <maml:description> <maml:para>The URL of the WooCommerce instance.</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>UserDefinedViews</maml:name> <maml:description> <maml:para>A filepath pointing to the JSON configuration file containing your custom views.</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>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.WooCommerceCmdlets.Commands.WooCommercePSConnection</maml:name> <maml:uri /> <maml:description> <maml:para> The WooCommerce connection object. </maml:para> </maml:description> </dev:type> <maml:description> The WooCommerceConnection 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-WooCommerce </command:name> <maml:description> <maml:para>Searches WooCommerce 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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>Searches WooCommerce data. The Select-WooCommerce cmdlet allows you to use a syntax similar to SQL SELECT statements to search WooCommerce data.</maml:para><maml:para>$conn = Connect-WooCommerce -ConsumerKey 'ConsumerKey' -ConsumerSecret 'ConsumerSecret' -Url 'http://localhost/woocommerce/'</maml:para><maml:para>Select-WooCommerce -Connection $conn -Table "Orders" -Columns @("ParentId","Total") -Where "ParentId='3'"</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Select-WooCommerce [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-WooCommerce </command:name> <maml:description> <maml:para>Syncs WooCommerce 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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>Syncs WooCommerce data. The Sync-WooCommerce cmdlet allows you to replicate a data source locally and maintain it with the full caching functionality of the provider.</maml:para><maml:para>$conn = Connect-WooCommerce -ConsumerKey 'ConsumerKey' -ConsumerSecret 'ConsumerSecret' -Url 'http://localhost/woocommerce/'</maml:para><maml:para>Sync-WooCommerce -Connection $conn -Table "Orders"</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Sync-WooCommerce [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-WooCommerce </command:name> <maml:description> <maml:para>Updates WooCommerce 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>WooCommerce</command:noun> <dev:version>23.0</dev:version> </command:details> <maml:description> <maml:para>Updates WooCommerce data. The Update-WooCommerce cmdlet allows you to use a syntax similar to SQL UPDATE statements to update WooCommerce data.</maml:para><maml:para>$conn = Connect-WooCommerce -ConsumerKey 'ConsumerKey' -ConsumerSecret 'ConsumerSecret' -Url 'http://localhost/woocommerce/'</maml:para><maml:para>Update-WooCommerce -Connection $conn -Table "Orders" -Columns @("Total") -Values @("Jon Doe") -Id "6"</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-WooCommerce -Connection $conn -Table "Orders" -Columns @("Total") -Values @("Jon Doe") -Where "Id = '6'"</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-WooCommerce -Connection $conn -Table Orders -Where "ParentId = '3'" | Update-WooCommerce -Columns @("ParentId") -Values @("3 2")</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Update-WooCommerce [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> |