Share via


Classe TransArticle

Represents an article in a transactional publication.

Hiérarchie d'héritage

System. . :: . .Object
  Microsoft.SqlServer.Replication. . :: . .ReplicationObject
    Microsoft.SqlServer.Replication. . :: . .Article
      Microsoft.SqlServer.Replication..::..TransArticle

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

Syntaxe

'Déclaration
Public NotInheritable Class TransArticle _
    Inherits Article
'Utilisation
Dim instance As TransArticle
public sealed class TransArticle : Article
public ref class TransArticle sealed : public Article
[<SealedAttribute>]
type TransArticle =  
    class
        inherit Article
    end
public final class TransArticle extends Article

Le type TransArticle expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique TransArticle() () () () Creates a new instance of the TransArticle class.
Méthode publique TransArticle(String, String, String, ServerConnection) Creates a new instance of the TransArticle class, with the required properties and with the specified connection to the instance of Microsoft SQL Server.

Haut de la page

Propriétés

  Nom Description
Propriété publique ArticleId Gets the article ID value. (hérité de Article.)
Propriété publique ArticleLogTablespace Gets or sets the name of the Oracle tablespace used to store replication log information.
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 CommandFormat Gets or sets how changes are propagated for the article.
Propriété publique ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (hérité de ReplicationObject.)
Propriété protégée CreateArticleAsHeterogeneous (hérité de Article.)
Propriété publique CreationScript Gets or sets the name and full path of the Transact-SQL script file that is used to create the destination object at the Subscriber. (hérité de Article.)
Propriété publique DatabaseName Gets or sets the name of the database that contains the data and the objects that are published in the article. (hérité de Article.)
Propriété publique DatatypeMappingOptions Returns whether the default article data type mapping is used for a non-SQL Server Publisher.
Propriété publique DeleteCommand Gets or sets the command used to replicate deletes.
Propriété publique Description Gets or sets a textual description of the article. (hérité de Article.)
Propriété publique DestinationObjectName Gets or sets the database object that is the source database object for the article at the Subscriber. (hérité de Article.)
Propriété publique DestinationObjectOwner Gets or sets the schema owner of the source database object for the article at the Subscriber. (hérité de Article.)
Propriété publique FilterClause Gets or sets the WHERE clause used to filter the article horizontally.
Propriété publique FilterProcName Gets or sets the stored procedure (created with FOR REPLICATION) used to filter the table horizontally.
Propriété publique FilterProcOwner Gets or sets the database user who owns the stored procedure that is used to horizontally partition a table-based article.
Propriété publique IdentityRangeManagementOption Gets or sets the identity range management options for the article. (hérité de Article.)
Propriété publique IdentityRangeThreshold Gets or sets the value at which a new range of identity column values are assigned to a Publisher or to a Subscriber. (hérité de Article.)
Propriété publique InsertCommand Gets or sets the command used to replicate inserts.
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 article. (hérité de Article.)
Propriété publique PreCreationMethod Gets or sets the action to take when the published object already exists in the subscription database. (hérité de Article.)
Propriété publique PublicationName Gets or sets the name of the publication to which the article belongs. (hérité de Article.)
Propriété publique PublisherIdentityRangeSize For a TransArticle object, gets or sets the range of identity values assigned to table columns at the Publisher. For a MergeArticle object, gets or sets the range of identity values assigned to table columns at Subscribers that have server subscriptions. (hérité de Article.)
Propriété publique PublisherName Gets or sets the name of the non-SQL Server Publisher that publishes the article.
Propriété publique SchemaOption Gets or sets the schema creation options for an article. (hérité de Article.)
Propriété publique SnapshotObjectName Gets or sets the database object that provides the initial data snapshot for the article.
Propriété publique SnapshotObjectOwner Gets or sets the owner of the database object that provides the initial data snapshot for the article.
Propriété publique SourceObjectName Gets or sets the name of the database object that is being published. (hérité de Article.)
Propriété publique SourceObjectOwner Gets or sets the owner of the database object that is being published. (hérité de Article.)
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 SubscriberIdentityRangeSize Gets or sets the maximum number of new rows that can be inserted into an identity column in a table at a Subscriber before another identity range must be allocated. (hérité de Article.)
Propriété publique Type Gets or sets the type of article. (hérité de Article.)
Propriété publique UpdateCommand Gets or sets the command used to replicate updates.
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.)
Propriété publique VerticalPartition Specifies whether all columns are published in a table article. (hérité de Article.)

Haut de la page

Méthodes

  Nom Description
