ScriptOptions Enum

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Replication
Assembly:
Microsoft.SqlServer.Rmo.dll

Enumerates options for generating scripts that are used to create or remove replication objects.

This enumeration supports a bitwise combination of its member values.

public enum class ScriptOptions
[System.Flags]
public enum ScriptOptions
[<System.Flags>]
type ScriptOptions = 
Public Enum ScriptOptions
Inheritance
Enum
ScriptOptions
Attributes
FlagsAttribute

Fields

Creation 1

Specifies that the generated script is for creating replication objects.
Deletion 2

Specifies that the script is for deleting a replication object.
DisableReplicationDB 524290

Specifies that the script is a deletion script that disables publishing on a database and removes any agent jobs needed for publishing.
EnableReplicationDB 262145

Specifies that the script is a creation script that enables publishing on a database and creates any agent jobs needed for publishing.
IncludeAgentProfiles 131072

Specifies that the script includes all user-defined replication agent profiles defined on the Distributor.
IncludeAll 268435196

Specifies that the script includes all possible replication objects that can exist, which is equivalent to setting all values of ScriptOptions.
IncludeArticles 4

Specifies that the script includes articles.
IncludeChangeDestinationDataTypes 256

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 33554432

Specifies that the script includes Distribution Agent jobs.
IncludeCreateLogreaderAgent 8388608

Specifies that the script includes Log Reader Agent jobs.
IncludeCreateMergeAgent 67108864

Specifies that the script includes Merge Agent jobs.
IncludeCreateQueuereaderAgent 16777216

Specifies that the script includes Queue Reader Agent jobs.
IncludeCreateSnapshotAgent 4194304

Specifies that the script includes Snapshot Agent jobs.
IncludeDisableReplicationDB 524288

Specifies that the script disables publishing on a database and removes any agent jobs needed for publishing.
IncludeDistributionPublishers 65536

Specifies that the script includes Publishers.
IncludeEnableReplicationDB 262144

Specifies that the script enables publishing on a database and creates any agent jobs needed for publishing.
IncludeGo 134217728

Specifies that the script includes the GO command at the end of a batch.
IncludeInstallDistributor 8192

Specifies that the script installs publishing objects at the Distributor.
IncludeMergeDynamicSnapshotJobs 128

Specifies that the script includes the definition of any existing partitioned snapshot jobs for merge publications with parameterized row filters.
IncludeMergeJoinFilters 64

Specifies that the script includes the definition of all join filters defined for a merge publication.
IncludeMergePartitions 1048576

Specifies that the script includes the definition of any existing partitions for merge publications with parameterized row filters.
IncludeMergePublicationActivation 2097152

Specifies that the script includes setting the status of a merge publication to active.
IncludePartialSubscriptions 32

Specifies that the script includes subscriptions to transactional publications that do not subscribe to all articles in the publication.
IncludePublicationAccesses 512

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 2048

Specifies that the script includes publications.
IncludePublisherSideSubscriptions 8

Specifies that the script includes the registration of all subscriptions at the Publisher.
IncludePullSubscriptions 4096

Specifies that the script includes all pull subscriptions.
IncludeRegisteredSubscribers 32768

Specifies that the script includes the registration of all Subscribers at the Publisher.
IncludeReplicationJobs 1024

Specifies that the script includes the definition of all SQL Server Agent jobs created by replication.
IncludeSubscriberSideSubscriptions 16

Specifies that the script includes the Subscriber side of all Subscribers at the Publisher.
IncludeUninstallDistributor 16384

Specifies that the script uninstalls publishing objects at the Distributor.
InstallDistributor 8193

Specifies a creation script that installs publishing objects at the Distributor.
None 0

Clears all scripting options.
UninstallDistributor 16386

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.

Applies to