SQL Compare是一款比較和同步SQL Server數據庫結構的工具。現有超過150,000的數據庫管理員、開發人員和測試人員在使用它。當測試本地數據庫，暫存或激活遠程服務器的數據庫時，SQL Compare將分配數據庫的過程自動化。

點擊下載SQL Compare試用版

Phil Factor演示了如何使用XML argfiles將參數傳遞給SQL Compare，從而消除了每個目標數據庫所需的許多修改數據庫模式比較和部署過程所涉及的繁瑣腳本。

有很多方法可以使用PowerShell自動執行需要執行SQL Compare的許多常規開發工作。您選擇的方法取決于您的要求。本文旨在指出從命令行界面（CLI）運行XML時，使用XML將詳細指令傳遞給SQL Compare的一些優點。

需要在多臺計算機上安裝SQL比較命令行的自動化程序需要Redgate Deploy或SQL Toolbelt許可證。有關完整的詳細信息，請參閱文檔的“更改分發的命令行”頁面。

將參數傳遞給SQL Compare CLI

SQL Compare CLI允許您從XML參數文件（argfile）或使用項目文件傳遞參數，以及在命令行尾部使用開關的更常用方法。如果您需要大量參數但無法從GUI生成項目文件，則此功能很有用。

使用XML argfile傳遞參數的原因有很多。自動生成項目文件不是一個好主意，而支持XML argfile。這意味著您可以從頭開始為每個任務創建XML argfile，并可以按計劃執行所有任務。您還可以使用SQL Compare有時需要的所有許多細節來執行一般任務，而只需填寫更改的細節，例如服務器，數據庫或憑據，而所有其他選項，開關等保持不變。我在使用Linux或Windows上的SQL Compare命令行比較和部署SQL Server數據庫的文章中給出了所有這些說明。

我們可以總結這些方法的一些優點和缺點。

當重復很多或使用大量命令行選項時，使用XML argfile為命令行界面指定參數特別有用。這是用于SQL比較的簡單XML參數文件（argfile）：

<?xml version="1.0"?>
<commandline>
  <database1>FirstDatabase</database1>
  <server1>SecondHostname</server1>
  <database2>SecondDatabase</database2>
  <server2>SecondHostname</server2>
</commandline>

<?xml version="1.0" encoding="UTF-8"?>
<commandline>
   <sourcecontrol1 />
   <version1>HEAD</version1>
   <server2>TargetDBServer</server2>
   <database2>TargetDB</database2>
   <scriptsfolderxml>MyScriptFolderXml.sfx</scriptsfolderxml>
   <migrationfolderxml>MyMigrationFolderXml.mfx</migrationfolderxml>
   <include>Assembly</include>
   <include>FullTextCatalog</include>
   <include>Function</include>
   <include>Schema</include>
   <include>StoredProcedure</include>
   <include>Table</include>
   <include>View</include>
   <include>identical</include>
   <Synchronize />
</commandline>

sqlcompare /Argfile:MyXMLfilename.xml

指定開關

開關可以以長或短的形式包含在其開關名稱中，作為名稱，其值作為XML值。如果您有多個值（例如在/options開關中允許的值），則可以將它們用逗號分隔：

<options> n，oc，t </ options>

從哈希表中的參數列表創建Argfiles

對我而言，在PowerShell中創建這些XML argfile的最簡單方法是將參數放入哈希表中，并將其傳遞給幫助函數以將其轉換為正確的XML格式。它消除了手工制作XML的許多煩人的錯誤。

<# Unless you like writing XML, the easiest way of creating these files in PowerShell is probably this. We just put our parameters into a hash table and pass it to a function. 
 #>
$MyParameters = @{
    'Database1' = 'Sigrid';
    'Server1' = 'MyFirstServer';
    'Database2' = 'Sigrid'
    'Server2' = 'MySecondServer';
    'userName1' = 'MyUsername1';
    'password1' = 'MyPassword1';
    'userName2' = 'MyUsername2';
    'password2' = 'MyPassword2';
    'report' = "${env:temp}\MyReport.html";
       'force' = $null;
    'reportType' = 'HTML';
    'loglevel' = 'Warning';
    'options' = 'default'
}
# just a helper function to translate the hash table to the XML format expected
# neither of the built-in cmdlets can cut it because they wrap the hash table up
Function SaveHashTableAsSQLCompareXML([hashtable]$TheHashTableParameters,[string]$WhereToStoreIt)
{
    $xmlDoc = [System.Xml.XmlDocument]'<?xml version="1.0"?>';
    $commandline = $xmlDoc.AppendChild($xmlDoc.CreateElement('commandline'));
    $TheHashTableParameters.GetEnumerator() | foreach {
        $Element = $commandline.AppendChild($xmlDoc.CreateElement($_.Name));
        if ($_.Value -ne $null) # if it is a switch with a parameter
        {
            $textNode = $Element.AppendChild($xmlDoc.CreateTextNode($_.Value));
        }
    }
    $xmlDoc.Save("$WhereToStoreIt"); #save it to the user temp area
}
SaveHashTableAsSQLCompareXML $MyParameters "${$env:temp}\Paramfile.xml"
sqlCompare /Argfile:"${env:temp}\Paramfile.xml" >"${env:temp}\summary.txt"
start "${env:temp}\MyReport.html" #display the HTML result report

