Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

CreationScriptOptions Enumeration

Enumerates schema option values for published articles.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
[FlagsAttribute]
public enum CreationScriptOptions
Member nameDescription
AttemptToDropNonArticleDependenciesAt the Subscriber, attempts to drop dependencies to any objects that are not part of the publication.
ClusteredIndexesIncludes the creation of a corresponding clustered index.
CollationIncludes the definition of a column-level collation.
CustomProceduresIncludes the generation of custom stored procedures. This option is only valid for the TransArticle object. You must also specify InsertCommand, UpdateCommand, and DeleteCommand.
DefaultBindingsIncludes default bindings and creation of the bound defaults.
DisableScriptingObject creation scripts are not generated by the Snapshot Agent. You must specify a user-supplied script file to define the object at the Subscriber for CreationScript.
DriChecksIncludes the creation CHECK constraints.
DriDefaultsIncludes the creation column defaults.
DriForeignKeysIncludes the creation of foreign key constraints to all referenced tables that are included in the publication.
DriPrimaryKeyIncludes the creation of primary key constraints.
DriUniqueKeysIncludes the creation of unique keys.
ExtendedPropertiesIncludes the extended properties associated with the database object being published.
FileGroupsIncludes the filegroups associated with a partitioned table or index.
NoteNote

The underlying filegroup layout must be created at the subscriber before the initial snapshot is applied.

FileStreamAttributeUse this option to replicate the FILESTREAM attribute if it is specified on varbinary(max) columns. Do not specify this option if you are replicating tables to SQL Server 2005 Subscribers.
FileStreamDataSpaceSet this option to store FILESTREAM data on its own filegroup at the Subscriber. If this option is not set, FILESTREAM data is stored on the default filegroup. Replication does not create filegroups; therefore, if you set this option, you must create the filegroup before you apply the snapshot at the Subscriber. For more information about how to create objects before you apply the snapshot, see Execute Scripts Before and After the Snapshot Is Applied.
FilteredIndexesReplicates any filtered indexes on the table. For more information about filtered indexes, see Create Filtered Indexes.
FullTextIndexIncludes full-text indexes.
HierarchyIdToVarBinaryMaxConverts the hierarchyid data type to varbinary(max) so that columns of type hierarchyid can be replicated to Subscribers that are running SQL Server 2005. For more information about how to use hierarchyid columns in replicated tables, see hierarchyid (Transact-SQL).
IdentityIncludes the creation of identity columns. This option is supported only for TransArticle objects and only for Microsoft SQL Server 2005 and later releases. For more information, see Replicate Identity Columns.
IndexPartitioningSchemesIncludes the partition scheme associated with a partitioned index.
NoteNote

The underlying partition scheme must be created at the subscriber before the initial snapshot is applied.

KeepTimestampReplicates timestamp columns. Without this option, timestamp columns are created on the Subscriber as binary(16) columns. This option is supported only for TransArticle objects.
LargeUserDefinedTypesToVarBinaryMaxConverts common language runtime (CLR) user-defined types (UDTs) that are larger than 8000 bytes to varbinary(max) so that columns of type UDT can be replicated to Subscribers that are running SQL Server 2005.
MarkReplicatedCheckConstraintsAsNotForReplicationIncludes the NOT FOR REPLICATION clause when creating CHECK constraints so that the constraints are not enforced during synchronization. For more information, see Controlling Constraints, Identities, and Triggers with NOT FOR REPLICATION.
MarkReplicatedForeignKeyConstraintsAsNotForReplicationIncludes the NOT FOR REPLICATION clause when creating FOREIGN KEY constraints so that the constraints are not enforced during synchronization. For more information, see Controlling Constraints, Identities, and Triggers with NOT FOR REPLICATION.
MaxTypesToMatchingNonMaxTypesConverts nvarchar(max), varchar(max), and varbinary(max) to ntext, text, and image data types, which are supported on earlier versions of SQL Server.
NewDateTimeTypesToStringsConverts date and time data types (date, time, datetimeoffset, and datetime2) introduced in SQL Server 2008 to data types that are supported on earlier versions of SQL Server. For information about how these types are mapped, see the "Mapping New Data Types for Earlier Versions" section in Using Multiple Versions of SQL Server in a Replication Topology.
NonClusteredIndexesIncludes the creation of nonclustered indexes.
NoXmlSchemaCollectionsXML schema collections bound to xml columns are not included.
PermissionsIncludes permissions defined on the published object.
PrimaryKeyUniqueKeyAsConstraintsGenerates ALTER TABLE statements when replicating constraints.
PrimaryObjectGenerates a creation script (CREATE TABLE, CREATE PROCEDURE, and so on) for the published object.
RuleBindingsIncludes rule bindings and creation of the bound rules.
SchemaGenerates any schemas not already present on the subscriber.
SparseAttributeReplicates the SPARSE attribute for columns. For more information about this attribute, see Use Sparse Columns.
SpatialIndexesReplicates indexes on columns of type geography and geometry.
SpatialTypesToVarBinaryMaxConverts the geography and geometry data types to varbinary(max) so that columns of these types can be replicated to Subscribers that are running SQL Server 2005.
StatisticsIncludes user-defined table statistics.
StorageCompressionSettingReplicates the compression option for data and indexes. For more information, see Data Compression.
TablePartitioningSchemeIncludes the partition scheme associated with a partitioned table.
NoteNote

The underlying partition scheme must be created at the subscriber before the initial snapshot is applied.

UserDefinedTypesToBaseTypesConverts user-defined data types columns at the Publisher to base SQL Server data type columns at the Subscriber. This option is not supported for non-SQL Server Publishers.
UserTriggersIncludes the creation of user-defined triggers.
XmlIndexesIncludes XML indexes.
XmlToNTextxml columns are replicated to the Subscriber as ntext.

The schema options for an article control how the published object will created at the Subscriber, and affect how the snapshot script files are generated. For more information, see Publish Data and Database Objects.

Values of the CreationScriptOptions enumeration are equivalent to values of the @schema_option parameter of sp_addarticle (Transact-SQL) and sp_addmergearticle (Transact-SQL).

The CreationScriptOptions enumeration supports the FlagsAttribute option which allows bitwise combination of enumeration values.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.