Click here to Skip to main content
Click here to Skip to main content

Run Scripts Add-In for SQL Server 2005 Management Studio

By , 20 Nov 2008
Rate this:
Please Sign up or sign in to vote.

Sample Image - SSMSScriptRunner.jpg

Introduction

The new SQL Server 2005 Management Studio is a great improvement over older SQL Server tools, and even allows one to create a SQL Script project type to organize your SQL scripts with. While this is handy, there is no way to execute all the scripts in your project without opening each one and hitting 'Execute'. I have some projects with quite a lot of scripts, so this can get quite tedious. I decided to write a little add-in for SSMS to do this for me. To write an SSMS add-in is quite easy; just write a console application that accepts string arguments from SSMS and then add it as a external tool on the Tools->External Tools menu.

How the code works

When the console application is invoked, the current project is sent as an argument using the $(ProjectFileName) global variable. The application then makes a backup of the file before opening it. The project file is an XML format file with the extension 'ssmssqlproj'. The application looks for the first Connection object in the file and uses this connection to execute the scripts. It then loops through all the <FileNode> tags to get the SQL scripts included in the project and executes each one. The output is written to the SQL output window using Console.WriteLine().

Installing the add-in

To install the add-in:

  1. Click on the Tools->External Tools menu item
  2. Add a new tool using the Add button
  3. Give it a title such as 'Run Project Scripts'
  4. From the 'Command' edit box, browse to the RunScriptsInProject.exe file and select it
  5. In the 'Arguments' edit box, select $(ProjectFileName)
  6. In the 'Initial Directory' edit box, select $(ProjectDir)
  7. Check the 'Use Output Window' checkbox

Installing

For more information, look at this article where I got most of the idea from. It will also tell you how to add a toolbar button for your external tool.

Conclusion

This is a simple but useful add-in extension for SSMS that might make life a little easier for you. The source code can be modified to create your own add-ins for the IDE to maybe overcome some limitation. Any comments or suggestions are more than welcome.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Michael Erasmus
Web Developer
Netherlands Netherlands
I'm 27 years old and currently I'm working as a full time software developer/consultant in Amersfoort, Netherlands

Comments and Discussions

 
GeneralSelecting a database to run a project PinmemberCeesCap15-Jul-09 1:42 
GeneralNew version PinmemberMichael Erasmus20-Nov-08 22:57 
GeneralTwo small enhancements: Pinmemberandr529-Jul-08 0:08 
GeneralBug fix for case sensitive "GO" and do while check PinmemberMember 430465113-May-08 3:01 
I've fixed two small bugs, one with the case sensitive string search for "GO", and the other for a do while loop that should be a while loop. Also reformatted output slightly to improve readability. I've posted the code for Program.cs below:
 
Thanks for the Addin - will prove very handy.
 
regards
 
Nigel Meakins
//*******************
 

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using System.IO;
using System.Data;
using System.Data.SqlClient;
using System.Xml;
using System.Xml.XPath;
using System.Text.RegularExpressions;
using System.Threading;
 
namespace RunScriptsInProject
{
class Program
{
static void Main(string[] args)
{
 
try
{
//check we have correct argument(s)
if (args.Length != 1)
{
Console.WriteLine("Invalid arguments - No Project selected?");
return;
}
string projectPath = args[0];
if (File.Exists(projectPath) == false)
{
Console.WriteLine("Invalid arguments - file not found : {0}", projectPath);
return;
}
XmlTextReader reader = new XmlTextReader(projectPath);
XmlDocument doc = new XmlDocument();
doc.Load(reader);
reader.Close();
 
XmlNode connNode = doc.SelectSingleNode("//Items/ConnectionNode");
SqlConnection conn = GetConnection(connNode);
int count=0;
DateTime timeStart = DateTime.Now;
string fileName = "";
foreach (XmlNode node in doc.SelectNodes("//Items/FileNode"))
{
try
{
fileName = node.Attributes["Name"].Value;
Console.WriteLine( "===============================================" + "\n" +
"Running File: {0}" + "\n" +
"===============================================", node.Attributes["Name"].Value);
using (StreamReader read = new StreamReader(Directory.GetCurrentDirectory() + "\\"
+ fileName))
{
string fileText = read.ReadToEnd();
conn.Open();
ExecuteTextBatches(fileText,conn);
}
Console.WriteLine( "===============================================" + "\n" +
"Executed file: {0} successfully" + "\n" +
"===============================================" + "\n", fileName);
count++;
}
catch (SqlException ex)
{
Console.WriteLine("Sql Execption Occurred While Executing Script {0} - {1}",fileName, ex.Message);
}
finally
{
conn.Close();
}
}
TimeSpan ts = (DateTime.Now - timeStart);
Console.WriteLine("{0} out of {1} Files executed succesfully in {2} seconds", count,
doc.SelectNodes("//Items/FileNode").Count, ts.Milliseconds / 1000.0);

}
catch (Exception ex)
{
Console.WriteLine(ex.Message + "\n" + ex.Source + "\n" + ex.StackTrace);
}
}
 
private static void ExecuteTextBatches(string fileText, SqlConnection conn)
{
//Break Text into batches with 'GO' in between, execute each batch
SqlCommand comm = conn.CreateCommand();
comm.CommandType = CommandType.Text;
int goPos = fileText.ToUpper().IndexOf("GO");
while (goPos > 0)
{
comm.CommandText = fileText.Substring(0, goPos - 1);
Console.WriteLine(comm.CommandText);
comm.ExecuteNonQuery();
fileText = fileText.Replace(fileText.Substring(0, goPos + 2),"");
goPos = fileText.ToUpper().IndexOf("GO");
};
}
 
private static SqlConnection GetConnection(XmlNode connNode)
{
SqlConnection conn= null;
if (connNode != null)
{
SqlConnectionStringBuilder consb = new SqlConnectionStringBuilder();
consb.DataSource = connNode.SelectSingleNode("Server").InnerText;
consb.IntegratedSecurity = connNode.SelectSingleNode("Authentication").InnerText == "Windows Authentication" ? true : false;
if (!consb.IntegratedSecurity)
{
consb.UserID = connNode.SelectSingleNode("UserName").InnerText;
}
consb.InitialCatalog = connNode.SelectSingleNode("InitialDB").InnerText;
Console.WriteLine("Using Sql Connection {0}", consb.ConnectionString);
conn = new SqlConnection(consb.ConnectionString);
}
else
{
Console.WriteLine("No Connection found in project. Please add a connection first.");
}
return conn;
}
}
}
Generalerror with Add-In - No connectiound found... Pinmemberka375130-Oct-07 9:11 
AnswerRe: error with Add-In - No connectiound found... PinmemberMichael Erasmus27-Nov-07 6:24 
GeneralRe: error with Add-In - No connectiound found... PinmemberWil Hutton23-May-08 6:40 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web03 | 2.8.140421.2 | Last Updated 21 Nov 2008
Article Copyright 2006 by Michael Erasmus
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid