ReplicationTable.ReplicationAddColumn Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Adds a column to a table that is already published in one or more publications.
public:
void ReplicationAddColumn(System::String ^ columnName, System::String ^ typeText, Microsoft::SqlServer::Replication::AddColumnOption addType, cli::array <System::String ^> ^ publicationNames, System::String ^ schemaChangeScript);
public void ReplicationAddColumn (string columnName, string typeText, Microsoft.SqlServer.Replication.AddColumnOption addType, string[] publicationNames, string schemaChangeScript);
member this.ReplicationAddColumn : string * string * Microsoft.SqlServer.Replication.AddColumnOption * string[] * string -> unit
Public Sub ReplicationAddColumn (columnName As String, typeText As String, addType As AddColumnOption, publicationNames As String(), schemaChangeScript As String)
Parameters
- columnName
- String
The name of the column to be added.
- typeText
- String
The syntax that follows the column_name
parameter in the ALTER TABLE statement in Transact-SQL.
- addType
- AddColumnOption
An AddColumnOption object value that specifies whether to include the column in some, all, or no publications. If Some is specified, the publicationNames
parameter cannot be empty.
- publicationNames
- 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
- String
A schema change script to propagate to the Subscriber. This is only valid for transactional and snapshot publications. Use null
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 Make 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).