• Article

ReplicationTable.ReplicationAddColumn Method

Adds a column to a table that is already published in one or more publications.

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

Syntax

'Declaration
Public Sub ReplicationAddColumn ( _
    columnName As String, _
    typeText As String, _
    addType As AddColumnOption, _
    publicationNames As String(), _
    schemaChangeScript As String _
)
'Usage
Dim instance As ReplicationTable
Dim columnName As String
Dim typeText As String
Dim addType As AddColumnOption
Dim publicationNames As String()
Dim schemaChangeScript As String

instance.ReplicationAddColumn(columnName, _
    typeText, addType, publicationNames, _
    schemaChangeScript)

public void ReplicationAddColumn(
    string columnName,
    string typeText,
    AddColumnOption addType,
    string[] publicationNames,
    string schemaChangeScript
)

public:
void ReplicationAddColumn(
    String^ columnName, 
    String^ typeText, 
    AddColumnOption addType, 
    array<String^>^ publicationNames, 
    String^ schemaChangeScript
)

member ReplicationAddColumn : 
        columnName:string * 
        typeText:string * 
        addType:AddColumnOption * 
        publicationNames:string[] * 
        schemaChangeScript:string -> unit 

public function ReplicationAddColumn(
    columnName : String, 
    typeText : String, 
    addType : AddColumnOption, 
    publicationNames : String[], 
    schemaChangeScript : String
)

Parameters

  • columnName
    Type: System.String
    A String value that specifies the name of the column to be added.
  • typeText
    Type: System.String
    A String value that contains the syntax that follows the column_name parameter in the ALTER TABLE statement in Transact-SQL.
  • publicationNames
    Type: array<System.String[]
    A String array that contains the names of publications to which the column is to be included. This parameter is used only when addType is Some.
  • schemaChangeScript
    Type: System.String
    An optional String value that specifies a schema change script to propagate to the Subscriber. This is only valid for transactional and snapshot publications. Use nulla null reference (Nothing in Visual Basic) or empty string if you do not want to specify this parameter.

Remarks

This method is supported for backward compatibility. Use schema change replication when adding columns to or removing columns from a published table. For more information, see Making Schema Changes on Publication Databases.

The ReplicationAddColumn method can only be called by members of the sysadmin fixed server role at the Publisher of by members of the db_owner fixed database role on the publication database.

Calling ReplicationAddColumn is equivalent to executing sp_repladdcolumn (Transact-SQL).

This method is available on instances of SQL Server 2000 and SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.