Skip to content

Latest commit

 

History

History
97 lines (64 loc) · 5.71 KB

README.md

File metadata and controls

97 lines (64 loc) · 5.71 KB
Raw

Invoke-SqlExecute

Branch Status
master Build status
dev Build status

Work In Progress - there may well be bugs!

You are strongly advised to test thoroughly within a non-production environment before letting this loose on any production system!

TL;DR - Jump to Invoke-SqlExecute command syntax

Installation

The module is published on the PowerShell Gallery and can be installed by following the instructions there

https://www.powershellgallery.com/packages/Firefly.InvokeSqlExecute

About

A complete replacement for the Invoke-Sqlcmd cmdlet with bugs in the former addressed. The code has no external dependencies and should work with whatever SMO version it finds when running within the PowerShell SQL provider context.

Another big bugbear of mine is the tersity of error messages returned by the standard implementations. SQL server only knows about the currently executing batch and thus the error details will refer to the line number within the batch. If you have a huge SQL file with hundreds or thousands of batches in, it is more useful to know which line within the entire input file is the one with the error. The parser in this implementation tracks the line number of the start of each batch within the input and adds this to the line number reported by SQL server to give you the true location of the erroneous statement as near as possible, and that includes descent into files refrenced with :r - for instance:

SqlException caught!
Client:              APPVYR-WIN
Server:              (local)\SQL2017
Batch:               C:\Users\appveyor\AppData\Local\Temp\1\sql-server-samples\samples\databases\adventure-works\data-warehouse-install-script\instawdbdw.sql, beginning at line 738
Message:             Cannot bulk load because the file "C:\Users\appveyor\AppData\Local\Temp\1\sql-server-samples\samples\databases\adventure-works\data-warehouse-install-script\DimAccount.csv" could not be opened. Operating system error code 5(Access is denied.).
Source:              .Net SqlClient Data Provider
Number:              4861
Class:               16
State:               1
Line (within batch): 12
Line (within file):  749
Error near:
BULK INSERT [dbo].[DimAccount] FROM 'C:\Users\appveyor\AppData\Local\Temp\1\sql-server-samples\samples\databases\adventure-works\data-warehouse-install-script\DimAccount.csv'
WITH (
    CHECK_CONSTRAINTS,
   -- CODEPAGE='ACP',
    DATAFILETYPE = 'widechar',
    FIELDTERMINATOR= '|',
    ROWTERMINATOR = '\n',
    KEEPIDENTITY,
    TABLOCK
);

Enhancements

SQLCMD command support

This implementation also includes support for more non-interactive 'colon commands' than are available in Invoke-sqlcmd such as :CONNECT, :OUT, :!! etc.

Parallel Execution

Using the -Parallel switch, the following scenarios will run simultaneously. If the switch is omitted the scripts will run sequentially in the order they were presented to the command.

  • Run a single script on multiple connections, e.g. deploy database to several servers
  • Run multiple scripts on a single connection
  • Run multiple scripts each with their own connection.

:SETVAR Enhancement

Using the -OverrideScriptVariables switch will prevent any :SETVAR within scripts from resetting the value of a scripting variable set from the command line.

Capture console output with a PowerShell ScriptBlock

Whilst you can use -OutFile or even pipe console output to Tee-Object, using -ConsoleMessageHandler with a PowerShell script block gives you far more control over how you handle the output, as context is provided along with the message text - which node it came from (when -Parallel) and whether it is destined for the output or error stream. Use this mechanism to feed information to custom loggers e.g. build engines, or simply to change the formatting of the message.

Batch Retry

With -RetryCount you can specify a number of times to retry a failed batch. Retrys are possible for timeout or deadlock victim errors.

Be aware that the entire batch is resubmitted if you use this feature.

Supported Environments

CI builds are run against the following SQL server versions. This is not to say that other versions won't work, however they aren't present in the AppVeyor CI system.

  • Microsoft SQL Server 2014 - 12.0.4100.1
  • Microsoft SQL Server 2016 (SP1-CU8) (KB4077064) - 13.0.4474.0
  • Microsoft SQL Server 2017 (RTM) - 14.0.1000.169
  • Microsoft LocalDB 2016 (SP1-CU8) (KB4077064) - 13.0.4474.0

Specific Bugs Addressed

  • Invoke-Sqlcmd and error results
  • Invoke-Sqlcmd runs script twice
  • -IncludeSqlUserErrors switch (I think this is a bug): In the MS implementation, this parameter forces a datareader with no returned rows to iterate all available result sets in the batch. This is the only way an error raised on any statement within the batch other than the first one will raise a SqlException. This parameter is provided for command line compatibility with Invoke-Sqlcmd, but the execution engine behaves as though it is always set.

If you are aware of any other bugs or inconsistencies in Invoke-Sqlcmd where the behaviour does not align with that of SSMS or sqlcmd.exe, please contact me and I will correct it in this implementation or you can fork it and submit a PR.