TransArticle 类

Represents an article in a transactional publication.

继承层次结构

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

命名空间:  Microsoft.SqlServer.Replication
程序集:  Microsoft.SqlServer.Rmo(在 Microsoft.SqlServer.Rmo.dll 中)

语法

声明
Public NotInheritable Class TransArticle _
    Inherits Article
用法
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

TransArticle 类型公开以下成员。

构造函数

  名称 说明
公共方法 TransArticle() () () () Creates a new instance of the TransArticle class.
公共方法 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.

页首

属性

  名称 说明
公共属性 ArticleId Gets the article ID value. (从 Article 继承。)
公共属性 ArticleLogTablespace Gets or sets the name of the Oracle tablespace used to store replication log information.
公共属性 CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (从 ReplicationObject 继承。)
公共属性 CommandFormat Gets or sets how changes are propagated for the article.
公共属性 ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (从 ReplicationObject 继承。)
受保护属性 CreateArticleAsHeterogeneous (从 Article 继承。)
公共属性 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. (从 Article 继承。)
公共属性 DatabaseName Gets or sets the name of the database that contains the data and the objects that are published in the article. (从 Article 继承。)
公共属性 DatatypeMappingOptions Returns whether the default article data type mapping is used for a non-SQL Server Publisher.
公共属性 DeleteCommand Gets or sets the command used to replicate deletes.
公共属性 Description Gets or sets a textual description of the article. (从 Article 继承。)
公共属性 DestinationObjectName Gets or sets the database object that is the source database object for the article at the Subscriber. (从 Article 继承。)
公共属性 DestinationObjectOwner Gets or sets the schema owner of the source database object for the article at the Subscriber. (从 Article 继承。)
公共属性 FilterClause Gets or sets the WHERE clause used to filter the article horizontally.
公共属性 FilterProcName Gets or sets the stored procedure (created with FOR REPLICATION) used to filter the table horizontally.
公共属性 FilterProcOwner Gets or sets the database user who owns the stored procedure that is used to horizontally partition a table-based article.
公共属性 IdentityRangeManagementOption Gets or sets the identity range management options for the article. (从 Article 继承。)
公共属性 IdentityRangeThreshold Gets or sets the value at which a new range of identity column values are assigned to a Publisher or to a Subscriber. (从 Article 继承。)
公共属性 InsertCommand Gets or sets the command used to replicate inserts.
公共属性 IsExistingObject Gets whether the object exists on the server or not. (从 ReplicationObject 继承。)
公共属性 Name Gets or sets the name of the article. (从 Article 继承。)
公共属性 PreCreationMethod Gets or sets the action to take when the published object already exists in the subscription database. (从 Article 继承。)
公共属性 PublicationName Gets or sets the name of the publication to which the article belongs. (从 Article 继承。)
公共属性 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. (从 Article 继承。)
公共属性 PublisherName Gets or sets the name of the non-SQL Server Publisher that publishes the article.
公共属性 SchemaOption Gets or sets the schema creation options for an article. (从 Article 继承。)
公共属性 SnapshotObjectName Gets or sets the database object that provides the initial data snapshot for the article.
公共属性 SnapshotObjectOwner Gets or sets the owner of the database object that provides the initial data snapshot for the article.
公共属性 SourceObjectName Gets or sets the name of the database object that is being published. (从 Article 继承。)
公共属性 SourceObjectOwner Gets or sets the owner of the database object that is being published. (从 Article 继承。)
公共属性 SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (从 ReplicationObject 继承。)
公共属性 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. (从 Article 继承。)
公共属性 Type Gets or sets the type of article. (从 Article 继承。)
公共属性 UpdateCommand Gets or sets the command used to replicate updates.
公共属性 UserData Gets or sets an object property that allows users to attach their own data to the object. (从 ReplicationObject 继承。)
公共属性 VerticalPartition Specifies whether all columns are published in a table article. (从 Article 继承。)

页首

方法

  名称 说明
公共方法 AddReplicatedColumns Includes columns in a vertically partitioned table article.
受保护方法 CheckValidCreation 基础结构。 (从 Article 继承。)
受保护方法 CheckValidDefinition 基础结构。 (从 Article 继承。)
公共方法 CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (从 ReplicationObject 继承。)
公共方法 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. (从 Article 继承。)
公共方法 Decouple Decouples the referenced replication object from the server. (从 ReplicationObject 继承。)
公共方法 EnumHeterogeneousColumns Returns column information for a table article published by a non-SQL Server Publisher.
公共方法 Equals (从 Object 继承。)
受保护方法 Finalize (从 Object 继承。)
受保护方法 GetChangeCommand 基础结构。 (从 ReplicationObject 继承。)
受保护方法 GetCreateCommand 基础结构。 (从 ReplicationObject 继承。)
受保护方法 GetDropCommand 基础结构。 (从 ReplicationObject 继承。)
公共方法 GetHashCode (从 Object 继承。)
公共方法 GetType (从 Object 继承。)
受保护方法 InternalRefresh 基础结构。 (从 ReplicationObject 继承。)
公共方法 ListReplicatedColumns Returns the published columns in a table article.
公共方法 Load Loads the properties of an existing object from the server. (从 ReplicationObject 继承。)
公共方法 LoadProperties Loads the properties of an existing object from the server. (从 ReplicationObject 继承。)
受保护方法 MemberwiseClone (从 Object 继承。)
公共方法 Refresh Reloads the properties of the object. (从 ReplicationObject 继承。)
公共方法 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. (从 Article 继承。)
公共方法 RemoveReplicatedColumns Excludes columns from a vertically partitioned table article.
公共方法 Script Generates a Transact-SQL script that can be executed to create or delete the TransArticle object or the MergeArticle object on the server. (从 Article 继承。)
公共方法 ScriptChangeColumnDestinationDataType Returns a Transact-SQL script used to change the column data type mapping for a non-SQL Server Publisher. 
公共方法 SetColumnDestinationDataType Sets the column data type mapping for a non-SQL Server Publisher.
公共方法 ToString (从 Object 继承。)

页首

注释

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.

示例

            // Define the Publisher, publication, and article names.
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks";
            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 = "AdventureWorks"
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

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。