這是一些用于各種任務的argfile示例。對于未加密的密碼，讀者會有些不解，但稍后再解決。

編寫腳本的新版本

<?xml version="1.0"?>
<commandline> <!-- Script out a new version of the script folder -->
  <database1>Sigrid</database1>
  <server1>MyFirstServer</server1>
  <userName1>MyUsername</userName1>
  <password1>MyP@55w0rd</password1>
  <makescripts>MyPathTo\Tryout</makescripts>
  <force/>
</commandline>

<?xml version="1.0"?>
<commandline> <!-- generate a build script -->
  <database1>Sigrid</database1>
  <server1>MyFirstServer</server1>
  <userName1>MyUsername</userName1>
  <password1>MyP@55w0rd</password1>
   <empty2/> 
  <scriptFile>MyPathTo\MyScriptFile.sql</scriptFile>
  <force/>
</commandline>

<?xml version="1.0"?>
<commandline> <!--report on any differences between two databases -->
  <loglevel>Warning</loglevel>
  <password1>MyP@55w0rd</password1>
  <force />
  <Server2>MyOtherServer</Server2>
  <password2>MyP@55w0rd</password2>
  <userName2>MyUsername</userName2>
  <options>default</options>
  <Server1>MyFirstServer</Server1>
  <reportType>HTML</reportType>
  <userName1>MyUsername</userName1>
  <Database2>Sigrid</Database2>
  <Database1>Sigrid</Database1>
  <report>MyPathTo\MyReport.html</report>
</commandline>

<?xml version="1.0"?>
<commandline> 
<!-- Script out, and report on, the differences between two databases -->
  <loglevel>Warning</loglevel>
  <password1>MyP@55w0rd</password1>
  <force />
  <Server2>MyOtherServer</Server2>
  <password2>MyP@55w0rd</password2>
  <userName2>MyUsername</userName2>
  <options>default</options>
  <Server1>MyFirstServer</Server1>
  <reportType>HTML</reportType>
  <userName1>MyUsername</userName1>
  <database2>Sigrid</database2>
  <database1>Sigrid</database1>
  <exclude>Identical</exclude>  
  <scriptfile>MyPathTo\MyDatabaseBuild.sql</scriptfile>
  <report>MyPathTo\MyReport.html</report>
</commandline>

<?xml version="1.0"?>
<commandline> 
<!-- make a snapshot of a database -->
  <Server1>MyFirstServer</Server1>
  <database1>Sigrid</database1>
  <userName1>MyUsername</userName1>
  <password1>MyP@55w0rd</password1>
  <loglevel>Warning</loglevel>
  <force />
  <makesnapshot>MyPathTo\MyDatabase.snp</makesnapshot>
  <options>default</options>
</commandline>

使用XML argfile執行SQL Compare CLI

<# now we can execute sql Compare CLI with all the argfiles #>
Get-ChildItem -Path "${env:temp}" -Filter '*.xml'| 
   foreach{SQLCompare  "/Argfile:$($_.fullname)"}

動態生成argfile

如果您沒有任何argfiles怎么辦？我們可以即時生成它們！一旦存在argfile，您就可以在每次要重新執行它時使用上面的一個劃線。

