Kelverion.SqlServer.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!-- Module: Kelverion.SqlServer Version: 2.0.0.0 --> <!--All Commands--> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Delete-SqlRow</command:name> <maml:description> <maml:para>Deletes rows from a database table using custom filter criteria to determine which rows should be deleted.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Delete</command:verb> <command:noun>SqlRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Delete-SqlRow cmdlet deletes rows from an SQL Server database table using custom filter criteria to determine which rows should be deleted.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Delete-SqlRow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table that contains the rows to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to delete. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to connect to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table that contains the rows to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to delete. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to connect to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Indicates the number of rows that were deleted or -1 if the table was truncated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The -Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>ServerName: the name of the SQL Server instance to connect to UseWindowsAuthentication: specifies whether to use windows authentication when connecting to the database. UserName: the name of the user you want to connect as. Password: the password of the user that you are connecting as. ConnectTimeout: The number of seconds to wait to establish a connection with the database</maml:para> </maml:alert> </maml:alertSet> </command:command> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Insert-SqlRow</command:name> <maml:description> <maml:para>Inserts a row into the specified table using the provided values.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Insert</command:verb> <command:noun>SqlRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Insert-SqlRow cmdlet inserts a row into the specified database table using the provided values to initialize the columns in the row.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Insert-SqlRow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the database table to insert into.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the values to assign to the columns in the table. You must provide values for all columns that do not allow NULL values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the table to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the database table to insert into.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the values to assign to the columns in the table. You must provide values for all columns that do not allow NULL values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the table to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The value of the identity column if present, otherwise none.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The -Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>ServerName: the name of the SQL Server instance to connect to UseWindowsAuthentication: specifies whether to use windows authentication when connecting to the database. UserName: the name of the user you want to connect as. Password: the password of the user that you are connecting as. ConnectTimeout: The number of seconds to wait to establish a connection with the database</maml:para> </maml:alert> </maml:alertSet> </command:command> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Invoke-SqlCommand</command:name> <maml:description> <maml:para>Invoke a T-SQL statement in an SQL Server database.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SqlCommand</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-SqlCommand cmdlet invokes a T-SQL command in an SQL Server database.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ExecuteQuery" default="true"> <!--NAME: ExecuteQuery--> <!--TAG: DEFAULT--> <maml:name>Invoke-SqlCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Query"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the T-SQL query to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL query command and return the rows that were selected.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait for the database command to complete before failing with an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the table to select from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ExecuteScaler"> <!--NAME: ExecuteScaler--> <maml:name>Invoke-SqlCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Query"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the T-SQL query to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteScaler</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the first column of the first row in the result set returned by the query (additional columns or rows are ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait for the database command to complete before failing with an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the table to select from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ExecuteNonQuery"> <!--NAME: ExecuteNonQuery--> <maml:name>Invoke-SqlCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Query"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the T-SQL query to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteNonQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the number of rows that were affected</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait for the database command to complete before failing with an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the table to select from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Query"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the T-SQL query to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExecuteQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL query command and return the rows that were selected.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait for the database command to complete before failing with an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the table to select from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExecuteScaler</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the first column of the first row in the result set returned by the query (additional columns or rows are ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExecuteNonQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the number of rows that were affected</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteQuery parameter set, the cmdlet returns a custom object is returned for each row that were retrieved. The properties of the custom object coincide with the columns in the table.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteNonQuery parameter set the cmdlet returns the number of rows that were affected.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteScaler parameter set the cmdlet returns the first column of the first row that was returned by the query (additional columns or rows are ignored).</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The -Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>ServerName: the name of the SQL Server instance to connect to UseWindowsAuthentication: specifies whether to use windows authentication when connecting to the database. UserName: the name of the user you want to connect as. Password: the password of the user that you are connecting as. ConnectTimeout: The number of seconds to wait to establish a connection with the database</maml:para> </maml:alert> </maml:alertSet> </command:command> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Invoke-SqlProcedure</command:name> <maml:description> <maml:para>Invokes the specified stored procedure.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SqlProcedure</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-SqlProcedure cmdlet invokes the specified stored procedure using the provided input parameter values and outputs the results.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ExecuteQuery" default="true"> <!--NAME: ExecuteQuery--> <!--TAG: DEFAULT--> <maml:name>Invoke-SqlProcedure</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcedureName</maml:name> <maml:description> <maml:para>Specifies the name of the stored procedure to invoke.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies values for any input parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should invoke the SQL stored procedure and return the rows that were selected.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the stored procedure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ExecuteScaler"> <!--NAME: ExecuteScaler--> <maml:name>Invoke-SqlProcedure</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcedureName</maml:name> <maml:description> <maml:para>Specifies the name of the stored procedure to invoke.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies values for any input parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteScaler</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should invoke the SQL stored procedure and return the value of the first column in the first row.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the stored procedure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ExecuteNonQuery"> <!--NAME: ExecuteNonQuery--> <maml:name>Invoke-SqlProcedure</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcedureName</maml:name> <maml:description> <maml:para>Specifies the name of the stored procedure to invoke.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies values for any input parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteNonQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should invoke the SQL stored procedure and return a PSObject contain the result of the procedure as well as the values of any output parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the stored procedure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcedureName</maml:name> <maml:description> <maml:para>Specifies the name of the stored procedure to invoke.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies values for any input parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExecuteQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should invoke the SQL stored procedure and return the rows that were selected.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that contains the stored procedure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExecuteScaler</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should invoke the SQL stored procedure and return the value of the first column in the first row.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExecuteNonQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should invoke the SQL stored procedure and return a PSObject contain the result of the procedure as well as the values of any output parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteQuery parameter set, the cmdlet returns a custom object is returned for each row that were retrieved. When using the ExecuteNonQuery parameter set the cmdlet returns a custom object that contains the result of the stored procedure as well as the values of any output parameters.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteScaler parameter set the cmdlet returns the first column of the first row that was returned by the query (additional columns or rows are ignored).</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The -Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>ServerName: the name of the SQL Server instance to connect to UseWindowsAuthentication: specifies whether to use windows authentication when connecting to the database. UserName: the name of the user you want to connect as. Password: the password of the user that you are connecting as. ConnectTimeout: The number of seconds to wait to establish a connection with the database</maml:para> </maml:alert> </maml:alertSet> </command:command> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Select-SqlRow</command:name> <maml:description> <maml:para>Retrives rows from a database table using custom filter criteria to determine which rows to retrieve.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Select</command:verb> <command:noun>SqlRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Select-SqlRow cmdlet selects rows from an SQL Server database table using custom filter criteria to determine which rows to return.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Select-SqlRow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Descending</maml:name> <maml:description> <maml:para>Specifies that the returned rows should be retrieved in descending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to select. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the column that should be used to order the rows.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table from which to select rows from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of rows to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to connect to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Descending</maml:name> <maml:description> <maml:para>Specifies that the returned rows should be retrieved in descending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to select. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the column that should be used to order the rows.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table from which to select rows from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of rows to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to connect to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>A custom object is returned for each row that was retrieved. The properties of the custom object coincide with the columns in the table.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The -Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>ServerName: the name of the SQL Server instance to connect to UseWindowsAuthentication: specifies whether to use windows authentication when connecting to the database. UserName: the name of the user you want to connect as. Password: the password of the user that you are connecting as. ConnectTimeout: The number of seconds to wait to establish a connection with the database</maml:para> </maml:alert> </maml:alertSet> </command:command> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Update-SqlRow</command:name> <maml:description> <maml:para>Updates rows in a database table using custom filter criteria to determine which rows to update.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>SqlRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-SqlRow cmdlet updates rows in an SQL Server database table using values and customer filter criteria.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Update-SqlRow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to update. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table that contains the rows to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the values that will be used to update the rows.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to connect to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to update. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table that contains the rows to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the values that will be used to update the rows.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>The number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the SQL Server database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to connect to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Indicates the number of rows that were updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The -Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>ServerName: the name of the SQL Server instance to connect to UseWindowsAuthentication: specifies whether to use windows authentication when connecting to the database. UserName: the name of the user you want to connect as. Password: the password of the user that you are connecting as. ConnectTimeout: The number of seconds to wait to establish a connection with the database</maml:para> </maml:alert> </maml:alertSet> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> </helpItems> |