diff --git a/Firefly.InvokeSqlExecute.PowerShell/InvokeSqlExecuteCommand.cs b/Firefly.InvokeSqlExecute.PowerShell/InvokeSqlExecuteCommand.cs index 94feaf3..bd62e68 100644 --- a/Firefly.InvokeSqlExecute.PowerShell/InvokeSqlExecuteCommand.cs +++ b/Firefly.InvokeSqlExecute.PowerShell/InvokeSqlExecuteCommand.cs @@ -54,7 +54,13 @@ /// /// /// This is an example of calling Invoke-Sqlcmd to execute a simple query, similar to specifying sqlcmd with the -Q and -S options: - /// Invoke-SqlExecute -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance" + /// PS C:\> Invoke-SqlExecute -Query "SELECT GETDATE() AS TimeOfQuery" -ServerInstance "MyComputer\MyInstance" + /// This is an example of calling Invoke-Sqlcmd to execute a simple query, similar to specifying sqlcmd with the -Q and -S options: + /// + /// + /// This is an example of calling Invoke-Sqlcmd to execute a simple query, using the provider context for the connection: + /// PS SQLSERVER:\SQL\MyComputer\MyInstance> Invoke-SqlExecute -Query "SELECT @@SERVERNAME AS ServerName" + /// This is an example of calling Invoke-Sqlcmd to execute a simple query, using the provider context for the connection: /// /// /// @@ -79,7 +85,7 @@ public InvokeSqlExecuteCommand() /// /// Gets or sets the abort on error. - /// Indicates that this cmdlet stops the SQL Server command and returns an error level to the Windows PowerShell ERRORLEVEL variable if this cmdlet encounters an error. + /// Indicates that this cmdlet stops the SQL Server command and returns an error level to the Windows PowerShell LASTEXITCODE variable if this cmdlet encounters an error. /// /// /// The abort on error. @@ -452,7 +458,7 @@ public InvokeSqlExecuteCommand() /// /// - IDictionary: e.g. a PowerShell hashtable @{ VAR1 = 'Value1'; VAR2 = 'Value 2'} /// - string: e.g. "VAR1=value1;VAR2='Value 2'". Note, does not handle semicolons or equals as part of variable's value -use one of the other types - /// - string[]: e.g. @("VAR1=value1", "VAR2=Value 2") + /// - string array: e.g. @("VAR1=value1", "VAR2=Value 2") /// /// /// The variable. diff --git a/docs/en-US/Invoke-SqlExecute.md b/docs/en-US/Invoke-SqlExecute.md index 02d716a..05210cd 100644 --- a/docs/en-US/Invoke-SqlExecute.md +++ b/docs/en-US/Invoke-SqlExecute.md @@ -58,13 +58,22 @@ Additionally, you can capture this output by providing a script block that will ### EXAMPLE 1 ``` -Invoke-SqlExecute -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance" +PS C:\> Invoke-SqlExecute -Query "SELECT GETDATE() AS TimeOfQuery" -ServerInstance "MyComputer\MyInstance" ``` +This is an example of calling Invoke-Sqlcmd to execute a simple query, similar to specifying sqlcmd with the -Q and -S options: + +### EXAMPLE 2 +``` +PS SQLSERVER:\SQL\MyComputer\MyInstance> Invoke-SqlExecute -Query "SELECT @@SERVERNAME AS ServerName" +``` + +This is an example of calling Invoke-Sqlcmd to execute a simple query, using the provider context for the connection: + ## PARAMETERS ### -AbortOnError -Indicates that this cmdlet stops the SQL Server command and returns an error level to the Windows PowerShell ERRORLEVEL variable if this cmdlet encounters an error. +Indicates that this cmdlet stops the SQL Server command and returns an error level to the Windows PowerShell LASTEXITCODE variable if this cmdlet encounters an error. ```yaml Type: SwitchParameter @@ -524,7 +533,7 @@ Various data types may be used for the type of this input: - IDictionary: e.g. a PowerShell hashtable @{ VAR1 = 'Value1'; VAR2 = 'Value 2'} - string: e.g. "VAR1=value1;VAR2='Value 2'". Note, does not handle semicolons or equals as part of variable's value -use one of the other types -- string\[\]: e.g. @("VAR1=value1", "VAR2=Value 2") +- string array: e.g. @("VAR1=value1", "VAR2=Value 2") ```yaml Type: Object