Article.CreationScript Property

Gets or sets the name and full path of the Transact-SQL script file that is used to create the destination object at the Subscriber.

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

Syntax

'Declaration
Public Property CreationScript As String

public string CreationScript { get; set; }

public:
property String^ CreationScript {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_CreationScript ()

/** @property */
public void set_CreationScript (String value)

public function get CreationScript () : String

public function set CreationScript (value : String)

Property Value

A String value that specifies the name and full path of the article schema script file.

Remarks

Setting CreationScript after the article has been created on the server requires the generation of a new snapshot. For more information, see How to: Create the Initial Snapshot (RMO Programming).

The CreationScript property is a read/write property.

The CreationScript 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 CreationScript 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 CreationScript is equivalent to executing sp_helparticle (Transact-SQL) for transactional or snapshot replication or executing sp_helpmergearticle (Transact-SQL) for merge replication.

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

The CreationScript 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

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

See Also

Reference

Article Class
Article Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Define an Article (RMO Programming)
How to: View and Modify Article Properties (RMO Programming)