• Article

ReplicationTable.ReplicationDropColumn Method

Removes a column from a table that is published in one or more publications.

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

Syntax

'Declaration
Public Sub ReplicationDropColumn ( _
    columnName As String, _
    schemaChangeScript As String _
)
'Usage
Dim instance As ReplicationTable
Dim columnName As String
Dim schemaChangeScript As String

instance.ReplicationDropColumn(columnName, _
    schemaChangeScript)

public void ReplicationDropColumn(
    string columnName,
    string schemaChangeScript
)

public:
void ReplicationDropColumn(
    String^ columnName, 
    String^ schemaChangeScript
)

member ReplicationDropColumn : 
        columnName:string * 
        schemaChangeScript:string -> unit 

public function ReplicationDropColumn(
    columnName : String, 
    schemaChangeScript : String
)

Parameters

  • columnName
    Type: System.String
    A String value that specifies the name of the column to be removed.
  • 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 ReplicationDropColumn 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 ReplicationDropColumn is equivalent to executing sp_repldropcolumn (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.