Configuring comparison & script generation options

Size: px

Start display at page:

Download "Configuring comparison & script generation options"

Rodney Lucas
6 years ago
Views:

Configuring comparison & script generation options The ReadyRoll tool-window provides an effective way to generate new migration scripts within your database project.

1 Configuring comparison & script generation options The ReadyRoll tool-window provides an effective way to generate new migration scripts within your database project. The tool uses the industry-standard Redgate SQL Compare (and Data Compare) engine, and for the most part uses the factory default comparison and script generation options that ship with SQL Compare itself. If fine-grained control is required over the script-generation behavior, then the standard SQL Compare settings can be customized at the project level. Customising database comparison & script generation options In order to set the desired script comparison and generation options, some editing of your database project's.sqlproj file is required. Start by opening your solution in Visual Studio. Right-click the database project in the Solution Explorer and select Unload Project. Then, click Edit project. Choose from one or more of the available database comparison and script generation options. These are listed below along with the default value that ReadyRoll uses: Schema comparison options <PropertyGroup>  <SyncOptionIncludeDependentObjects>False</SyncOptionIncludeDependentObject

2 s>  <SyncOptionIncludeExistenceChecks>False</SyncOptionIncludeExistenceChecks>  <SyncOptionUseDropCreateInsteadOfAlter>False</SyncOptionUseDropCreateInste adofalter>  <SyncOptionDisableDdlTriggers>True</SyncOptionDisableDdlTriggers>  <SyncOptionIgnoreExtendedProperties>False</SyncOptionIgnoreExtendedPropert ies>  <SyncOptionIgnoreCommentsInBodies>False</SyncOptionIgnoreCommentsInBodies>  <SyncOptionIgnoreAnsiOptions>False</SyncOptionIgnoreAnsiOptions>  <SyncOptionIgnoreCollations>True</SyncOptionIgnoreCollations>  <SyncOptionIgnoreColumnsOrder>True</SyncOptionIgnoreColumnsOrder>  <SyncOptionIgnoreSynonymDatabaseAndServerName>True</SyncOptionIgnoreSynony mdatabaseandservername>  <SyncOptionIgnoretSQLt>True</SyncOptionIgnoretSQLt>  <SyncOptionIgnoreDmlTriggers>False</SyncOptionIgnoreDmlTriggers>  <SyncOptionIgnoreInsteadOfTriggers>False</SyncOptionIgnoreInsteadOfTrigger s>  <SyncOptionIgnoreDataspaces>False</SyncOptionIgnoreDataspaces>

3  <SyncOptionIgnoreConstraintNotForReplicationAttribute>True</SyncOptionIgno reconstraintnotforreplicationattribute>  <SyncOptionIgnoreFillFactor>True</SyncOptionIgnoreFillFactor>  <SyncOptionIgnoreIndexLockAttributes>False</SyncOptionIgnoreIndexLockAttri butes>  <SyncOptionIgnoreStatistics>True</SyncOptionIgnoreStatistics>  <SyncOptionIgnoreDataCompression>True</SyncOptionIgnoreDataCompression>  <SyncOptionIgnoreFullTextIndexing>False</SyncOptionIgnoreFullTextIndexing>  <SyncOptionIgnoreReplicationTriggers>True</SyncOptionIgnoreReplicationTrig gers>  <SyncOptionIgnoreIndexes>False</SyncOptionIgnoreIndexes>  <SyncOptionIgnorePermissions>False</SyncOptionIgnorePermissions>  <SyncOptionIgnoreWhiteSpace>True</SyncOptionIgnoreWhiteSpace>  <SyncOptionIgnoreConstraintWithNoCheckAttribute>True</SyncOptionIgnoreCons traintwithnocheckattribute>  <SyncOptionIgnoreIdentitySeedAndIncrement>False</SyncOptionIgnoreIdentityS eedandincrement>  <SyncOptionCaseSensitiveObjectDefinition>False</SyncOptionCaseSensitiveObj ectdefinition>

4  <SyncOptionIgnoreBindings>False</SyncOptionIgnoreBindings>  <SyncOptionIgnoreQueueEventNotifications>False</SyncOptionIgnoreQueueEvent Notifications>  <SyncOptionIgnoreSquareBrackets>False</SyncOptionIgnoreSquareBrackets>  <SyncOptionIgnoreWithElementOrder>True</SyncOptionIgnoreWithElementOrder>  <SyncOptionIgnoreWithEncryption>False</SyncOptionIgnoreWithEncryption>  <SyncOptionIgnoreSchemaObjectAuthorization>False</SyncOptionIgnoreSchemaOb jectauthorization>  <SyncOptionIgnoreStatisticsNorecompute>False</SyncOptionIgnoreStatisticsNo recompute>  <SyncOptionConsiderNextFilegroupInPartitionSchemes>False</SyncOptionConsid ernextfilegroupinpartitionschemes>  <SyncOptionIgnoreNocheckAndWithNocheckAttributes>False</SyncOptionIgnoreNo checkandwithnocheckattributes>  <SyncOptionIgnoreUserProperties>True</SyncOptionIgnoreUserProperties>  <SyncOptionIgnoreUsersPermissionsAndRoleMemberships>False</SyncOptionIgnor euserspermissionsandrolememberships>  <SyncOptionAddWithEncryption>False</SyncOptionAddWithEncryption>

