Public/Utils/Invoke-SqlMetaRunner.ps1
|
<#
The MIT License (MIT) Copyright (c) 2015 Objectivity Bespoke Software Specialists Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> function Invoke-SqlMetaRunner { <# .SYNOPSIS A helper for TeamCity MetaRunner that invokes sql. .PARAMETER DatabaseServer Name of database server. .PARAMETER DatabaseName Name of database. .PARAMETER Query SQL query to run. .PARAMETER InputFile Filename containing SQL query to run. .PARAMETER IntegratedSecurity If true, Windows Authentication will be used. SQL Server Authentication otherwise. .PARAMETER Username Username - leave empty for domain agent credentials. .PARAMETER Password Password - leave empty for domain agent credentials. .PARAMETER QueryTimeoutInSeconds Timeout for command execution. .PARAMETER Mode Determines how the sql is run - by sqlcmd.exe or .NET SqlCommand. .EXAMPLE $params = @{ 'DatabaseServer' = '%sqlRun.databaseServer%'; 'DatabaseName' = '%sqlRun.databaseName%'; 'Query' = '%sqlRun.query%'; 'InputFile' = '%sqlRun.file%'; 'IntegratedSecurity' = %sqlRun.integratedSecurity%; 'Username' = '%sqlRun.username%'; 'Password' = '%sqlRun.password%'; 'QueryTimeoutInSeconds' = '%sqlRun.timeout%'; } Invoke-SqlMetaRunner @params #> [CmdletBinding()] [OutputType([string])] param( [Parameter(Mandatory=$true)] [string] $DatabaseServer, [Parameter(Mandatory=$false)] [string] $DatabaseName, [Parameter(Mandatory=$false)] [string] $Query, [Parameter(Mandatory=$false)] [string] $InputFile, [Parameter(Mandatory=$false)] [switch] $IntegratedSecurity, [Parameter(Mandatory=$false)] [string] $Username, [Parameter(Mandatory=$false)] [string] $Password, [Parameter(Mandatory=$false)] [string] $QueryTimeoutInSeconds, [Parameter(Mandatory=$false)] [string] [ValidateSet($null, 'sqlcmd', '.net')] $Mode = '.net' ) $builder = New-Object System.Data.SqlClient.SqlConnectionStringBuilder $builder["Data Source"] = $DatabaseServer if ($DatabaseName) { $builder["Initial Catalog"] = $DatabaseName } $credential = $null if ($IntegratedSecurity) { $builder["Integrated Security"] = $true if ($Username) { $credential = ConvertTo-PSCredential -User $Username -Password $Password } } else { $builder["User ID"] = $Username $builder["Password"] = $Password } $params = @{ 'ConnectionString' = $builder.ConnectionString } if ($credential) { $params['Credential'] = $credential } if ($Query) { $params['Query'] = $query } if ($InputFile) { $params['InputFile'] = $InputFile } if ($QueryTimeoutInSeconds) { $params['QueryTimeoutInSeconds'] = $QueryTimeoutInSeconds } if ($Mode) { $params['Mode'] = $Mode } Invoke-Sql @params } |