xSQL Schema Compare SDK for SQL Server version 12
ScriptingOptions Class Members
Properties 


The following tables list the members exposed by ScriptingOptions.

Public Constructors
 NameDescription
Public ConstructorScriptingOptions ConstructorInitializes a new instance of the ScriptingOptions class. The script, by default, is set to CREATE script.  
Top
Public Properties
 NameDescription
Public PropertyAbandonRemoteDataWhenDisablingArchiving Gets or sets the value that indicates whether the remote data should be abandon when the table remote archiving or stretching is disabled.  
Public PropertyAddAssemblyToTrustedList Gets or sets the value that indicates whether a new assembly should be added to the trusted list when the assembly is created. It applies to SQL Server 2017 or higher.  
Public PropertyAlterScript Gets or sets the value that indicates whether the script should ALTER the database entity.  
Public PropertyCheckAbsence Indicates whether a check for absence should be added to the script that creates an object. This option generates a "IF NOT EXISTS()..." statement.  
Public PropertyCheckExistence Indicates whether a check for existence should be added to the script that drops an object. This option generates a "IF EXISTS ()..." statement.  
Public PropertyCreateScript Gets or sets the value that indicates whether the script should CREATE the database entity.  
Public PropertyDropScript Gets or sets the value that indicates whether the script should DROP the database entity.  
Public PropertyDropSystemVersioningHistoryTable Gets or sets the value that indicates whether the history associated with a system-versioned table should be dropped when the table is dropped or when the table system-versioning is disabled.  
Public PropertyRefreshReferencedObjectsOnRebuild Indicates whether the table rebuild script should refresh the referenced objects. It applies only to referenced views.  
Public PropertyRemoveAssemblyFromTrustedListWhenDropped Gets or sets the value that indicates whether the an assembly should be removed from the trusted list when it is dropped from the database. It applies to SQL Server 2017 or higher.  
Public PropertyScriptAnsiNullsSettings Indicates whether the SET ANSI_NULLS setting should be scripted.  
Public PropertyScriptAnsiPaddingSetting Indicates whether the SET ANSI_PADDING setting should be scripted.  
Public PropertyScriptBindingToDefault Indicates whether the script that binds columns and data types to stand-alone defaults should be generated.  
Public PropertyScriptBindingToRule Indicates whether the script that binds columns and data types to rules should be generated.  
Public PropertyScriptCheckConstraint Indicates whether the check constraints should be included in the script for a table or table data type.  
Public PropertyScriptCheckConstraintEmbedded Indicates whether the script for the check constraint should be generated as an embedded script for a table.  
Public PropertyScriptCheckConstraintsName Indicates whether the check constraint name should be included in the embedded script. This option has no effect when the check constraint is scripted as a stand-alone constraint.  
Public PropertyScriptCollation Indicates whether the column collation should be scripted.  
Public PropertyScriptColumnEncryption Gets or sets the value that indicates whether the column encryption clause ENCRYPTED WITH (...) should be scripted.  
Public PropertyScriptColumnMask Gets or sets the value that indicates whether the column dynamic mask MASKED WITH (...) should be scripted.  
Public PropertyScriptColumnstoreIndexDropExisting Indicates whether the DROP_EXISTING option of a columnstore index should be scripted.  
Public PropertyScriptConstraintsWithNoCheck Indicates whether a check constrains should be scripted with NOCHECK option.  
Public PropertyScriptDataCompression Indicates whether the data compression for a table or index should be scripted.  
Public PropertyScriptDefaultConstraint Indicates whether the default constraints should be included in the script for a table or table data type.  
Public PropertyScriptDefaultConstraintEmbedded Indicates whether the script for a default constraint should be generated as an embedded script for a table.  
Public PropertyScriptDefaultConstraintsName Indicates whether the default constraint name should be included in the embedded script. This option has no effect when the default constraint is scripted as a stand-alone constraint.  
Public PropertyScriptEdgeConstraints Gets or sets the value that indicates whether the edge constraints should be included in the table script.  
Public PropertyScriptExtendedProperties Indicates whether the extended properties should be included in the script.  
Public PropertyScriptFileGroup Indicates whether the filegroup should be scripted for a table or index.  
Public PropertyScriptForeignKeys Indicates whether the foreign keys should be included in the script for a table.  
Public PropertyScriptFullTextCatalogPath Indicates whether the full-text catalog script should contain the catalog physical path.  
Public PropertyScriptFullTextIndex Indicates whether the full-text indexes should be included in the script for a table or view.  
Public PropertyScriptFullTextStopListWords Indicates whether the script should include full-text stop list keywords.  
Public PropertyScriptHistoryRemoteDataArchiving Gets or sets the value that indicates whether the remote data archiving of the temporal history table should be scripted.  
Public PropertyScriptIndexes Indicates whether the indexes should be included in the script for a table or view.  
Public PropertyScriptIndexFillFactorProperty Indicates whether the FILLFACTOR option should be scripted for an index, primary key or unique constraint.  
Public PropertyScriptIndexIgnoreDuplicateKeysProperty Indicates whether the IGNORE_DUP_KEY option should be scripted for an index or unique constraint.  
Public PropertyScriptIndexPaddingProperty Indicates whether the PAD_INDEX option should be scripted for an index, primary key or unique constraint.  
Public PropertyScriptIndexPageLocksProperty Indicates whether the ALLOW_PAGE_LOCKS option should be scripted for an index, primary key or unique constraint.  
Public PropertyScriptIndexRowLocksProperty Indicates whether the ALLOW_ROW_LOCKS option should be scripted for an index, primary key or unique constraint.  
Public PropertyScriptIndexStatsNoRecomputeProperty Indicates whether the STATISTICS_NORECOMPUTE option should be scripted for an index, primary key and unique constraint.  
Public PropertyScriptMasterKey Indicates whether the database master key should be scripted.  
Public PropertyScriptMembershipToRole Indicates whether the membership to database roles should be scripted.  
Public PropertyScriptNotForReplication Indicates whether the NOT FOR REPLICATION property should be scripted.  
Public PropertyScriptNullability Indicates whether the column NULL/NOT NULL property should be scripted.  
Public PropertyScriptOpenMasterKey Indicates whether the script should contain the statement that opens the database master key.  
Public PropertyScriptPermissions Indicates whether the permissions should be included in the script.  
Public PropertyScriptPrimaryKeys Indicates whether the primary key should be included in the script for a table or table data type.  
Public PropertyScriptPrimaryKeysEmbedded Indicates whether the primary key script should be generated as an embedded script for a table.  
Public PropertyScriptQuotedIdentifierSetting Indicates whether the SET QUOTED_IDENTIFIER setting should be scripted.  
Public PropertyScriptRemoteDataArchiving Gets or sets the value that indicates whether the remote data archiving (or stretching) of a table should be scripted.  
Public PropertyScriptSearchPropertyListProperties Indicates whether the script should include the properties of search property lists.  
Public PropertyScriptSequenceMaxValue Indicates whether sequence max value should be scripted.  
Public PropertyScriptSequenceMinValue Indicates whether sequence min value should be scripted.  
Public PropertyScriptSequenceStartValue Indicates whether sequence start value should be scripted.  
Public PropertyScriptSpatialIndexes Indicates whether the spatial indexes should be included in the script for a table.  
Public PropertyScriptStatistics Indicates whether the statistics should be included in the script for a table or view.  
Public PropertyScriptSystemVersioning Gets or sets the value that indicates whether the system-versioning for a table should be scripted.  
Public PropertyScriptTableChangeDataCapture Indicates whether the table change data capture should be scripted.  
Public PropertyScriptTableChangeTracking Indicates whether the table change tracking should be scripted.  
Public PropertyScriptTableLockEscalation Indicates whether the table lock escalation property should be scripted.  
Public PropertyScriptTriggers Indicates whether the triggers should be included in the script for a table or view.  
Public PropertyScriptUniqueConstraints Indicates whether the unique constraints should be included in the script for a table or table data type.  
Public PropertyScriptUniqueConstraintsEmbedded Indicates whether the unique constraint script should be generated as an embedded script for a table.  
Public PropertyScriptXmlIndexes Indicates whether the xml indexes should be included in the script for a table.  
Public PropertyStandardizeNameInDefinition Indicates whether the object name in the SQL definition should be formatted as [schema].[name]. This option applies to views, procedures, functions and triggers.  
Top
See Also

Reference

ScriptingOptions Class
xSQL.Schema.SqlServer Namespace

 

 


©Copyright 2022 xSQL Software. All Rights Reserved.

Send Feedback