• Article

TransPublication Class

Represents a transactional publication.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Publication
      Microsoft.SqlServer.Replication.TransPublication

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

Syntax

'Declaration
Public NotInheritable Class TransPublication _
    Inherits Publication
'Usage
Dim instance As TransPublication

public sealed class TransPublication : Publication

public ref class TransPublication sealed : public Publication

[<SealedAttribute>]
type TransPublication =  
    class
        inherit Publication
    end

public final class TransPublication extends Publication

The TransPublication type exposes the following members.

Constructors

  Name Description
Public method TransPublication() Creates a new instance of the TransPublication class.
Public method TransPublication(String, String, ServerConnection) Creates a new instance of the TransPublication class with the required properties.
Public method TransPublication(String, String, ServerConnection, Boolean) Creates a new instance of the TransPublication class with the required properties, and indicates whether the Snapshot Agent job for the publication is created.

Top

Properties

  Name Description
Public property AltSnapshotFolder Gets or sets the alternate snapshot file location for a publication. (Inherited from Publication.)
Public property Attributes Gets or sets the publication attributes. (Inherited from Publication.)
Public property CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public property CompatibilityLevel Gets or sets the earliest version of Microsoft SQL Server running on the Subscribers that the referenced publication can support. (Inherited from Publication.)
Public property ConflictPolicy Gets or sets the conflict policy for publications that support updating subscriptions.
Public property ConflictRetention Gets or sets the number of days that conflict data rows are retained in conflict tables. (Inherited from Publication.)
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property ContinueOnConflict Determines whether the Distribution Agent continues to process changes after a conflict is detected.
Public property CreateSnapshotAgentByDefault Gets or sets if the Snapshot Agent job is added automatically when the publication is created. (Inherited from Publication.)
Public property DatabaseName Gets or sets the name of the publication database. (Inherited from Publication.)
Public property Description Gets or sets a textual description of the publication. (Inherited from Publication.)
Public property FtpAddress Gets or sets the address of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpLogin Gets or sets the login that is used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpPassword Sets the password for the login that is used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpPort Gets or sets the port of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpSubdirectory Gets or sets the subdirectory on the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property HasSubscription Gets whether the publication has one or more subscriptions. (Inherited from Publication.)
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property Name Gets or sets the name of the publication. (Inherited from Publication.)
Public property PeerConflictDetectionEnabled Gets whether peer-to-peer conflict detection was enabled by using SetPeerConflictDetection.
Public property PeerOriginatorID Gets the ID for a node in a peer-to-peer topology; this ID is used for conflict detection if PeerConflictDetectionEnabled is set to true.
Public property PostSnapshotScript Gets or sets the name and full path of a Transact-SQL script file that is executed after the initial snapshot is applied to the Subscriber. (Inherited from Publication.)
Public property PreSnapshotScript Gets or sets the name and full path of a Transact-SQL script file that is executed before the initial snapshot is applied to the Subscriber. (Inherited from Publication.)
Public property PubId Gets the value that uniquely identifies the publication. (Inherited from Publication.)
Public property PublisherName Gets or sets the name of the non-SQL Server Publisher.
Public property QueueType Gets or sets the type of queue to use for publications that allow queued updating subscriptions.
Public property ReplicateDdl Gets or sets the data definition language (DDL) replication options that determine if DDL changes are replicated. (Inherited from Publication.)
Public property RetentionPeriod Gets or sets the amount of time before a subscription expires when the subscription is not synchronized with the publication. (Inherited from Publication.)
Public property SecureFtpPassword Sets the password (as a SecureString object) for the login used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property SnapshotAgentExists Gets if the SQL Server Agent job exists to generate the initial snapshot for this publication. (Inherited from Publication.)
Public property SnapshotAvailable Gets whether or not the snapshot files for this publication are available for use.
Public property SnapshotGenerationAgentProcessSecurity Gets an object that sets the Windows account under which the Snapshot Agent job runs. (Inherited from Publication.)
Public property SnapshotGenerationAgentPublisherSecurity Gets the security context used by the Snapshot Agent to connect to the Publisher. (Inherited from Publication.)
Public property SnapshotJobId Gets the Snapshot Agent job ID for the current publication. (Inherited from Publication.)
Public property SnapshotMethod Gets or sets the data file format of the initial snapshot. (Inherited from Publication.)
Public property SnapshotSchedule Gets an object that sets the schedule for the Snapshot Agent for the current publication. (Inherited from Publication.)
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property Status Gets or sets the status of the publication. (Inherited from Publication.)
Public property TransArticles Represents the articles in the publication.
Public property TransSubscriptions Represents subscriptions to the publication.
Public property Type Gets or sets the type of publication. (Inherited from Publication.)
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

