通过函数引发位置参数错误调用invoke-sqlcmd

时间:2019-05-05 06:20:36

标签: sql-server function powershell invoke-sqlcmd

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

当我在函数外部执行相同的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

当我更改为该名称时,它起作用了。我想也许我不理解“位置”或“参数集名称”。

1 个答案:

答案 0 :(得分:0)

我认为您要尝试的是所谓的Splatting。 使用splating,您可以构建易于阅读/维护的代码,尤其是在涉及需要大量参数的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
}