ReplicationDatabase.Script(ScriptOptions) Method

Definition

Returns a Transact-SQL script to enable or disable replication publishing and subscriptions on the database based on the properties of ReplicationDatabase.

public:
 System::String ^ Script(Microsoft::SqlServer::Replication::ScriptOptions scriptOption);
public string Script (Microsoft.SqlServer.Replication.ScriptOptions scriptOption);
member this.Script : Microsoft.SqlServer.Replication.ScriptOptions -> string
Public Function Script (scriptOption As ScriptOptions) As String

Parameters

scriptOption
ScriptOptions

A ScriptOptions object value that specifies the replication options to script.

Returns

A String value that contains the Transact-SQL script.

Remarks

The scriptOption parameter specifies what is to be included in the script. For example:

  • Use Creation to get the creation script.

  • Use Deletion to get the deletion script.

  • Use IncludePublications to include creation scripts for all publications that belong to the database.

  • Use IncludePullSubscriptions to include creation scripts for all pull subscriptions that belong to the database.

You must specify at least one of the following: Creation or Deletion.

Applies to