title | description | ms.date | ms.service | ms.custom | ms.topic | ms.author | ms.reviewer | author |
---|---|---|---|---|---|---|---|---|
Synchronize command (TMSL) | Microsoft Docs |
Learn about properties and usage of the Synchronize command, which synchronizes a tabular database with another existing database. |
04/20/2021 |
analysis-services |
tmsl |
reference |
kfollis |
kfollis |
kfollis |
[!INCLUDEappliesto-sql2016-later]
Synchronizes a tabular database with another existing database.
The properties accepted by the JSON synchronize command are as follows.
{
"synchronize":{
"database":"AdventureWorksDW_Production",
"source":"Provider=MSOLAP.7;Data Source=localhost;Integrated Security=SSPI;Initial Catalog=AdventureWorksDW_Dev",
"synchronizeSecurity":"copyAll",
"applyCompression":true
}
}
The properties accepted by the JSON synchronize command are as follows.
Property | Default | Description |
---|---|---|
database | The name of the database object to be synchronized. | |
source | The connection string to use to connect to the source server. | |
synchronizeSecurity | skipMembership | An enumeration value that specifies how to restore security definitions, including roles and permissions. Valid values includes skipMembership, copyAll, ignoreSecurity. |
applyCompression | True | A Boolean that, when true, indicates that compression will be applied during the synchronization operation; otherwise false. |
Returns an empty result when the command succeeds. Otherwise, an XMLA exception is returned.
This command element is used in a statement of the Execute Method (XMLA) call over an XMLA endpoint, exposed in the following ways:
-
As an XMLA window in SQL Server Management Studio (SSMS)
-
As an input file to the invoke-ascmd PowerShell cmdlet
-
As an input to an SSIS task or SQL Server Agent job
You can generate a ready-made script for this command from SSMS by clicking the Script button on the Synchronize Database dialog box.