Adding SQL parameters to Invoke-DBOQuery

Author: nvarscar

functions/Invoke-DBOQuery.ps1

@@ -74,6 +74,10 @@ function Invoke-DBOQuery {
     .PARAMETER As
         Specifies output type. Valid options for this parameter are 'DataSet', 'DataTable', 'DataRow', 'PSObject', and 'SingleValue'
 
+    .PARAMETER Parameter
+        Uses values in specified hashtable as parameters inside the SQL query.
+        For example, <Invoke-DBOQuery -Query 'SELECT @p1' -Parameter @{ p1 = 1 }> would return "1" on SQL Server.
+
     .PARAMETER Confirm
         Prompts to confirm certain actions
 
@@ -142,7 +146,9 @@ function Invoke-DBOQuery {
         [string]$Type = (Get-DBODefaultSetting -Name rdbms.type -Value),
         [ValidateSet("DataSet", "DataTable", "DataRow", "PSObject", "SingleValue")]
         [string]
-        $As = "DataRow"
+        $As = "DataRow",
+        [Alias('SqlParameters', 'SqlParameter', 'Parameters')]
+        [System.Collections.IDictionary]$Parameter
     )
 
     begin {
@@ -178,7 +184,13 @@ function Invoke-DBOQuery {
         if (-Not $config.Silent) {
             $dbUpConnection.IsScriptOutputLogged = $true
         }
-        $managedConnection = $dbUpConnection.OperationStarting($dbUpLog, $null)
+        try {
+            $managedConnection = $dbUpConnection.OperationStarting($dbUpLog, $null)
+        }
+        catch {
+            Stop-PSFFunction -EnableException $true -Message "Failed to connect to the server" -ErrorRecord $_
+            return
+        }
         if ($Query) {
             $queryText = $Query
         }
@@ -211,12 +223,23 @@ function Invoke-DBOQuery {
                 if ($PSCmdlet.ShouldProcess("Executing query $qCount", $config.SqlInstance)) {
                     foreach ($splitQuery in $dbUpConnection.SplitScriptIntoCommands($queryItem)) {
                         $dt = [System.Data.DataTable]::new()
-                        $rows = $dbUpConnection.ExecuteCommandsWithManagedConnection( [Func[Func[Data.IDbCommand], [pscustomobject]]] {
+                        $rows = $dbUpConnection.ExecuteCommandsWithManagedConnection( [Func[Func[Data.IDbCommand], pscustomobject]] {
                                 Param (
                                     $dbCommandFactory
                                 )
+                                # Compile the parameters as Expression functions
+                                $exp = [System.Linq.Expressions.Expression]
+                                $parameterList = @()
+                                foreach ($key in $Parameter.Keys) {
+                                    $param = $exp::Parameter([string], $key)
+                                    $value = $exp::Constant($Parameter.$key)
+                                    $body = $exp::Convert($value, [System.Object])
+                                    $lambda = $exp::Lambda([Func[string, object]], $body, $param)
+                                    $parameterList += $lambda
+                                }
+                                # Initiating the AdHocSqlRunner
                                 $sqlRunner = [DbUp.Helpers.AdHocSqlRunner]::new($dbCommandFactory, $dbUpSqlParser, $config.Schema)
-                                return $sqlRunner.ExecuteReader($splitQuery)
+                                return $sqlRunner.ExecuteReader($splitQuery, $parameterList)
                             })
                         $rowCount = ($rows | Measure-Object).Count
                         if ($rowCount -gt 0) {

internal/classes/DBOpsLog.class.ps1

@@ -4,7 +4,7 @@ class DBOpsLog : DbUp.Engine.Output.IUpgradeLog {
     hidden [bool]$Silent
     hidden [object]$CallStack
     hidden [DBOpsDeploymentStatus]$Status
-    
+
     #Constructors
     DBOpsLog ([bool]$silent, [string]$outFile, [bool]$append) {
         $this.Init($silent, $outFile, $append)
@@ -27,10 +27,10 @@ class DBOpsLog : DbUp.Engine.Output.IUpgradeLog {
                 $txt | Out-File $this.logToFile -Force
             }
         }
-        $this.CallStack = (Get-PSCallStack)[1]
+        $this.CallStack = (Get-PSCallStack)[0]
     }
-    
-    
+
+
     #Methods
     [void] WriteInformation([string]$format, [object[]]$params) {
         $level = switch ($this.silent) {
@@ -45,7 +45,7 @@ class DBOpsLog : DbUp.Engine.Output.IUpgradeLog {
             Line         = $this.callStack.Position.StartLineNumber
             Level        = $level
             Message      = $format -f $params
-            
+
         }
         Write-PSFMessage @splatParam
         if ($this.logToFile) {
@@ -66,7 +66,7 @@ class DBOpsLog : DbUp.Engine.Output.IUpgradeLog {
             Line         = $this.callStack.Position.StartLineNumber
             Level        = $level
             Message      = $format -f $params
-            
+
         }
         Write-PSFMessage @splatParam
         if ($this.logToFile) {
@@ -87,7 +87,7 @@ class DBOpsLog : DbUp.Engine.Output.IUpgradeLog {
             Line         = $this.callStack.Position.StartLineNumber
             Level        = $level
             Message      = $format -f $params
-            
+
         }
         Write-PSFMessage @splatParam
         if ($this.logToFile) {

tests/Invoke-DBOQuery.Tests.ps1

@@ -104,5 +104,11 @@ Describe "Invoke-DBOQuery tests" -Tag $commandName, IntegrationTests {
             $result.A | Should -Be '1', '3'
             $result.B | Should -Be '2', '4'
         }
+        It "should run the query with custom parameters" {
+            $query = "SELECT @p1 AS A, @p2 AS B"
+            $result = Invoke-DBOQuery -Query $query -SqlInstance $script:mssqlInstance -Credential $script:mssqlCredential -Parameter @{ p1 = '1'; p2 = 'string'}
+            $result.A | Should -Be 1
+            $result.B | Should -Be string
+        }
     }
 }