ScriptOptions Enumeration
Enumerates options for generating scripts that are used to create or remove replication objects.
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 ScriptOptions
'Usage
Dim instance As ScriptOptions
[FlagsAttribute]
public enum ScriptOptions
[FlagsAttribute]
public enum class ScriptOptions
[<FlagsAttribute>]
type ScriptOptions
public enum ScriptOptions
Members
| Member name | Description | |
|---|---|---|
| Creation | Specifies that the generated script is for creating replication objects. | |
| Deletion | Specifies that the script is for deleting a replication object. | |
| DisableReplicationDB | Specifies that the script is a deletion script that disables publishing on a database and removes any agent jobs needed for publishing. | |
| EnableReplicationDB | Specifies that the script is a creation script that enables publishing on a database and creates any agent jobs needed for publishing. | |
| IncludeAgentProfiles | Specifies that the script includes all user-defined replication agent profiles defined on the Distributor. | |
| IncludeAll | Specifies that the script includes all possible replication objects that can exist, which is equivalent to setting all values of ScriptOptions. | |
| IncludeArticles | Specifies that the script includes articles. | |
| IncludeChangeDestinationDataTypes | Specifies that the script includes any user-defined data type mappings. This option is only supported for non-SQL Server Publishers when the IncludeArticles option is enabled. | |
| IncludeCreateDistributionAgent | Specifies that the script includes Distribution Agent jobs. | |
| IncludeCreateLogreaderAgent | Specifies that the script includes Log Reader Agent jobs. | |
| IncludeCreateMergeAgent | Specifies that the script includes Merge Agent jobs. | |
| IncludeCreateQueuereaderAgent | Specifies that the script includes Queue Reader Agent jobs. | |
| IncludeCreateSnapshotAgent | Specifies that the script includes Snapshot Agent jobs. | |
| IncludeDisableReplicationDB | Specifies that the script disables publishing on a database and removes any agent jobs needed for publishing. | |
| IncludeDistributionPublishers | Specifies that the script includes Publishers. | |
| IncludeEnableReplicationDB | Specifies that the script enables publishing on a database and creates any agent jobs needed for publishing. | |
| IncludeGo | Specifies that the script includes the GO command at the end of a batch. | |
| IncludeInstallDistributor | Specifies that the script installs publishing objects at the Distributor. | |
| IncludeMergeDynamicSnapshotJobs | Specifies that the script includes the definition of any existing partitioned snapshot jobs for merge publications with parameterized row filters. | |
| IncludeMergeJoinFilters | Specifies that the script includes the definition of all join filters defined for a merge publication. | |
| IncludeMergePartitions | Specifies that the script includes the definition of any existing partitions for merge publications with parameterized row filters. | |
| IncludeMergePublicationActivation | Specifies that the script includes setting the status of a merge publication to active. | |
| IncludePartialSubscriptions | Specifies that the script includes subscriptions to transactional publications that do not subscribe to all articles in the publication. | |
| IncludePublicationAccesses | Specifies that the script includes all logins added to the publication access list (PAL). This option is only supported for publication creation scripts. Deleting a publication automatically removes the PAL. | |
| IncludePublications | Specifies that the script includes publications. | |
| IncludePublisherSideSubscriptions | Specifies that the script includes the registration of all subscriptions at the Publisher. | |
| IncludePullSubscriptions | Specifies that the script includes all pull subscriptions. | |
| IncludeRegisteredSubscribers | Specifies that the script includes the registration of all Subscribers at the Publisher. | |
| IncludeReplicationJobs | Specifies that the script includes the definition of all SQL Server Agent jobs created by replication. | |
| IncludeSubscriberSideSubscriptions | ||
| IncludeUninstallDistributor | Specifies that the script uninstalls publishing objects at the Distributor. | |
| InstallDistributor | Specifies a creation script that installs publishing objects at the Distributor. | |
| None | Clears all scripting options. | |
| UninstallDistributor | Specifies a deletion script that uninstalls publishing objects at the Distributor. |
Remarks
The ScriptOptions enumeration supports the FlagsAttribute option which allows bitwise combination of enumeration values.