Share via

  • Article

IncludeDB Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The IncludeDB property specifies whether to create a database on the destination server during a data transfer operation.

Syntax

object.IncludeDB [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    TRUE or FALSE

Data Type

Boolean

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetIncludeDB( LPBOOL pRetVal);
HRESULT SetIncludeDB(BOOL NewValue);

Remarks

With the IncludeDB property set to TRUE, a database does not need to exist at a destination server before database objects can be copied during a transfer operation. The IncludeDB property generates a destination database creation statement at the beginning of script execution during a transfer operation.

The default is FALSE.

Applies To:

Transfer2 Object