ComparisonOptions Class Members

The following tables list the members exposed by ComparisonOptions.

Public Constructors

	Name	Description
	ComparisonOptions Constructor	Initializes new instance of the ComparisonOptions class.

Top

Public Properties

	Name	Description
	AbandonRemoteDataWhenDisablingArchiving	Gets or sets the value that indicates whether the remote data should be abandoned when the table remote archiving or stretching is disabled.
	AlterFunctionWithDropCreate	Gets or sets the value that indicates whether the functions should be altered using a DROP/CREATE statement instead of the ALTER statement.
	AlterProcedureWithDropCreate	Gets or sets the value that indicates whether the stored procedures should be altered using a DROP/CREATE statement instead of the ALTER statement.
	AlterViewWithDropCreate	Gets or sets the value that indicates whether the views should be altered using a DROP/CREATE statement instead of the ALTER statement.
	AssemblyCreateOption	Gets or sets the value that indicates the additional scripting action that should be included when a new assembly is created. It applies to new assemblies on SQL Server 2017 or higher.
	CompareAggregates	Gets or sets the value that indicates whether the aggregates should be compared and synchronized.
	CompareAnsiNullsSetting	Gets or sets the value that indicates whether the ANSI_NULLS attribute should be compared.
	CompareApplicationRoles	Gets or sets the value that indicates whether application roles should be compared and synchronized.
	CompareAssemblies	Gets or sets the value that indicates whether the database assemblies should be compared and synchronized.
	CompareAsymmetricKeys	Gets or sets the value that indicates whether the asymmetric keys should be compared and synchronized.
	CompareBrokerContracts	Gets or sets the value that indicates whether the service broker contracts should be compared and synchronized.
	CompareBrokerMessageTypes	Gets or sets the value that indicates whether the service broker message types should be compared and synchronized.
	CompareBrokerPriorities	Gets or sets the value that indicates whether the service broker priorities should be compared and synchronized.
	CompareBrokerQueues	Gets or sets the value that indicates whether the service broker queues should be compared and synchronized.
	CompareBrokerRemoteBindings	Gets or sets the value that indicates whether the remote service bindings should be compared and synchronized.
	CompareBrokerRoutes	Gets or sets the value that indicates whether the service broker routes should be compared and synchronized.
	CompareBrokerServices	Gets or sets the value that indicates whether the broker services should be compared and synchronized.
	CompareCertificates	Gets or sets the value that indicates whether the certificates should be compared and synchronized.
	CompareCheckConstraints	Gets or sets the value that indicates whether the check constraints should be compared and synchronized.
	CompareCheckedProperty	Gets or sets the value that indicates whether the "checked" property of a check constraint or of a foreign key constraint should be compared.
	CompareClrDataTypes	Gets or sets the value that indicates whether CLR types should be compared and synchronized.
	CompareColumnCollation	Gets or sets the value that indicates whether the column collation should be compared and synchronized.
	CompareColumnEncryption	Gets or sets the value that indicates whether the column encryption clause should be compared and synchronized.
	CompareColumnEncryptionKeys	Gets or sets the value that indicates whether the column encryption keys should be compared and synchronized.
	CompareColumnMask	Gets or sets the value that indicates whether the column dynamic mask should be compared and synchronized.
	CompareColumnMasterKeyPath	Gets or sets the value that indicates whether the key path of a column master key should be compared.
	CompareColumnMasterKeyProvider	Gets or sets the value that indicates whether the provider of a column master key should be compared.
	CompareColumnMasterKeys	Gets or sets the value that indicates whether the column master keys should be compared and synchronized.
	CompareColumnOrdinal	Gets or sets the value that indicates whether the order that the column appears in a table, should be compared and synchronized.
	CompareDatabaseFileGroups	Gets or sets the value that indicates whether the database filegroups should be compared and synchronized.
	CompareDatabaseLogFiles	Gets or sets the value that indicates whether database log files should be compared and synchronized.
	CompareDatabaseRoles	Gets or sets the value that indicates whether database roles should be compared and synchronized.
	CompareDatabaseTriggers	Gets or sets the value that indicates whether the database triggers should be compared and synchronized.
	CompareDataCompression	Gets or sets the value that indicates whether data compression should be compared and synchronized. This option effects tables and indexes.
	CompareDefaultConstraints	Gets or sets the value that indicates whether the default constraints should be compared and synchronized.
	CompareDefaults	Gets or sets the value that indicates whether the stand-alone defaults should be compared and synchronized.
	CompareDiagramObjects	Gets or sets the value that indicates whether the objects that support that SQL Server diagrams should be compared and synchronized.
	CompareEdgeConstraints	Gets or sets the value that indicates whether the edge constraints on graph edge tables should be compared and synchronized.
	CompareExtendedProperties	Gets or sets the value that indicates whether the extended properties should be compared and synchronized.
	CompareForeignKeys	Gets or sets the value that indicates whether the foreign keys should be compared and synchronized.
	CompareFullTextCatalogs	Gets or sets the value that indicates whether the full-text catalogs should be compared and synchronized.
	CompareFullTextIndexes	Gets or sets the value that indicates whether the full-text indexes should be compared and synchronized.
	CompareFullTextStopLists	Gets or sets the value that indicates whether the full-text stop lists should be compared and synchronized.
	CompareFullTextStopListWords	Gets or sets the value that indicates whether the keywords associated with a full-text stop list should be compared and synchronized.
	CompareFunctions	Gets or sets the value that indicates whether functions should be compared and synchronized.
	CompareGraphTables	Gets or sets the value that indicates whether the graph node and edge tables should be compared and synchronized.
	CompareHashIndexBucketCount	Gets or sets the value that indicates whether the BUCKET_COUNT property of a hash index should be compared.
	CompareIdentity	Gets or sets the value that indicates whether the column identity should be compared and synchronized.
	CompareIdentityIncrement	Gets or sets the value that indicates whether the column identity increment should be compared and synchronized.
	CompareIdentitySeed	Gets or sets the value that indicates whether the column identity seed should be compared and synchronized.
	CompareIndexColumnOrder	Gets or sets the value that indicates whether the order of the columns in an index should be compared and synchronized.
	CompareIndexes	Gets or sets the value that indicates whether indexes should be compared and synchronized.
	CompareIndexFillFactor	Gets or sets the value that indicates whether the index FILLFACTOR property should be compared and synchronized.
	CompareIndexPadding	Gets or sets the value that indicates whether the index PAD_INDEX property should be compared and synchronized.
	CompareIndexPageLocks	Gets or sets the value that indicates whether the index ALLOW_PAGE_LOCKS property should be compared and synchronized.
	CompareIndexRowLocks	Gets or sets the value that indicates whether the index ALLOW_ROW_LOCKS property should be compared and synchronized.
	CompareIndexStatsNoRecompute	Gets or sets the value that indicates whether the index STATISTICS_NORECOMPUTE property should be compared and synchronized.
	CompareMemoryTables	Indicates whether memory-optimized tables should be compared and synchronized.
	CompareNotForReplication	Gets or sets the value that indicates whether the NOT FOR REPLICATION property should be compared and synchronized.
	CompareNullability	Gets or sets the value that indicates whether the column NULL/NOT NULL property should be compared and synchronized.
	ComparePartitionFunctions	Gets or sets the value that indicates whether the partition functions should be compared and synchronized.
	ComparePartitioning	Gets or sets the value that indicates whether partitioning should be compared for tables and indexes.
	ComparePartitionSchemes	Gets or sets the value that indicates whether the partition schemes should be compared and synchronized.
	ComparePermissions	Gets or sets the value that indicates whether the permissions should be compared and synchronized.
	ComparePrimaryKey	Gets or sets the value that indicates whether primary keys should be compared and synchronized.
	CompareProcedures	Gets or sets the value that indicates whether the stored procedures should be compared and synchronized.
	CompareQuotedIdentifierSetting	Gets or sets the value that indicates whether the QUOTED_IDENTIFIER attribute should be compared.
	CompareRemoteDataArchiving	Gets or sets the value that indicates whether the table remote data archiving or stretching should be compared and synchronized.
	CompareReplicatedTables	Gets or sets the value that indicates whether replicated tables should be compared and synchronized.
	CompareRules	Gets or sets the value that indicates whether the rules should be compared and synchronized.
	CompareSchemas	Gets or sets the value that indicates whether database schemas should be compared and synchronized.
	CompareSearchPropertyLists	Gets or sets the value that indicates whether the search property lists should be compared and synchronized.
	CompareSecurityPolicies	Gets or sets the value that indicates whether the security policies should be compared and synchronized.
	CompareSequenceMaxValue	Gets or sets the value that indicates whether the max value of a sequence should be compared and synchronized.
	CompareSequenceMinValue	Gets or sets the value that indicates whether the min value of a sequence should be compared and synchronized.
	CompareSequences	Gets or sets the value that indicates whether the sequences should be compared and synchronized.
	CompareSequenceStartValue	Gets or sets the value that indicates whether the start value of a sequence should be compared and synchronized.
	CompareSpatialIndexes	Gets or sets the value that indicates whether spatial indexes should be compared and synchronized.
	CompareStatistics	Gets or sets the value that indicates whether the statistics should be compared and synchronized.
	CompareSymmetricKeys	Gets or sets the value that indicates whether the symmetric keys should be compared and synchronized.
	CompareSynonymDatabase	Gets or sets the value that indicates whether the database property of the base object of a synonym name should be compared and synchronized.
	CompareSynonyms	Gets or sets the value that indicates whether the synonyms should be compared and synchronized.
	CompareSynonymServer	Gets or sets the value that indicates whether the server property of the base object of a synonym name should be compared and synchronized.
	CompareSystemVersioning	Gets or sets the value that indicates whether the system-versioning should be compared. It effects the system-versioning of tables and memory tables.
	CompareTableChangeDataCapture	Indicates whether the change data capture attribute of database tables should be compared and synchronized.
	CompareTableChangeTracking	Indicates whether the change tracking attribute of database tables should be compared and synchronized.
	CompareTableLockEscalation	Indicates whether the lock escalation attribute of database tables should be compared and synchronized.
	CompareTables	Gets or sets the value that indicates whether tables should be compared and synchronized.
	CompareTriggers	Gets or sets the value that indicates whether triggers should be compared and synchronized.
	CompareUniqueConstraints	Gets or sets the value that indicates whether unique constraints should be compared and synchronized.
	CompareUserDefinedDataTypes	Gets or sets the value that indicates whether user-defined data types should be compared and synchronized.
	CompareUserDefinedTableTypes	Gets or sets the value that indicates whether user-defined table types should be compared and synchronized.
	CompareUserLogin	Gets or sets the value that indicates whether the login associated with a database user should be compared.
	CompareUsers	Gets or sets the value that indicates whether database users should be compared and synchronized.
	CompareViews	Gets or sets the value that indicates whether the views should be compared and synchronized.
	CompareXmlIndexes	Gets or sets the value that indicates whether xml indexes should be compared and synchronized.
	CompareXmlSchemaCollections	Gets or sets the value that indicates whether xml schema collections should be compared and synchronized.
	ContinueExecutionOnError	Gets or sets the value that indicates whether the execution of the schema synchronization script should continue, if possible, when an error occurs.
	DropSystemVersioningHistoryTable	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.
	ExecuteTransactionalScript	Gets or sets the value that indicates whether the synchronization script should be executed as a transactional script.
	FileGroupComparisonOption	Gets or sets the filegroup comparison option.
	FileGroupMappings	Gets the collection of custom mappings to be used for database filegroups.
	FileStreamFileGroupComparisonOption	Gets or sets the filestream filegroup comparison option.
	FileStreamFileGroupMappings	Gets the collection of custom mappings for filestream filegroups.
	GenerateCheckAbsenceStatement	Gets or sets the value that indicates whether a check for absence should be performed before creating an object.
	GenerateCheckExistenceStatement	Gets or sets the value that indicates whether a check for existence should be performed before dropping an object.
	GenerateTransactionalScript	Gets or sets the value that indicates whether the synchronization script should be generated as a transactional script.
	GenerateUseDatabaseStatement	Gets or sets the value that indicates whether the synchronization script should contain a USE <database> statement.
	IgnoreCaseInDefinition	Gets or sets the value that indicates whether the character case should be ignored when comparing the object's definition. It effects views, procedures, functions and triggers.
	IgnoreCheckConstraintName	Gets or sets the value that indicates whether the name of a check constraint should be ignored when constraints are mapped.
	IgnoreDefaultConstraintName	Gets or sets the value that indicates whether the default constraint name should be ignored.
	IgnoreFunctionComments	Gets or sets the value that indicates whether the SQL comments in the function definition should be ignored.
	IgnoreNameInDefinition	Gets or sets the value that indicates whether the name portion in the object's definition should be ignored. It effects views, procedures, functions and triggers.
	IgnorePrimaryKeyName	Gets or sets the value that indicates whether primary key name should be ignored.
	IgnoreProcedureComments	Gets or sets the value that indicates whether the SQL comments in the definition of a stored procedure should be ignored.
	IgnoreSpacesInDefinition	Gets or sets the value that indicates whether white spaces should be ignored in the object's definition. It effects views, procedures, functions and triggers.
	IgnoreSystemVersioningHistoryTableName	Gets or sets the value that indicates whether the name of the history table, used by the system-versioning, should be ignored when two temporal tables compared.
	IgnoreTriggerComments	Gets or sets the value that indicates whether the SQL comments in the trigger definition should be ignored.
	IgnoreUniqueConstraintName	Gets or sets the value that indicates whether the name of a unique constraint should be ignored when constraints are mapped.
	IgnoreViewComments	Gets or sets the value that indicates whether the SQL comments in the definition of a view should be ignored.
	IncludeDependantObjects	Gets or sets the value the indicates whether the dependencies should be included in the synchronization script.
	LogScriptExecution	Gets or sets the value that indicates that T-SQL script fragments that sent to SQL Server should be logged to a file.
	PreventSchemaDrop	Gets or sets the value that indicates whether the synchronization script should not generate the statements that drop a database schema.
	RemoveAssemblyFromTrustedListWhenDropped	Gets or sets the value that indicates whether an assembly should be removed from the trusted list when it is dropped from the database. It effects dropped assemblies on SQL Server 2017 or higher.
	ScriptAnsiNullsSetting	Gets or sets the value that indicates whether the ANSI_NULLS property should be scripted.
	ScriptAnsiPaddingSetting	Gets or sets the value that indicates whether the ANSI_PADDING property should be scripted.
	ScriptCollation	Gets or sets the value that indicates whether the column collation property should be scripted.
	ScriptColumnEncryption	Gets or sets the value that indicates whether the column's ENCRYPTED WITH(...) clause should be scripted.
	ScriptColumnMask	Gets or sets the value that indicates whether the column's MASKED WITH(...) clause should be scripted.
	ScriptConstraintsWithNoCheck	Gets or sets the value that indicates whether the check constraints should be scripted with NOCHECK option.
	ScriptDataCompression	Gets or sets the value that indicates whether the data compression attribute of a table or index should be scripted.
	ScriptFileGroup	Gets or sets the value that indicates whether the filegroup property of a table or index should be scripted.
	ScriptFullTextCatalogPath	Gets or sets the value that indicates whether the full-text catalog path property should be scripted.
	ScriptHistoryRemoteDataArchiving	Gets or sets the value that indicates whether the table remote data archiving clause of the temporal history table should be scripted.
	ScriptNewColumnsAsNull	Gets or sets the value that indicates whether the missing columns that do not allow NULL should be scripted as nullable.
	ScriptQuotedIdentifierSetting	Gets or sets the value that indicates whether the QUOTED_IDENTIFIER property should be scripted.
	ScriptRemoteDataArchiving	Gets or sets the value that indicates whether the table remote data archiving clause should be scripted.
	ScriptSequenceMaxValue	Gets or sets the value that indicates whether the sequence max value should be scripted.
	ScriptSequenceMinValue	Gets or sets the value that indicates whether the sequence min value should be scripted.
	ScriptSequenceStartValue	Gets or sets the value that indicates whether the sequence start value should be scripted.
	ScriptSystemVersioning	Gets or sets the value that indicates whether the system-versioning of a table or memory table should be scripted.
	ScriptTableChangeDataCapture	Gets or sets the value that indicates whether the change data capture of a table should be scripted.
	ScriptTableChangeTracking	Gets or sets the value that indicates whether the change tracking of a table should be scripted.
	ScriptTableLockEscalation	Gets or sets the value that indicates whether the lock escalation of a table should be scripted.
	StandardizeNameInDefinition	Indicates that the synchronization script should standardize the object name in the definition. The name will be formatted as [schema].[name]. This option effects only views, procedures, functions and triggers.
	TransactionSize	Gets or sets the max size, in bytes, of the transaction under which the synchronization script runs.

