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)
Syntax
'Declaration
<FlagsAttribute> _
Public Enumeration CreationScriptOptions
'Usage
Dim instance As CreationScriptOptions
[FlagsAttribute]
public enum CreationScriptOptions
[FlagsAttribute]
public enum class CreationScriptOptions
[<FlagsAttribute>]
type CreationScriptOptions
public enum CreationScriptOptions
Members
| Member name | Description | |
|---|---|---|
| AttemptToDropNonArticleDependencies | At the Subscriber, attempts to drop dependencies to any objects that are not part of the publication. | |
| ClusteredIndexes | Includes the creation of a corresponding clustered index. | |
| Collation | Includes the definition of a column-level collation. | |
| CustomProcedures | Includes the generation of custom stored procedures. This option is only valid for the TransArticle object. You must also specify InsertCommand, UpdateCommand, and DeleteCommand. | |
| DefaultBindings | Includes default bindings and creation of the bound defaults. | |
| DisableScripting | Object 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. | |
| DriChecks | Includes the creation CHECK constraints. | |
| DriDefaults | Includes the creation column defaults. | |
| DriForeignKeys | Includes the creation of foreign key constraints to all referenced tables that are included in the publication. | |
| DriPrimaryKey | Includes the creation of primary key constraints. | |
| DriUniqueKeys | Includes the creation of unique keys. | |
| ExtendedProperties | Includes the extended properties associated with the database object being published. | |
| FileGroups | Includes the filegroups associated with a partitioned table or index.
Note The underlying filegroup layout must be created at the subscriber before the initial snapshot is applied. |
|
| FileStreamAttribute | Use 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. | |
| FileStreamDataSpace | Set 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. | |
| FilteredIndexes | Replicates any filtered indexes on the table. For more information about filtered indexes, see Create Filtered Indexes. | |
| FullTextIndex | Includes full-text indexes. | |
| HierarchyIdToVarBinaryMax | Converts 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). | |
| Identity | Includes 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. | |
| IndexPartitioningSchemes | Includes the partition scheme associated with a partitioned index.
Note The underlying partition scheme must be created at the subscriber before the initial snapshot is applied. |
|
| KeepTimestamp | Replicates timestamp columns. Without this option, timestamp columns are created on the Subscriber as binary(16) columns. This option is supported only for TransArticle objects. | |
| LargeUserDefinedTypesToVarBinaryMax | Converts 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. | |
| MarkReplicatedCheckConstraintsAsNotForReplication | Includes 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. | |
| MarkReplicatedForeignKeyConstraintsAsNotForReplication | Includes 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. | |
| MaxTypesToMatchingNonMaxTypes | Converts nvarchar(max), varchar(max), and varbinary(max) to ntext, text, and image data types, which are supported on earlier versions of SQL Server. | |
| NewDateTimeTypesToStrings | Converts 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. | |
| NonClusteredIndexes | Includes the creation of nonclustered indexes. | |
| NoXmlSchemaCollections | XML schema collections bound to xml columns are not included. | |
| Permissions | Includes permissions defined on the published object. | |
| PrimaryKeyUniqueKeyAsConstraints | Generates ALTER TABLE statements when replicating constraints. | |
| PrimaryObject | Generates a creation script (CREATE TABLE, CREATE PROCEDURE, and so on) for the published object. | |
| RuleBindings | Includes rule bindings and creation of the bound rules. | |
| Schema | Generates any schemas not already present on the subscriber. | |
| SparseAttribute | Replicates the SPARSE attribute for columns. For more information about this attribute, see Use Sparse Columns. | |
| SpatialIndexes | Replicates indexes on columns of type geography and geometry. | |
| SpatialTypesToVarBinaryMax | Converts 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. | |
| Statistics | Includes user-defined table statistics. | |
| StorageCompressionSetting | Replicates the compression option for data and indexes. For more information, see Data Compression. | |
| TablePartitioningScheme | Includes the partition scheme associated with a partitioned table.
Note The underlying partition scheme must be created at the subscriber before the initial snapshot is applied. |
|
| UserDefinedTypesToBaseTypes | Converts 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. | |
| UserTriggers | Includes the creation of user-defined triggers. | |
| XmlIndexes | Includes XML indexes. | |
| XmlToNText | xml columns are replicated to the Subscriber as ntext. |
Remarks
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.