functions/invoke-d365dbsyncpartial.ps1
|
<# .SYNOPSIS Invoke the synchronization process used in Visual Studio .DESCRIPTION Uses the sync.exe (engine) to synchronize the database for the environment .PARAMETER SyncMode The sync mode the sync engine will use Default value is: "PartialList" .PARAMETER SyncList The list of objects that you want to pass on to the database synchronoziation engine .PARAMETER SyncExtensionsList The list of extension objects that you want to pass on to the database synchronoziation engine .PARAMETER LogPath The path where the log file will be saved .PARAMETER Verbosity Parameter used to instruct the level of verbosity the sync engine has to report back Default value is: "Normal" .PARAMETER ModelName Name of the model you want to sync tables and table extensions .PARAMETER BinDirTools Path to where the tools on the machine can be found Default value is normally the AOS Service PackagesLocalDirectory\bin .PARAMETER MetadataDir Path to where the tools on the machine can be found Default value is normally the AOS Service PackagesLocalDirectory .PARAMETER DatabaseServer The name of the database server If on-premises or classic SQL Server, use either short name og Fully Qualified Domain Name (FQDN) If Azure use the full address to the database server, e.g. server.database.windows.net .PARAMETER DatabaseName The name of the database .PARAMETER SqlUser The login name for the SQL Server instance .PARAMETER SqlPwd The password for the SQL Server user .PARAMETER ShowOriginalProgress Instruct the cmdlet to show the standard output in the console Default is $false which will silence the standard output .PARAMETER OutputCommandOnly Instruct the cmdlet to only output the command that you would have to execute by hand Will include full path to the executable and the needed parameters based on your selection .EXAMPLE PS C:\> Invoke-D365DBSyncPartial -SyncList "CustCustomerEntity","SalesTable" Will sync the "CustCustomerEntity" and "SalesTable" objects in the database. This will invoke the sync engine and have it work against the database. It will run with the default value "PartialList" as the SyncMode. It will run the sync process against "CustCustomerEntity" and "SalesTable" .EXAMPLE PS C:\> Invoke-D365DBSyncPartial -SyncList "CustCustomerEntity","SalesTable" -Verbose Will sync the "CustCustomerEntity" and "SalesTable" objects in the database. This will invoke the sync engine and have it work against the database. It will run with the default value "PartialList" as the SyncMode. It will run the sync process against "CustCustomerEntity" and "SalesTable" It will output the same level of details that Visual Studio would normally do. .EXAMPLE PS C:\> Invoke-D365DBSyncPartial -ModelName "FleetManagement" Will sync all base and extension elements from the "FleetManagement" model This will invoke the sync engine and have it work against the database. It will run with the default value "PartialList" as the SyncMode. It will run the sync process against all tables, views, data entities, table-extensions, view-extensions and data entities-extensions of provided model .NOTES Tags: Database, Sync, SyncDB, Synchronization, Servicing Author: Mötz Jensen (@Splaxi) Inspired by: https://axdynamx.blogspot.com/2017/10/how-to-synchronize-manually-database.html #> function Invoke-D365DBSyncPartial { [CmdletBinding()] param ( #[ValidateSet('None', 'PartialList','InitialSchema','FullIds','PreTableViewSyncActions','FullTablesAndViews','PostTableViewSyncActions','KPIs','AnalysisEnums','DropTables','FullSecurity','PartialSecurity','CleanSecurity','ADEs','FullAll','Bootstrap','LegacyIds','Diag')] [string] $SyncMode = 'PartialList', [string[]] $SyncList, [string[]] $SyncExtensionsList, [string] $LogPath = "C:\temp\D365FO.Tools\Sync", [ValidateSet('Normal', 'Quiet', 'Minimal', 'Normal', 'Detailed', 'Diagnostic')] [string] $Verbosity = 'Normal', [string] $ModelName, [string] $BinDirTools = $Script:BinDirTools, [string] $MetadataDir = $Script:MetaDataDir, [string] $DatabaseServer = $Script:DatabaseServer, [string] $DatabaseName = $Script:DatabaseName, [string] $SqlUser = $Script:DatabaseUserName, [string] $SqlPwd = $Script:DatabaseUserPassword, [switch] $ShowOriginalProgress, [switch] $OutputCommandOnly ) begin { $assemblies2Process = New-Object -TypeName "System.Collections.ArrayList" $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.AX.Metadata.dll")) $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.AX.Metadata.Core.dll")) $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.AX.Metadata.Storage.dll")) $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.ApplicationPlatform.XppServices.Instrumentation.dll")) $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.AX.Metadata.Management.Delta.dll")) $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.AX.Metadata.Management.Core.dll")) $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.AX.Metadata.Management.Merge.dll")) $null = $assemblies2Process.Add((Join-Path $BinDirTools "Microsoft.Dynamics.AX.Metadata.Management.Diff.dll")) Import-AssemblyFileIntoMemory -Path $($assemblies2Process.ToArray()) } process { Invoke-TimeSignal -Start #! The way the sync engine works is that it uses the connection string for some operations, #! but for FullSync / FullAll it depends on the database details from the same assemblies that #! we rely on. So the testing of how to run this cmdlet is a bit different than others Write-PSFMessage -Level Debug -Message "Testing if run on LocalHostedTier1 and console isn't elevated" if ($Script:EnvironmentType -eq [EnvironmentType]::LocalHostedTier1 -and !$script:IsAdminRuntime) { Write-PSFMessage -Level Host -Message "It seems that you ran this cmdlet <c='em'>non-elevated</c> and on a <c='em'>local VM / local vhd</c>. Being on a local VM / local VHD requires you to run this cmdlet from an elevated console. Please exit the current console and start a new with `"Run As Administrator`"" Stop-PSFFunction -Message "Stopping because of missing parameters" return } elseif (!$script:IsAdminRuntime -and $Script:UserIsAdmin -and $Script:EnvironmentType -ne [EnvironmentType]::LocalHostedTier1) { Write-PSFMessage -Level Host -Message "It seems that you ran this cmdlet <c='em'>non-elevated</c> and as an <c='em'>administrator</c>. You should either logon as a non-admin user account on this machine or run this cmdlet from an elevated console. Please exit the current console and start a new with `"Run As Administrator`" or simply logon as another user" Stop-PSFFunction -Message "Stopping because of missing parameters" return } $executable = Join-Path $BinDirTools "SyncEngine.exe" if (-not (Test-PathExists -Path $executable -Type Leaf)) { return } if (-not (Test-PathExists -Path $MetadataDir -Type Container)) { return } if (-not (Test-PathExists -Path $LogPath -Type Container -Create)) { return } Write-PSFMessage -Level Debug -Message "Testing if the SyncEngine is already running." $syncEngine = Get-Process -Name "SyncEngine" -ErrorAction SilentlyContinue if ($null -ne $syncEngine) { Write-PSFMessage -Level Host -Message "A instance of SyncEngine is <c='em'>already running</c>. Please <c='em'>wait</c> for it to finish or <c='em'>kill it</c>." Stop-PSFFunction -Message "Stopping because SyncEngine.exe already running" return } if ($null -ne $ModelName) { Write-PSFMessage -Level Debug -Message "Collecting $ModelName AOT elements to sync" $baseSyncElements = New-Object -TypeName "System.Collections.ArrayList" $extensionSyncElements = New-Object -TypeName "System.Collections.ArrayList" $extensionToBaseSyncElements = New-Object -TypeName "System.Collections.ArrayList" $diskMetadataProvider = (New-Object Microsoft.Dynamics.AX.Metadata.Storage.MetadataProviderFactory).CreateDiskProvider($Script:PackageDirectory) $baseSyncElements.AddRange($diskMetadataProvider.Tables.ListObjects($ModelName)); $baseSyncElements.AddRange($diskMetadataProvider.Views.ListObjects($ModelName)); $baseSyncElements.AddRange($diskMetadataProvider.DataEntityViews.ListObjects($ModelName)); $extensionSyncElements.AddRange($diskMetadataProvider.TableExtensions.ListObjects($ModelName)); # Some Extension elements have to be 'converted' to their base element that has to be passed to the SyncList of the syncengine # Add these elements to an ArrayList $extensionToBaseSyncElements.AddRange($diskMetadataProvider.ViewExtensions.ListObjects($ModelName)); $extensionToBaseSyncElements.AddRange($diskMetadataProvider.DataEntityViewExtensions.ListObjects($ModelName)); # Loop every extension element, convert it to its base element and add the base element to another list Foreach ($extElement in $extensionToBaseSyncElements) { $null = $baseSyncElements.Add($extElement.Substring(0, $extElement.IndexOf('.'))) } $SyncList += $baseSyncElements.ToArray() $SyncExtensionsList += $extensionSyncElements.ToArray() Write-PSFMessage -Level Debug -Message "Following elements from $ModelName will be synced: $(($baseSyncElements.ToArray() + $extensionSyncElements.ToArray()) -join ",")" } Write-PSFMessage -Level Debug -Message "Build the parameters for the command to execute." $params = @("-syncmode=$($SyncMode.ToLower())", "-synclist=`"$($SyncList -join ",")`"", "-tableextensionlist=`"$($SyncExtensionsList -join ',')`"", "-verbosity=$($Verbosity.ToLower())", "-metadatabinaries=`"$MetadataDir`"", "-connect=`"server=$DatabaseServer;Database=$DatabaseName; User Id=$SqlUser;Password=$SqlPwd;`"" ) Write-PSFMessage -Level Debug -Message "Starting the SyncEngine with the parameters." -Target $param #! We should consider to redirect the standard output & error like this: https://stackoverflow.com/questions/8761888/capturing-standard-out-and-error-with-start-process Invoke-Process -Executable $executable -Params $params -ShowOriginalProgress:$ShowOriginalProgress -OutputCommandOnly:$OutputCommandOnly Invoke-TimeSignal -End } } |