Top

Public Methods

	Name	Description
	ClearAllSchemaObjects	Sets to false all options flagged with the attribute ComparisonOptionDescriptorAttribute.OptionType ComparisonOptionTypeEnum.SchemaObject. The options cleared by this method correspond to the schema objects.
	Clone	Clones this object.
	ComparisonOptionsEquals	Indicates whether the comparison options of this object are equal to the comparison options of the other object.
	Equals	Overloaded. Indicates whether this object is equal to the other object.
	ExecutionOptionsEquals	Indicates whether the execution options of this object are equal to the execution options of the other object.
	GetComparisonOptionProperties	Returns the options that effects the database comparison.
	GetExecutionOptionProperties	Returns the options that effects the execution of the schema synchronization script.
	GetProperties	Gets a collection of properties marked with the attribute ComparisonOptionDescriptorAttribute and one of the specified ComparisonOptionTypeEnum types.
	GetSchemaObjectProperties	Returns the comparison options that represent database objects.
	GetScriptingOptionProperties	Returns the options that effects the scripting of database objects and properties.
	OptionsEquals	Indicates whether the comparison options, with the specified type, of this object are equal to the same options of the other object.
	SchemaObjectOptionsEquals	Indicates whether the options related to schema objects are equal to the same options of the other object.
	ScriptingOptionsEquals	Indicates whether the scripting options of this object are equal to the scripting options of the other object.
	SetAllSchemaObjects	Sets to true all options flagged with the attribute ComparisonOptionDescriptorAttribute.OptionType ComparisonOptionTypeEnum.SchemaObject. The options sets by this method correspond to the schema objects.
	SetDefaultSchemaObjects	Sets to default value of all options flagged with the attribute ComparisonOptionDescriptorAttribute.OptionType ComparisonOptionTypeEnum.SchemaObject. The options modified by this method correspond to the schema objects.
	SetSchemaObjectOptions	Sets the value of options flagged with the attribute ComparisonOptionDescriptorAttribute.OptionType ComparisonOptionTypeEnum.SchemaObject to the specified value.

Top

Reference

ComparisonOptions Class
xSQL.SchemaCompare.SqlServer Namespace