https://github.com/bradymholt/dbup-sqlserver-scripting
SQL Server object definition scripting for DbUp
https://github.com/bradymholt/dbup-sqlserver-scripting
Last synced: 8 days ago
JSON representation
SQL Server object definition scripting for DbUp
- Host: GitHub
- URL: https://github.com/bradymholt/dbup-sqlserver-scripting
- Owner: bradymholt
- License: mit
- Created: 2015-04-12T04:15:28.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-01-24T21:49:05.000Z (over 5 years ago)
- Last Synced: 2025-04-16T03:55:29.780Z (11 days ago)
- Language: C#
- Homepage:
- Size: 2.61 MB
- Stars: 43
- Watchers: 5
- Forks: 23
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DbUp SQL Server Object Scripting
[](https://badge.fury.io/nu/dbup-sqlserver-scripting)
SQL Server object definition scripting for [DbUp](http://dbup.github.io/). This package extends DbUp to provide SQL Server object definition scripting when running migrations from Visual Studio Package Manager Console. When a database object changes during a migration, its latest definition will be saved in the project. This allows you to have all of your database object definitions versioned in your repository and to easily compare the before/after diff of a definition changed by a migration (great for pull request / code reviews!).
## Demo
[](https://www.youtube.com/watch?v=2uMsVl_Zk6Y)
## Install
This package is hosted on [NuGet](https://www.nuget.org/packages/dbup-sqlserver-scripting/).
Install-Package dbup-sqlserver-scripting
## Setup
1. You must use the SqlDatabase upgrade engine in DbUp (i.e. `DeployChanges.To.SqlDatabase(connectionString)`) for definition scripting to work.
2. Rather than calling `.PerformUpgrade` on the UpgradeEngine, you need to instantiate a ScriptingUpgrader object and call `Run` on it instead.
For example:
static int Main(string[] args)
{
var connectionString = "Server=(localdb)\\v11.0;Integrated Security=true;AttachDbFileName=C:\\Users\\johndoe\\DbUpTest.mdf;";
var upgrader =
DeployChanges.To
.SqlDatabase(connectionString)
.WithScriptsEmbeddedInAssembly(Assembly.GetExecutingAssembly())
.LogToConsole()
.Build();
//var result = upgrader.PerformUpgrade(); //Don't do this! Do the following instead.
ScriptingUpgrader upgradeScriptingEngine = new ScriptingUpgrader(connectionString, upgrader);
var result = upgradeScriptingEngine.Run(args);
if (!result.Successful)
{
Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine(result.Error);
Console.ResetColor();
return -1;
}
Console.ForegroundColor = ConsoleColor.Green;
Console.WriteLine("Success!");
Console.ResetColor();
return 0;
}
## Usage
This package depends on [dbup-consolescripts](https://github.com/bradyholt/dbup-consolescripts) to provide Package Manager Console usage.
1. Run `New-Migration` from the Package Manager Console
2. Edit the newly created .sql file in the \Migrations folder.
3. Run `Start-Migrations` to migrate the database. Notice in the output; your changed object definitions have been saved/updated.
By default, the definitions are saved in the \Definitions folder in the root of your project. **The definitions will not be *included* in the Visual Studio Project so to see them from within Visual Studio you will need to use the *Show All Files* (refresh) option in Solution Explorer**.
If the migration issues a CREATE statement and the definition is not already saved, it will be created. If a DROP is being performed, the definition file will be *deleted*. Otherwise, an existing definition file will simply be updated with the latest object definition.
Scripting of definitions will only be performed when running `Start-Migrations` from the Package Manager Console and not when running your DbUp project directly. `Start-Migrations` passes in `--fromconsole` which triggers scripting. This is important because when running your DbUp project during a deployment to another environment (or integrated into Octopus Deploy for instance) you do not want object definition scripting to run but only the migrations.
## Object Types
The following SQL Server object types are currently supported:
* Tables
* View
* Stored Procedures
* User Defined Functions
* Synonyms
* User Defined Types
## Statement Types
The following list shows which statement types are currently supported:
* CREATE
* CREATE OR ALTER
* ALTER
* CREATE
* CREATE IF EXISTS
* Renaming with sp_rename
## Known Issues
- Renaming with sp_rename
- Only the renaming of objects itself (like table, view, procedures, etc.) is supported, but not the renaming of columns, indexes, keys
- When dropping or again renaming an object after it has been renamed with sp_rename, those objects can not be properly scripted
## Script All Definitions
You can run `Start-DatabaseScript` from the Package Manager Console to script all objects in the database. If working with an existing database, it is recommended to run this command initially so that all your definition files are saved.
## Supported SQL Server Editions
All SQL Server editions are supported (including Express / LocalDB) with the exception of SQL Server Compact.