<# We just have a list of servers, databases and (in this case userids and passwords) #>
@(
    @{
        'Database' = 'Sigrid'; 'Server' = 'MyOtherServer';
          'userid' = 'MyUsername'; 'password' = 'MyP@55w0rd' },
    @{
        'Database' = 'Abnego'; 'Server' = 'MyOtherServer';
        'userid' = 'MyUsername'; 'password' = 'MyP@55w0rd' },
    @{
        'Database' = 'Antipas'; 'Server' = 'MyOtherServer';
        'userid' = 'MyUsername'; 'password' = 'MyP@55w0rd' },
    @{
        'Database' = 'Archaelus'; 'Server' = 'MyOtherServer';
        'userid' = 'MyUsername'; 'password' = 'MyP@55w0rd' },
    @{ 'Database' = 'Adeliza'; 'Server' = 'MyFirstServer' },
    @{ 'Database' = 'Sigrid'; 'Server' = 'MyFirstServer' }
    
) | foreach{
    "<?xml version=""1.0""?>
<!-- make a snapshot of a database $($_.Database) on $($_.Server) -->
<commandline> 
  <Server1>$($_.Server)</Server1>
  <database1>$($_.Database)</database1>
  $(if ($_userid -ne $null)
        {
            "<userName1>$($_.userid)</userName1>
  <password1>$($_.password)</password1>"
        })
  <loglevel>Warning</loglevel>
  <force />
  <makesnapshot>${env:temp}\$($_.Database)-$($_.Server).snp</makesnapshot>
  <options>default</options>
</commandline>
">"${env:temp}\Snap-$($_.Database)-$($_.Server).xml"
}
<# now we can execute sql Compare CLI with all the argfiles #>
Get-ChildItem -Path "${env:temp}" -Filter 'Snap*.xml' |
foreach{ SQLCompare  "/Argfile:$($_.fullname)" }

密碼存儲問題

如前所述，許多讀者會為將未加密的密碼放入文件中而大驚小怪。這總是一個壞主意。好的，將它們保存在您的用戶區域中，以便獲得NTFS訪問控制所提供的保護措施。但是，密碼也必須加密。

實際上，如果您完全使用SQL Server身份驗證，那么您的SQL Compare項目文件也應存儲在您的用戶區中（在PowerShell中，“ ${env:temp}”是指您用戶區中的臨時目錄）。這是因為，盡管密碼是在項目文件中加密的，但這樣做的方式是，無論Windows / Linux身份如何，任何人都可以使用加密的密碼，并且他們可以粘貼到其項目文件中以使用SQL訪問數據庫。

要存儲憑據，Microsoft建議在PowerShell中使用Import-CliXml和Export-CliXml。該Export-Clixmlcmdlet使用Windows數據保護API加密憑據對象。加密可確保只能通過您的用戶帳戶以及僅在該計算機上解密憑據對象的內容。導出的CLIXML argfile不能在其他計算機上或該計算機上的其他用戶使用。請參閱使用PowerShell在磁盤上安全存儲憑據和使用PowerShell安全密碼：加密憑據。

import-Module sqlserver #import all the libraries for SMO
$SQLserver = 'MyFirstServer'
$SqlUserName = 'MyUsername'
if ($SqlUserName -ne $null)
{
$SqlEncryptedPasswordFile = `
"$env:USERPROFILE\$($SqlUserName)-$($SQLserver).xml"
# test to see if we know about the password in a secure string stored in the user area
    if (Test-Path -path $SqlEncryptedPasswordFile -PathType leaf)
    {
        #has already got this set for this login so fetch it
        $SqlCredentials = Import-CliXml $SqlEncryptedPasswordFile
        
    }
    else #then we have to ask the user for it (once only)
    {
        #hasn't got this set for this login
        $SqlCredentials = get-credential -Credential $SqlUserName
        $SqlCredentials | Export-CliXml -Path $SqlEncryptedPasswordFile
    }
    $ServerConnection = new-object `
        "Microsoft.SqlServer.Management.Common.ServerConnection" `
        ('MyFirstServer', $SqlCredentials.UserName, $SqlCredentials.Password)
}
else
{
    $ServerConnection =
    new-object "Microsoft.SqlServer.Management.Common.ServerConnection" `
    ($csb.server)
}
$s = new-object ("Microsoft.SqlServer.Management.Smo.Server") $ServerConnection
$s.Databases

SQL Compare argfiles的問題在于命令行界面通過CLI直接從磁盤讀取它們，并且我們不允許將敏感信息（例如密碼）作為參數單獨傳遞。這意味著必須在產品中解決在argfile中以純文本格式存儲密碼的問題。

在Argfiles中存儲密碼的解決方案

為了快速解決此問題，并為SQL Compare的現有用戶提供解決方案，我們笨拙地添加了“即時”密碼。

讓我們從那些argfiles重新開始。我們現在不打算在其中輸入密碼。如果他們有用戶名，那么我們需要即時添加適當的密碼，以創建XML argfile的臨時版本，然后將其傳遞給SQL Compare。它可以用于username1or username2，也可以用于password1or password2。