Top

Methods

  Name Description
Public method BrowseSnapshotFolder Returns the complete path of the location where snapshot files were generated for a specific subscription.
Protected method CheckValidCreation Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition Infrastructure. (Inherited from Publication.)
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method CopySnapshot Copies the latest snapshot files for a specific subscription to a destination folder.
Public method Create Creates the publication. (Inherited from Publication.)
Public method CreateSnapshotAgent Creates the SQL Server Agent job that is used to generate the initial snapshot for the publication, if this job does not already exist. (Inherited from Publication.)
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method EnumArticles Returns the articles in the publication. (Inherited from Publication.)
Public method EnumPublicationAccesses Returns logins that have access to the Publisher. (Inherited from Publication.)
Public method EnumSubscriptions Returns the subscriptions that subscribe to the publication. (Inherited from Publication.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method GrantPublicationAccess Adds the specified login to the publication access list (PAL). (Inherited from Publication.)
Protected method InternalRefresh Infrastructure. (Inherited from ReplicationObject.)
Public method Load Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method LoadProperties Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method MakePullSubscriptionWellKnown Registers a pull subscription at the Publisher.
Protected method MemberwiseClone (Inherited from Object.)
Public method PostTracerToken Posts a tracer token into the Publisher log to begin the process of determining latency.
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method RefreshSubscriptions Updates all subscriptions to a publication to include any newly added articles.
Public method ReinitializeAllSubscriptions() Marks all subscriptions to the publication for reinitialization.
Public method ReinitializeAllSubscriptions(Boolean) Marks all subscriptions to the publication for reinitialization, with the option to invalidate an existing snapshot.
Public method Remove() Removes an existing publication. (Inherited from Publication.)
Public method Remove(Boolean) Removes an existing publication even if the Distributor cannot be accessed. (Inherited from Publication.)
Public method RemovePullSubscription Removes the registration for a pull subscription at the Publisher.
Public method ReplicateUserDefinedScript Replicates the execution of a user-defined script to the Subscribers of a specified publication. (Inherited from Publication.)
Public method RevokePublicationAccess Removes the specified login from the publication access list (PAL). (Inherited from Publication.)
Public method Script Generates a Transact-SQL script that can be used to re-create the publication as specified by the script options. (Inherited from Publication.)
Public method SetPeerConflictDetection Enables or disables conflict detection for a node in a peer-to-peer topology.
Public method StartSnapshotGenerationAgentJob Starts the job that generates the initial snapshot for the publication. (Inherited from Publication.)
Public method StopSnapshotGenerationAgentJob Attempts to stop a running Snapshot Agent job. (Inherited from Publication.)
Public method ToString (Inherited from Object.)
Public method ValidatePublication Invokes inline publication validation for all subscriptions.
Public method ValidateSubscriptions Invokes inline publication validation for the specified subscription.

Top

Remarks

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

Thread Safety

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

Examples

This example creates a transactional publication.

           // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2008R2";
            string publisherName = publisherInstance;

            ReplicationDatabase publicationDb;
            TransPublication publication;

            // Create a connection to the Publisher using Windows Authentication.
            ServerConnection conn;
            conn = new ServerConnection(publisherName);


            try
            {
                // Connect to the Publisher.
                conn.Connect();

                // Enable the AdventureWorks database for transactional publishing.
                publicationDb = new ReplicationDatabase(publicationDbName, conn);

                // If the database exists and is not already enabled, 
                // enable it for transactional publishing.
                if (publicationDb.LoadProperties())
                {
                    if (!publicationDb.EnabledTransPublishing)
                    {
                        publicationDb.EnabledTransPublishing = true;
                    }

                    // If the Log Reader Agent does not exist, create it.
                    if (!publicationDb.LogReaderAgentExists)
                    {
                        // Specify the Windows account under which the agent job runs.
                        // This account will be used for the local connection to the 
                        // Distributor and all agent connections that use Windows Authentication.
                        publicationDb.LogReaderAgentProcessSecurity.Login = winLogin;
                        publicationDb.LogReaderAgentProcessSecurity.Password = winPassword;

                        // Explicitly set authentication mode for the Publisher connection
                        // to the default value of Windows Authentication.
                        publicationDb.LogReaderAgentPublisherSecurity.WindowsAuthentication = true;

                        // Create the Log Reader Agent job.
                        publicationDb.CreateLogReaderAgent();
                    }
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "The {0} database does not exist at {1}.",
                        publicationDb, publisherName));
                }

                // Set the required properties for the transactional publication.
                publication = new TransPublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;

                // Specify a transactional publication (the default).
                publication.Type = PublicationType.Transactional;

                // Activate the publication so that we can add subscriptions.
                publication.Status = State.Active;

                // Enable push and pull subscriptions and independent Distribition Agents.
                publication.Attributes |= PublicationAttributes.AllowPull;
                publication.Attributes |= PublicationAttributes.AllowPush;
                publication.Attributes |= PublicationAttributes.IndependentAgent;

                // Specify the Windows account under which the Snapshot Agent job runs.
                // This account will be used for the local connection to the 
                // Distributor and all agent connections that use Windows Authentication.
                publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin;
                publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword;

                // Explicitly set the security mode for the Publisher connection
                // Windows Authentication (the default).
                publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = true;

                if (!publication.IsExistingObject)
                {
                    // Create the transactional publication.
                    publication.Create();

                    // Create a Snapshot Agent job for the publication.
                    publication.CreateSnapshotAgent();
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "The {0} publication already exists.", publicationName));
                }
            }

            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "The publication {0} could not be created.", publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim publisherName As String = publisherInstance

