TransArticle 類別

發行項
02/01/2013

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。)
	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	Gets a value that indicates whether all columns are published in a table article. (繼承自 Article。)

上層

方法

	名稱	說明
	AddReplicatedColumns	Includes columns in a vertically partitioned table 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。)
	GetHashCode	(繼承自 Object。)
	GetType	(繼承自 Object。)
	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。)
	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。)

上層

備註

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 = "AdventureWorks2012";
            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 = "AdventureWorks2012"
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) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。

共用方式為