<# We just have a list of servers, databases and (in this case Userids and logins) #>
@(
    @{
        'Database' = 'Sigrid'; 'Server' = 'MyOtherServer'
    },
    @{
        'Database' = 'Abednego'; 'Server' = 'MyOtherServer'
    },
    @{
        'Database' = 'Antipas'; 'Server' = 'MyOtherServer'
    },
    @{
        'Database' = 'Archaelus'; 'Server' = 'MyOtherServer';
        'userid' = 'MyUsername'
    },
    @{
        'Database' = 'Adeliza'; 'Server' = 'MyFirstServer';
        'userid' = 'MyUsername'
    },
    @{
        'Database' = 'Sigrid'; 'Server' = 'MyFirstServer';
        'userid' = 'MyUsername'
    }
    
) | foreach{
    "<?xml version=""1.0""?>
<!-- make a snapshot of a database $($_.Database) on $($_.Server) -->
<commandline> 
  <Server1>$($_.Server)</Server1>
  <database1>$($_.Database)</database1>
  $(if ($_.userid -ne $null)
        {
            "<userName1>$($_.userid)</userName1>
  <password1>$($_.password)</password1>"
        })
  <loglevel>Warning</loglevel>
  <force />
  <makesnapshot>${env:temp}\$($_.Database)-$($_.Server).snp</makesnapshot>
  <options>default</options>
</commandline>
">"${env:temp}\Snap-$($_.Database)-$($_.Server).xml"
}

現在，我們必須創建一個幫助函數來獲取密碼。首次對任何用戶和服務器運行此功能時，都會從您那里獲取密碼，并且您必須輸入該密碼。此后，它將從安全存儲中獲取該密碼。

function SavedPassword ($SqlUserName, $server)
{
    $SqlEncryptedPasswordFile = `
    "$env:USERPROFILE\$($SqlUserName)-$($server).xml"
    # test to see if we know about the password in a secure string stored in the user area
    if (Test-Path -path $SqlEncryptedPasswordFile -PathType leaf)
    {
        #has already got this set for this login so fetch it
        $SqlCredentials = Import-CliXml $SqlEncryptedPasswordFile
        
    }
    else #then we have to ask the user for it (once only)
    {
        #hasn't got this set for this login
        $SqlCredentials = get-credential -Credential $SqlUserName
        $SqlCredentials | Export-CliXml -Path $SqlEncryptedPasswordFile
    }
    $SqlCredentials.GetNetworkCredential().password
}

現在，我們重新營業。可悲的是，它在代碼中有點復雜，但這絲毫不會減慢速度。我們依次提取每個argfile，對其進行對等以查看其是否需要密碼，如果需要，請插入密碼。我們將每個副本復制到一個新的臨時文件，并將其傳遞給SQL Compare。使用它后，我們會立即將其刪除！

Get-ChildItem -Path "${env:temp}" -Filter 'Snap-*.xml' |
foreach{
    $content = [System.IO.File]::ReadAllText($_.fullname);
    $xmlContent = [xml]$content
    write-output "$($xmlContent.'#comment')"
    $server1 = $xmlContent.commandline.server1
    $server2 = $xmlContent.commandline.server2
    $username1 = $xmlContent.commandline.username1
    $username2 = $xmlContent.commandline.username2
    
    if ($username1 -ne $null)
    {
        $xmlContent.commandline.password1 = (SavedPassword  $username1 $server1)
    }
    if ($username2 -ne $null)
    {
        $xmlContent.commandline.password2 = (SavedPassword  $username2 $server2)
    }
    $Tempfile="${env:temp}\Temp_$($_.basename).xml"
    $xmlContent.Save($Tempfile)
    SQLCompare  "/Argfile:$Tempfile" 
    Remove-Item -Path "$Tempfile"
}

結論

我最喜歡使用argfiles將參數傳遞給SQL Compare的地方是，您可以通過將特定任務所需的所有argfile收集到一個目錄中，然后依次將每個argfile傳遞給SQL Compare來完成很多工作。它省去了很多腳本，意味著您可以通過添加，修改或刪除argfiles來修改整個任務。與項目文件不同，這些XML argfile可以通過腳本或在文本編輯器中輕松修改。

如前所述，如果您選擇使用argfiles并使用PowerShell，則需要解決未加密密碼的問題。

相關產品推薦：

SQL Prompt：SQL語法提示工具

SQL Toolbelt：Red Gate產品套包

SQL Monitor：SQL Server監控工具