Dim publicationDb As ReplicationDatabase
Dim publication As TransPublication

' Create a connection to the Publisher using Windows Authentication.
Dim conn As ServerConnection
conn = New ServerConnection(publisherName)

Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Enable the AdventureWorks database for transactional publishing.
    publicationDb = New ReplicationDatabase(publicationDbName, conn)

    ' If the database exists and is not already enabled, 
    ' enable it for transactional publishing.
    If publicationDb.LoadProperties() Then
        If Not publicationDb.EnabledTransPublishing Then
            publicationDb.EnabledTransPublishing = True
        End If

        ' If the Log Reader Agent does not exist, create it.
        If Not publicationDb.LogReaderAgentExists Then
            ' Specify the Windows account under which the agent job runs.
            ' This account will be used for the local connection to the 
            ' Distributor and all agent connections that use Windows Authentication.
            publicationDb.LogReaderAgentProcessSecurity.Login = winLogin
            publicationDb.LogReaderAgentProcessSecurity.Password = winPassword

            ' Explicitly set authentication mode for the Publisher connection
            ' to the default value of Windows Authentication.
            publicationDb.LogReaderAgentPublisherSecurity.WindowsAuthentication = True

            ' Create the Log Reader Agent job.
            publicationDb.CreateLogReaderAgent()
        End If
    Else
        Throw New ApplicationException(String.Format( _
         "The {0} database does not exist at {1}.", _
         publicationDb, publisherName))
    End If

    ' Set the required properties for the transactional publication.
    publication = New TransPublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' Specify a transactional publication (the default).
    publication.Type = PublicationType.Transactional

    'Enable push and pull subscriptions and independent Distribition Agents.
    publication.Attributes = _
    publication.Attributes Or PublicationAttributes.AllowPull
    publication.Attributes = _
    publication.Attributes Or PublicationAttributes.AllowPush
    publication.Attributes = _
    publication.Attributes Or PublicationAttributes.IndependentAgent

    ' Activate the publication so that we can add subscriptions.
    publication.Status = State.Active

    ' Specify the Windows account under which the Snapshot Agent job runs.
    ' This account will be used for the local connection to the 
    ' Distributor and all agent connections that use Windows Authentication.
    publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin
    publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword

    ' Explicitly set the security mode for the Publisher connection
    ' Windows Authentication (the default).
    publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = True

    If Not publication.IsExistingObject Then
        ' Create the transactional publication.
        publication.Create()

        ' Create a Snapshot Agent job for the publication.
        publication.CreateSnapshotAgent()
    Else
        Throw New ApplicationException(String.Format( _
            "The {0} publication already exists.", publicationName))
    End If
Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
        "The publication {0} could not be created.", publicationName), ex)
