InsertCommand Property

SQL-DMO

Syntax

object.InsertCommand [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

String containing a Transact-SQL script

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetInsertCommand(SQLDMO_LPBSTR pRetVal);

HRESULT SetInsertCommand(SQLDMO_LPCSTR NewValue);

Note  SQL-DMO strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

The format and contents of the InsertCommand property must match those specified for the @ins_cmd argument of the system stored procedure sp_article. For more information, see sp_addarticle.

For each row added to the published table, a Transact-SQL INSERT statement is built. When InsertCommand is an empty string, or the string SQL, the default behavior is used.

Set InsertCommand to NONE to specify that the publication ignore records added to the published table.

Set InsertCommand to CALL procedure to specify a Transact-SQL stored procedure executed for record insertion. The stored procedure must include parameters referencing, in order, the columns published in the article, and each Subscriber must have a copy of the stored procedure installed in the destination database.

Note  If an application sets InsertCommand after the initial snapshot has been created, a new snapshot must be generated and reapplied to each subscription. Snapshots are applied when the next scheduled snapshot and distribution agent run.