From 87288a5a1f5536329be58c2acf91bb271bf339e0 Mon Sep 17 00:00:00 2001 From: Max Ieremenko Date: Thu, 1 Nov 2018 23:46:04 +0100 Subject: [PATCH] update readme --- README.md | 25 +++++++++++++++++++++--- Sources/SqlDatabase.PowerShell/README.md | 20 +++++++++++++++++-- 2 files changed, 40 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1189a2d5..1d1fdb21 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,17 @@ Command line and PowerShell tool for SQL Server to execute scripts and database Microsoft [.NET Framework 4.5.2](https://www.microsoft.com/en-us/download/details.aspx?id=42642) or higher. -#### PowerShell cmdlets -See [details](https://github.com/max-ieremenko/SqlDatabase/tree/master/Sources/SqlDatabase.PowerShell/README.md). +#### PowerShell +```bash +Install-Package SqlDatabase +``` +to integrate cmdlets into visual studio package manager console. + +or +```bash +PS> Import-Module .\SqlDatabase.PowerShell.dll -DisableNameChecking +``` +see [details](https://github.com/max-ieremenko/SqlDatabase/tree/master/Sources/SqlDatabase.PowerShell/README.md). #### CLI ```bash @@ -17,6 +26,11 @@ $ SqlDatabase.exe create -from=Examples\CreateDatabaseFolder -varVariable1=value1 -varVariable2=value2 + +PS> Create-SqlDatabase + -database "Data Source=MyServer;Initial Catalog=MyDatabase;Integrated Security=True" + -from Examples\CreateDatabaseFolder + -var Variable1=value1,Variable2=value2 ``` create new database *MyDatabase* on Sql Server *MyServer* based on scripts from [Examples\CreateDatabaseFolder](https://github.com/max-ieremenko/SqlDatabase/tree/master/Examples/CreateDatabaseFolder) with "Variable1=value1" and "Variable2=value2" @@ -27,6 +41,11 @@ $ SqlDatabase.exe upgrade -from=Examples\MigrationStepsFolder -varVariable1=value1 -varVariable2=value2 + +PS> Update-SqlDatabase + -database "Data Source=MyServer;Initial Catalog=MyDatabase;Integrated Security=True" + -from Examples\MigrationStepsFolder + -var Variable1=value1,Variable2=value2 ``` upgrade existing database *MyDatabase* on Sql Server *MyServer* based on scripts from [Examples\MigrationStepsFolder](https://github.com/max-ieremenko/SqlDatabase/tree/master/Examples/MigrationStepsFolder) with "Variable1=value1" and "Variable2=value2" @@ -37,7 +56,7 @@ $ SqlDatabase.exe execute -varVariable1=value1 -varVariable2=value2 -PS> Invoke-SqlDatabase +PS> Execute-SqlDatabase -database "Data Source=server;Initial Catalog=database;Integrated Security=True" -from c:\Scripts\script.sql -var Variable1=value1,Variable2=value2 diff --git a/Sources/SqlDatabase.PowerShell/README.md b/Sources/SqlDatabase.PowerShell/README.md index fe9bf122..b588b349 100644 --- a/Sources/SqlDatabase.PowerShell/README.md +++ b/Sources/SqlDatabase.PowerShell/README.md @@ -1,12 +1,28 @@ ## Installation ```bash -$ Import-Module .\SqlDatabase.PowerShell.dll -DisableNameChecking +PS> Import-Module .\SqlDatabase.PowerShell.dll -DisableNameChecking +``` + +## Create database +```bash +PS> Create-SqlDatabase + -database "Data Source=MyServer;Initial Catalog=MyDatabase;Integrated Security=True" + -from Examples\CreateDatabaseFolder + -var Variable1=value1,Variable2=value2 +``` + +## Upgrade database +```bash +PS> Update-SqlDatabase + -database "Data Source=MyServer;Initial Catalog=MyDatabase;Integrated Security=True" + -from Examples\MigrationStepsFolder + -var Variable1=value1,Variable2=value2 ``` ## Execute script ```bash -PS> Invoke-SqlDatabase +PS> Execute-SqlDatabase -database "Data Source=server;Initial Catalog=database;Integrated Security=True" -from c:\Scripts\script.sql -var Variable1=value1,Variable2=value2