TransArticle-Klasse

Represents an article in a transactional publication.

Vererbungshierarchie

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

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

Syntax

'Declaration
Public NotInheritable Class TransArticle _
    Inherits Article
'Usage
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

Der TransArticle-Typ macht folgende Elemente verfügbar.

Konstruktoren

	Name	Beschreibung
	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.

Zum Anfang

Eigenschaften

	Name	Beschreibung
	ArticleId	Gets the article ID value. (Geerbt von 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. (Geerbt von 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. (Geerbt von 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. (Geerbt von Article.)
	DatabaseName	Gets or sets the name of the database that contains the data and the objects that are published in the article. (Geerbt von 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. (Geerbt von Article.)
	DestinationObjectName	Gets or sets the database object that is the source database object for the article at the Subscriber. (Geerbt von Article.)
	DestinationObjectOwner	Gets or sets the schema owner of the source database object for the article at the Subscriber. (Geerbt von 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. (Geerbt von 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. (Geerbt von Article.)
	InsertCommand	Gets or sets the command used to replicate inserts.
	IsExistingObject	Gets whether the object exists on the server or not. (Geerbt von ReplicationObject.)
	Name	Gets or sets the name of the article. (Geerbt von Article.)
	PreCreationMethod	Gets or sets the action to take when the published object already exists in the subscription database. (Geerbt von Article.)
	PublicationName	Gets or sets the name of the publication to which the article belongs. (Geerbt von 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. (Geerbt von 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. (Geerbt von 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. (Geerbt von Article.)
	SourceObjectOwner	Gets or sets the owner of the database object that is being published. (Geerbt von Article.)
	SqlServerName	Gets the name of the Microsoft SQL Server instance to which this object is connected. (Geerbt von 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. (Geerbt von Article.)
	Type	Gets or sets the type of article. (Geerbt von 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. (Geerbt von ReplicationObject.)
	VerticalPartition	Gets a value that indicates whether all columns are published in a table article. (Geerbt von Article.)

Zum Anfang

Methoden

	Name	Beschreibung
	AddReplicatedColumns	Includes columns in a vertically partitioned table article.
	CommitPropertyChanges	Sends all the cached property change statements to the instance of Microsoft SQL Server. (Geerbt von 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. (Geerbt von Article.)
	Decouple	Decouples the referenced replication object from the server. (Geerbt von ReplicationObject.)
	EnumHeterogeneousColumns	Returns column information for a table article published by a non-SQL Server Publisher.
	Equals	(Geerbt von Object.)
	GetHashCode	(Geerbt von Object.)
	GetType	(Geerbt von Object.)
	ListReplicatedColumns	Returns the published columns in a table article.
	Load	Loads the properties of an existing object from the server. (Geerbt von ReplicationObject.)
	LoadProperties	Loads the properties of an existing object from the server. (Geerbt von ReplicationObject.)
	Refresh	Reloads the properties of the object. (Geerbt von 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. (Geerbt von 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. (Geerbt von 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	(Geerbt von Object.)

Zum Anfang

Hinweise

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.

Beispiele

           // 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

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Replication-Namespace

Andere Ressourcen

Vorgehensweise: Definieren eines Artikels (RMO-Programmierung)