Article.SchemaOption Property

Article
12/03/2008

Gets or sets the schema creation options for an article.

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntax

'Declaration
Public Property SchemaOption As CreationScriptOptions

public CreationScriptOptions SchemaOption { get; set; }

public:
property CreationScriptOptions SchemaOption {
    CreationScriptOptions get ();
    void set (CreationScriptOptions value);
}

/** @property */
public CreationScriptOptions get_SchemaOption ()

/** @property */
public void set_SchemaOption (CreationScriptOptions value)

public function get SchemaOption () : CreationScriptOptions

public function set SchemaOption (value : CreationScriptOptions)

Property Value

A CreationScriptOptions enumeration value that specifies the schema creation options.

Exceptions

Exception type	Condition
ApplicationException	When you set SchemaOption to an unsupported CreationScriptOptions value.

Remarks

If SchemaOption is set after the initial snapshot has been created, a new snapshot must be generated.

The SchemaOption property can be retrieved by members of the sysadmin fixed server role at the Publisher and at the Subscriber (for republishing Subscribers). It can also be retrieved by members of the db_owner fixed database role on the publication database and by users who are members of the PAL. For a MergeArticle object, this property can also be retrieved by members of the replmonitor fixed database role on the Distributor.

The SchemaOption property can be set by members of the sysadmin fixed server role at the Publisher. It can also be set by members of the db_owner fixed database role on the publication database.

Retrieving SchemaOption is equivalent to executing sp_helparticle (Transact-SQL) for transactional or snapshot replication or executing sp_helpmergearticle (Transact-SQL) for merge replication.

Setting SchemaOption is equivalent to executing sp_addarticle (Transact-SQL) or sp_changearticle (Transact-SQL) for transactional or snapshot replication. It is also equivalent to executing sp_addmergearticle (Transact-SQL) or sp_changemergearticle (Transact-SQL) for merge replication.

The SchemaOption property is available with SQL Server 2005, SQL Server 2000, and SQL Server 7.0..

This namespace, class, or member is supported only in the .NET Framework 2.0.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms