通过函数抛出位置参数错误调用 sqlcmd

Question

我正在尝试使用函数来运行查询，但它似乎不接受我的服务器实例并给出错误：“Run-SqlCommand：找不到接受参数'mydbservername'的位置参数。”

当我在函数之外执行相同的 invoke-sqlcmd 时，它工作正常。

功能：

    function Run-SqlCommand
{
    [CmdletBinding()]
    Param
    (
        [parameter(Position=0, Mandatory=$True, ParameterSetName="Query")]
        [string]$Query,
        [parameter(Position=1, Mandatory=$True, ParameterSetName="DatabaseServerName")]
        [string]$DatabaseServerName,
        [parameter(Position=2, Mandatory=$True, ParameterSetName="Database")]
        [string]$Database,
        [parameter(Position=3, Mandatory=$True, ParameterSetName="Username")]
        [string]$Username,
        [parameter(Position=4, Mandatory=$True, ParameterSetName="Password")]
        [string]$Password
    )

    try {
        $result = Invoke-SqlCmd -query $Query -serverinstance $DatabaseServerName -Database $Database -Username $Username -Password $Password -ErrorAction Stop
        }
    catch {
        Write-Warning $_.Exception.Message
        }

}

在另一个脚本中，我定义了查询、服务器、数据库和用户/密码，并调用传递这些变量的函数：

$SuperUserQuery =@"
select uid,username,first_name,last_name,ad_username,active
from users
where (superuser = 'Y' AND active = '1')
Order by username Asc
"@

      $DatabaseServerName = "mydbservername"
      $Database = "dbname"
      $Username = "dbuser"
      $Password = "dbpass"


Run-SqlCommand $SuperUserQuery $DatabaseServerName $Database $Username $Password

当我这样做时，我得到了上面提到的错误：

“Run-SqlCommand : 找不到接受参数 'mydbservername' 的位置参数。”

如果我直接在脚本中运行 invoke-sqlcmd，我会尝试调用该函数 - 它工作得很好。

$result = Invoke-SqlCmd -query $SuperUserQuery -serverinstance $DatabaseServerName -Database $Database -Username $Username -Password $Password -ErrorAction Stop

为什么直接调用时它会起作用，而通过我的函数调用时不起作用？

好吧，我真的不明白为什么仍然希望有人帮助我理解....但是我通过更改参数来解决它...

        [parameter(Mandatory=$True)]
        [string]$Query,
        [parameter(Mandatory=$True)]
        [string]$DatabaseServerName,
        [parameter(Mandatory=$True)]
        [string]$Database,
        [parameter(Mandatory=$True)]
        [string]$Username,
        [parameter(Mandatory=$True)]
        [string]$Password

当我改变它时它起作用了。我想也许我不明白“位置”或“参数集名称”。

Answer 1

我认为您正在尝试做的是所谓的Splatting。 通过 splatting，您可以构建易于阅读/维护的代码，尤其是当它涉及需要大量参数的 cmdlet 时。

为此，您创建一个 Hashtable 对象并将您想要用于 Invoke-Sqlcmd cmdlet 的所有参数放入其中，如下所示：

$sqlQuery = @"
SELECT uid,
       username,
       first_name,
       last_name,
       ad_username,
       active
FROM   users
WHERE  ( superuser = 'Y'
         AND active = '1' )
ORDER  BY username ASC 
"@

$sqlParams = @{
    'Query'          = $sqlQuery
    'ServerInstance' = 'mydbservername'
    'Database'       = 'dbname'
    'Username'       = 'dbuser'
    'Password'       = 'dbpass'
    # you can even add common parameters in there like
    'ErrorAction'    = 'Stop'
}

然后你这样使用它：

try {
    $result = Invoke-Sqlcmd @sqlParams
}
catch {
    Write-Warning $_.Exception.Message
}