Finally
    conn.Disconnect()
End Try

This example deletes a transactional publication.

           // Define the Publisher, publication database, 
            // and publication names.
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2008R2";

            TransPublication publication;
            ReplicationDatabase publicationDb;

            // Create a connection to the Publisher 
            // using Windows Authentication.
            ServerConnection conn = new ServerConnection(publisherName);

            try
            {
                conn.Connect();

                // Set the required properties for the transactional publication.
                publication = new TransPublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;

                // Delete the publication, if it exists and has no subscriptions.
                if (publication.LoadProperties() && !publication.HasSubscription)
                {
                    publication.Remove();
                }
                else
                {
                    // Do something here if the publication does not exist
                    // or has subscriptions.
                    throw new ApplicationException(String.Format(
                        "The publication {0} could not be deleted. " +
                        "Ensure that the publication exists and that all " +
                        "subscriptions have been deleted.",
                        publicationName, publisherName));
                }

                // If no other transactional publications exists,
                // disable publishing on the database.
                publicationDb = new ReplicationDatabase(publicationDbName, conn);
                if (publicationDb.LoadProperties())
                {
                    if (publicationDb.TransPublications.Count == 0)
                    {
                        publicationDb.EnabledTransPublishing = false;
                    }
                }
                else
                {
                    // Do something here if the database does not exist.
                    throw new ApplicationException(String.Format(
                        "The database {0} does not exist on {1}.",
                        publicationDbName, publisherName));
                }
            }
            catch (Exception ex)
            {
                // Implement application error handling here.
                throw new ApplicationException(String.Format(
                    "The publication {0} could not be deleted.",
                    publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Define the Publisher, publication database, 
' and publication names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2008R2"

Dim publication As TransPublication
Dim publicationDb As ReplicationDatabase

' Create a connection to the Publisher 
' using Windows Authentication.
Dim conn As ServerConnection = New ServerConnection(publisherName)

Try
    conn.Connect()

    ' Set the required properties for the transactional publication.
    publication = New TransPublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' Delete the publication, if it exists and has no subscriptions.
    If publication.LoadProperties() And Not publication.HasSubscription Then
        publication.Remove()
    Else
        ' Do something here if the publication does not exist
        ' or has subscriptions.
        Throw New ApplicationException(String.Format( _
         "The publication {0} could not be deleted. " + _
         "Ensure that the publication exists and that all " + _
         "subscriptions have been deleted.", _
         publicationName, publisherName))
    End If

    ' If no other transactional publications exists,
    ' disable publishing on the database.
    publicationDb = New ReplicationDatabase(publicationDbName, conn)
    If publicationDb.LoadProperties() Then
        If publicationDb.TransPublications.Count = 0 Then
            publicationDb.EnabledTransPublishing = False
        End If
    Else
        ' Do something here if the database does not exist.
        Throw New ApplicationException(String.Format( _
         "The database {0} does not exist on {1}.", _
         publicationDbName, publisherName))
    End If
Catch ex As Exception
    ' Implement application error handling here.
    Throw New ApplicationException(String.Format( _
     "The publication {0} could not be deleted.", _
     publicationName), ex)
Finally
    conn.Disconnect()
End Try

Thread Safety

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