Data in SQL databases often needs to be synchronized in real time – this can be achieved by checking one database for updates and then applying them to another database. In this case, the process of change detection and synchronization should be run automatically on a schedule and with no need for outside intervention.
How we can achieve this goal
Data Compare is an external tool that allows you to compare data in SQL databases, backups, and script folders. With dbForge Data Compare for SQL Server, you can schedule almost real-time database synchronization.
You can set up the process by following these steps:
- Run Data Compare
- In the New Data Comparison window, choose the source and target databases on the Source and Target tab:
- On the Options tab, set up various comparison settings, if needed.
- On the Mapping tab, select which objects should be compared. Also, you can specify the key columns and the list of columns for comparison, if needed:
- To start the comparison process, click Compare in the bottom right corner.
- When the comparison is done, you can see the results in detail:
- Select all necessary objects by using the corresponding checkboxes and click Save:
The saved project (dcomp) file will contain all objects and options needed for scheduling data synchronization.
- When the project (dcomp) file is saved, click Synchronize which will open the Data Synchronization wizard:
- Choose Execute the script directly against the target database so that the databases can be synchronized after you set up all necessary options:
- Now, click Synchronize in the bottom right corner
- When the synchronization process is over, you can view synchronization results in the bottom pane of the window.
Automating the process
As we have already successfully tested the synchronization process in Data Compare and saved the project (dcomp) file, let’s automate the process with a PowerShell script.
Setting things up
First, we’ll need to create a function that will check if the Outputs folder exists – it will be used to store date-stamped output summaries. We want to make sure that an easy-to-find application log of every synchronization is saved in case we will need to perform troubleshooting in the future:
#checks if the Outputs folder exists. If it doesn’t, the script creates it and returns its full path
function CheckAndCreateFolder($rootFolder, [switch]$Outputs)
{
$location = $rootFolder
#set the location based on the used switch
if($Outputs -eq $true)
{
$location += "\Outputs"
}
#create the folder if it doesn't exist and return its path
if(-not (Test-Path $location))
{ mkdir $location -Force:$true -Confirm:$false | Out-Null }
return $location
}Next, define the root folder and the location for data-stamped output summaries:
#set the root folder
$rootFolder = "D:\DataSync\"
#set the location of output files
$outsLoc = CheckAndCreateFolder $rootFolder -OutputsVariable and switches
In this section, we define the application’s location along with the data stamp variable. Also, we define the variable containing the application’s parameters, such as:
- the path to the saved project (dcomp) file;
- the /sync switch for direct synchronization of the destination database;
- the /rece switch which returns the ‘102 – No differences detected’ message when data sources are equal;
- a date-stamped output summary.
The following script allows us to achieve this:
#define the tool’s location, date stamp variable and the tool’s parameters
$toolLocation = "C:\Program Files\Devart\Compare Bundle for SQL Server Professional\dbForge Data Compare for SQL Server\datacompare.com"
$dateStamp = (Get-Date -Format "Mmddyyyy_HHMMss")
#output log file path
$logPath = "$outsLoc\DataOutput_$dateStamp.txt"
$Params = "/datacompare /compfile:""D:\DataSync\Project\test_DB_1vstest_DB_2.dcomp"" /log:""$logPath"""
$sync = " /sync"Execution
The next part of the PowerShell script will call Data Compare from its location with the parameters we stated in the previous step. Then, the return code variable is defined:
#initiate the comparison of data sources
(Invoke-Expression ("& `"" + $toolLocation +"`" " +$Params))
$returnCode = $LASTEXITCODE
$message = ""The script’s final part serves to create proper responses for the three possible outcomes:
- An error occurred and the output summary will be opened.
- There are differences, e.g. return code 0 – Success
- There are no differences, e.g. return code 100 – No differences detected
if ($returnCode -notin (100, 101))
{ #an error is encountered
$logPath = "$outsLoc\DataOutput_error.txt"
$message >> $logPath
clear-content $logPath
$message = "`r`n $returnCode - An error is encountered"
#output file is opened when an error is encountered
Invoke-Item "$logPath"
}
else{
if ($returnCode -eq 101)
{
clear-content $logPath
(Invoke-Expression ("& `"" + $toolLocation +"`" " +$Params+$sync))
$returnCode = $LASTEXITCODE
#schema changes are detected
}
if($returnCode -eq 0)
{
$message = "`r`n $returnCode - Schema changes were successfully synchronized"
}
else
{
#there are no schema changes
if($returnCode -eq 100)
{
$message = "`r`n $returnCode - There are no schema changes. Job aborted"
}
}
}
$message >> $logPathNow that the job has been automated, it can be scheduled in in any way you prefer – for example, with the help of Windows Scheduler.
Reviewing results
Once everything is up and running, an output summary can be reviewed anytime. In this example, the location of output files is defined by the $outsLoc variable, so the output files will be saved to $rootFolder\$outsLoc – in this particular example, DataSync\Outputs:
If an error occurs when the script is being executed, an error message will be displayed to provide more information about the potential cause of this error. Additionally, a DataOutput_error.txt file with details of the error will be created.
Here’s the script in its entirety:
#checks if the Outputs folder exists. If it doesn’t, the script creates it and returns its full path
function CheckAndCreateFolder($rootFolder, [switch]$Outputs)
{
$location = $rootFolder
#set the location based on the used switch
if($Outputs -eq $true)
{
$location += "\Outputs"
}
#create the folder if it doesn't exist and return its path
if(-not (Test-Path $location))
{ mkdir $location -Force:$true -Confirm:$false | Out-Null }
return $location
}
#set the root folder
$rootFolder = "D:\DataSync\"
#set the location of output files
$outsLoc = CheckAndCreateFolder $rootFolder -Outputs
#define the tool’s location, date stamp variable and the tool’s parameters
$toolLocation = "C:\Program Files\Devart\Compare Bundle for SQL Server Professional\dbForge Data Compare for SQL Server\datacompare.com"
$dateStamp = (Get-Date -Format "Mmddyyyy_HHMMss")
#output log file path
$logPath = "$outsLoc\DataOutput_$dateStamp.txt"
$Params = "/datacompare /compfile:""D:\DataSync\Project\Database1vsDatabase2.dcomp"" /log:""$logPath"""
$sync = " /sync"
#initiate the comparison of data sources
(Invoke-Expression ("& `"" + $toolLocation +"`" " +$Params))
$returnCode = $LASTEXITCODE
$message = ""
if ($returnCode -notin (100, 101))
{ #an error is encountered
$logPath = "$outsLoc\DataOutput_error.txt"
$message >> $logPath
clear-content $logPath
$message = "`r`n $returnCode - An error is encountered"
#output file is opened when an error is encountered
Invoke-Item "$logPath"
}
else{
if ($returnCode -eq 101)
{
clear-content $logPath
(Invoke-Expression ("& `"" + $toolLocation +"`" " +$Params+$sync))
$returnCode = $LASTEXITCODE
#schema changes are detected
}
if($returnCode -eq 0)
{
$message = "`r`n $returnCode - Schema changes were successfully synchronized"
}
else
{
#there are no schema changes
if($returnCode -eq 100)
{
$message = "`r`n $returnCode - There are no schema changes. Job aborted"
}
}
}
$message >> $logPathIf any questions or issues arise during the process of setting this up, feel free to contact us anytime.
