Partager via


Classe TransPublication

Represents a transactional publication.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Replication
Assembly :  Microsoft.SqlServer.Rmo (en Microsoft.SqlServer.Rmo.dll)

Syntaxe

'Déclaration
Public NotInheritable Class TransPublication _
    Inherits Publication
'Utilisation
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

Le type TransPublication expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique TransPublication() () () () Creates a new instance of the TransPublication class.
Méthode publique TransPublication(String, String, ServerConnection) Creates a new instance of the TransPublication class with the required properties.
Méthode publique 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.

Haut de la page

Propriétés

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

Haut de la page

Méthodes

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

Haut de la page

Notes

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.

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.