5 <SyncOptionDecryptEncryptedObjects>True</SyncOptionDecryptEncryptedObjects>

6 <SyncOptionUseCompatibilityLevel>False</SyncOptionUseCompatibilityLevel> </PropertyGroup> Data comparison options <PropertyGroup>  <SyncDataOptionDropKeysIndexesAndConstraints>False</SyncDataOptionDropKeys IndexesAndConstraints>  <SyncDataOptionDisableForeignKeys>False</SyncDataOptionDisableForeignKeys>  <SyncDataOptionIncludeTimestampColumns>False</SyncDataOptionIncludeTimesta mpcolumns>  <SyncDataOptionCaseSensitiveObjectDefinition>True</SyncDataOptionCaseSensi tiveobjectdefinition>  <SyncDataOptionForceBinaryCollation>True</SyncDataOptionForceBinaryCollati on>  <SyncDataOptionTrimTrailingSpaces>False</SyncDataOptionTrimTrailingSpaces>  <SyncDataOptionDisableDmlTriggers>False</SyncDataOptionDisableDmlTriggers>  <SyncDataOptionDisableDdlTriggers>True</SyncDataOptionDisableDdlTriggers>  <SyncDataOptionDontIncludeCommentsInScript>False</SyncDataOptionDontInclud ecommentsinscript>'

7 <SyncDataOptionReseedIdentityColumns>False</SyncDataOptionReseedIdentityCo lumns>  <SyncDataOptionSkipIntegrityChecksForForeignKeys>False</SyncDataOptionSkip IntegrityChecksForForeignKeys>  <SyncDataOptionTransportClrDataTypesAsBinary>False</SyncDataOptionTranspor tclrdatatypesasbinary>  <SyncDataOptionCompressTemporaryFiles>False</SyncDataOptionCompressTempora ryfiles>  <SyncDataOptionTreatEmptyStringAsNull>False</SyncDataOptionTreatEmptyStrin gasnull>  <SyncDataOptionUseChecksumComparison>False</SyncDataOptionUseChecksumCompa rison>  <SyncDataOptionUseMaxPrecisionForFloatComparison>False</SyncDataOptionUseM

axprecisionforfloatcomparison> </PropertyGroup> To override a given option, copy the option to the top of the project file within a <ProjectGroup> element.

<PropertyGroup> <SyncOptionIgnoreDmlTriggers>True</SyncOptionIgnoreDmlTriggers> </PropertyGroup> Save the project file, and right-click the project in the Solution Explorer and click Reload project

8 axprecisionforfloatcomparison> </PropertyGroup> To override a given option, copy the option to the top of the project file within a <ProjectGroup> element. For example, to have ReadyRoll ignore DML trigger objects when importing from your connected database, add the following under the <Project> element of your project file: Example option snippet <PropertyGroup> <SyncOptionIgnoreDmlTriggers>True</SyncOptionIgnoreDmlTriggers> </PropertyGroup> Save the project file, and right-click the project in the Solution Explorer and click Reload project (click OK when prompted to close the file). Build the solution to clear the tool-window cache. The next time you use the tool-window to import changes from the connected database, the specified comparison and script generation options should be applied. Unsupported options Options that are "locked" to ensure deployment reliability A number of SQL Compare options would, if switched on, cause scripts to be generated that might not work within all of your target environments.

9 In order to ensure that a given migration can be successfully executed against all of your databases, there are a number of options that are locked to the Off setting: Ignore constraint names Ignore system-named constraint names Ignore DML trigger order Ignore certificates, symmetric keys and asymmetric keys Ignore check constraints Ignore foreign keys Ignore identity properties Ignore nullability of columns (Data Compare) Ignore underscores in object names (Data Compare) Ignore spaces in object names (Data Compare) Include indexed views (Data Compare) Exclude identity columns Other locked options Additionally, a number of script generation options are locked, as follows: Don't use transactions in deployment scripts = On. ReadyRoll automatically includes transaction handling to your deployment. To prevent transactions from being used, see transaction handling in ReadyRoll. Don't add error handling statements to deployment scripts = On. ReadyRoll uses the error-handling conventions of SQLCMD, which do not require the per-statement error handling of SQL Compare. Add Database Use Statement = Off. ReadyRoll automatically sets the database context prior to executing your migration script, so it is not necessary to include the USE statement in your scripts. Do Not Output Comment Header = On. ReadyRoll produces its own comment header in the.sql files that are output during the build process. Ignore migration scripts for databases = On. This option relates to the SQL Source Control product and therefore is not relevant to ReadyRoll script generation. Database Project compatible script folder output = Off. This option relates to SQL Server Data Tools (SSDT) database projects and therefore is not relevant to ReadyRoll script generation. Don't use ALTER ASSEMBLY to change CLR objects = Off. If you would like to apply greater control to how your SQLCLR objects are deployed, we recommend using the method described in this article on deploying Assemblies. Currently unsupported options Support for the following options has yet to be added to ReadyRoll: As of ReadyRoll (November 8th, 2016), all SQL Compare/Data Compare options are supported

Course Outline: Designing, Optimizing, and Maintaining a Database Administrative Solution for Microsoft SQL Server 2008

Course Outline: Designing, Optimizing, and Maintaining a Database Administrative Solution for Microsoft SQL Learning Method: Instructor-led Classroom Learning Duration: 5.00 Day(s)/ 40hrs Overview: This