PoshCode Archive  Artifact [98717b2c46]

Artifact 98717b2c46b88994ea00bf0604eed653774c0c505b9971f4f721344bb6a0b77d:

  • File Invoke-ExecuteTSQL.ps1 — part of check-in [b26cab665e] at 2018-06-10 13:30:57 on branch trunk — This function runs a T-SQL Statment and output an object with the T-SQL Print Messages using SMO Events (user: unknown size: 3627)

# encoding: ascii
# api: powershell
# title: 
# description: This function runs a T-SQL Statment and output an object with the T-SQL Print Messages using SMO Events
# version: 0.1
# type: script
# license: CC0
# function: Invoke-ExecuteTSQL
# x-poshcode-id: 3782
# x-archived: 2014-08-18T21:33:06
#
#
#######################
<#
.SYNOPSIS
Execute T-SQL Statments and return messages from SQL Server (print).
.DESCRIPTION
Execute T-SQL Statments and return messages from SQL Server (print).
.INPUTS
None
    You cannot pipe objects to Invoke-ExecuteTSQL 
.OUTPUTS
PSObject :
Boolean Exitcode = $True or $False indicating if the query ran successfully 
String  ErrorMessage = The ErrorMessage if not ran successfully
String  Message = Messages from SQL Server (print)
.EXAMPLE
Invoke-ExecuteTSQL -SQLInstanceName . -DatabaseName YourDB -UserName YourUserName -PassWord YourPassword -Query $Query -verbose
This command runs a T-SQL Query using UserName and Password
.EXAMPLE
Invoke-ExecuteTSQL -SQLInstanceName . -DatabaseName YourDB -Query $Query -verbose
This command runs a T-SQL Query using TrustedConnection
.LINK
Invoke-ExecuteTSQL 
#> 
 
function Invoke-ExecuteTSQL { 

	[cmdletbinding()]

	Param(
		[Parameter(Position=0,Mandatory = $true)]
		[ValidateNotNullorEmpty()]
		[string]$SQLInstanceName,
			
		[Parameter(Position=1,Mandatory = $true)]
		[ValidateNotNullorEmpty()]
		[string]$DatabaseName,
			
		[Parameter(Position=2)]
		[string]$UserName,
			
		[Parameter(Position=3)]
		[string]$PassWord,	
			
		[Parameter(Position=4,Mandatory = $true)]
		[ValidateNotNullorEmpty()]
		[string]$Query	

		)
	function Get-SQLConnectionEvent($EventID) {
	
		write-output (Get-Event -SourceIdentifier $EventID -ErrorAction SilentlyContinue  | 
		Select -ExpandProperty SourceEventArgs | 
		Select -ExpandProperty message) 
		Remove-Event -SourceIdentifier $EventID -ErrorAction SilentlyContinue
	}
	try {
		
		if($Username -and $Password) {
			Write-Verbose "Connecting to SQL Server using trusted connection"
			$SqlConnection.ConnectionString = "Server=$($SQLInstanceName);Database=$($DatabaseName);Integrated Security=True"
		} else {
			Write-Verbose "Connecting to SQL Server using Username and Password"
			$SqlConnection.ConnectionString = "Server=$($SQLInstanceName);Database=$($DatabaseName);UID=$($Username);PWD=$($Password)"
		}

		$SqlConnection = New-Object System.Data.SqlClient.SqlConnection
	 	$SqlConnection.ConnectionString = "Server=localhost;Database=confio;Integrated Security=True"
	 
	 	$eventID = "SQLConnectionEvent$(Get-date -format 'yyyyMMddhhmmss')";
		
		write-verbose "Registering the event $eventID" 
	 	Register-ObjectEvent -inputObject $SqlConnection -eventName InfoMessage -sourceIdentifier $eventID
		
		$SqlCmd = New-Object System.Data.SqlClient.SqlCommand
		$SqlCmd.Connection = $SqlConnection
		$SqlCmd.CommandTimeout = 0
		$SqlCmd.Connection.Open()

		write-verbose "Running the Query" 

		$SqlCmd.CommandText = $Query
		$SqlCmd.ExecuteNonQuery() | Out-Null
		$ExitCode = $true
		$Message = Get-SQLConnectionEvent $eventID
		$ErroMessage = ""
	} catch {
		$ExitCode = $false
		$Message = ""
		$ErroMessage = $_.exception
	}
	Finally {
		if ($SqlCmd.Connection.State -eq [System.Data.ConnectionState]::Open) {
			write-verbose "Closing Connection" 
	            	$SqlCmd.Connection.Close()
			$SqlCmd.Connection.Dispose()
	    }
    }

	Write-Output (New-Object psobject -Property @{	'ExitCode' = $ExitCode
							'Message' = $Message	
  							'ErrorMessage' =$ErroMessage})
}