Méthode publique AddReplicatedColumns Includes columns in a vertically partitioned table article.
Méthode protégée CheckValidCreation Infrastructure. (hérité de Article.)
Méthode protégée CheckValidDefinition Infrastructure. (hérité de Article.)
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 Create Creates a new article on the currently connected instance of SQL Server based on the current properties of the TransArticle object or the MergeArticle object. (hérité de Article.)
Méthode publique Decouple Decouples the referenced replication object from the server. (hérité de ReplicationObject.)
Méthode publique EnumHeterogeneousColumns Returns column information for a table article published by a non-SQL Server Publisher.
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 protégée InternalRefresh Infrastructure. (hérité de ReplicationObject.)
Méthode publique ListReplicatedColumns Returns the published columns in a table article.
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 protégée MemberwiseClone (hérité de Object.)
Méthode publique Refresh Reloads the properties of the object. (hérité de ReplicationObject.)
Méthode publique Remove Removes an existing article on the currently connected instance of SQL Server based on the current properties of the TransArticle object or the MergeArticle object. (hérité de Article.)
Méthode publique RemoveReplicatedColumns Excludes columns from a vertically partitioned table article.
Méthode publique Script Generates a Transact-SQL script that can be executed to create or delete the TransArticle object or the MergeArticle object on the server. (hérité de Article.)
Méthode publique ScriptChangeColumnDestinationDataType Returns a Transact-SQL script used to change the column data type mapping for a non-SQL Server Publisher. 
Méthode publique SetColumnDestinationDataType Sets the column data type mapping for a non-SQL Server Publisher.
Méthode publique ToString (hérité de Object.)

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

          // Define the Publisher, publication, and article names.
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2008R2";
            string articleName = "Product";
            string schemaOwner = "Production";

            TransArticle article;

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

            // Create a filtered transactional articles in the following steps:
            // 1) Create the  article with a horizontal filter clause.
            // 2) Add columns to or remove columns from the article.
            try
            {
                // Connect to the Publisher.
                conn.Connect();

                // Define a horizontally filtered, log-based table article.
                article = new TransArticle();
                article.ConnectionContext = conn;
                article.Name = articleName;
                article.DatabaseName = publicationDbName;
                article.SourceObjectName = articleName;
                article.SourceObjectOwner = schemaOwner;
                article.PublicationName = publicationName;
                article.Type = ArticleOptions.LogBased;
                article.FilterClause = "DiscontinuedDate IS NULL";

                // Ensure that we create the schema owner at the Subscriber.
                article.SchemaOption |= CreationScriptOptions.Schema;

                if (!article.IsExistingObject)
                {
                    // Create the article.
                    article.Create();
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "The article {0} already exists in publication {1}.",
                        articleName, publicationName));
                }

                // Create an array of column names to remove from the article.
                String[] columns = new String[1];
                columns[0] = "DaysToManufacture";

                // Remove the column from the article.
                article.RemoveReplicatedColumns(columns);
            }
            catch (Exception ex)
            {
                // Implement appropriate error handling here.
                throw new ApplicationException("The article could not be created.", ex);
            }
            finally
            {
                conn.Disconnect();
            }
' Define the Publisher, publication, and article names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim articleName As String = "Product"
Dim schemaOwner As String = "Production"

Dim article As TransArticle

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

' Create a filtered transactional articles in the following steps:
' 1) Create the  article with a horizontal filter clause.
' 2) Add columns to or remove columns from the article.
Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Define a horizontally filtered, log-based table article.
    article = New TransArticle()
    article.ConnectionContext = conn
    article.Name = articleName
    article.DatabaseName = publicationDbName
    article.SourceObjectName = articleName
    article.SourceObjectOwner = schemaOwner
    article.PublicationName = publicationName
    article.Type = ArticleOptions.LogBased
    article.FilterClause = "DiscontinuedDate IS NULL"

    ' Ensure that we create the schema owner at the Subscriber.
    article.SchemaOption = article.SchemaOption Or _
    CreationScriptOptions.Schema

    If Not article.IsExistingObject Then
        ' Create the article.
        article.Create()
    Else
        Throw New ApplicationException(String.Format( _
         "The article {0} already exists in publication {1}.", _
         articleName, publicationName))
    End If

    ' Create an array of column names to remove from the article.
    Dim columns() As String = New String(0) {}
    columns(0) = "DaysToManufacture"

    ' Remove the column from the article.
    article.RemoveReplicatedColumns(columns)
Catch ex As Exception
    ' Implement appropriate error handling here.
    Throw New ApplicationException("The article could not be created.", 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.