SqlScript Element (Sql Extension)

WiX Toolset

SqlScript Element (Sql Extension)

Description
SQL Script
Windows Installer references
None
Parents
Component, SqlDatabase
Inner Text
None
Children
None
Attributes
Name Type Description Required
Id String   Yes
BinaryKey String Reference to Binary stream that contains the SQL script to execute. Yes
ContinueOnError YesNoType Continue executing scripts even if this one fails.  
ExecuteOnInstall YesNoType Specifies to execute the script when the associated component is installed. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.  
ExecuteOnReinstall YesNoType Specifies whether to execute the script when the associated component is reinstalled. Setting ExecuteOnInstall to yes does not imply ExecuteOnReinstall is set to yes. ExecuteOnReinstall must be set in addition to ExecuteOnInstall for it to be executed during both install and reinstall. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.  
ExecuteOnUninstall YesNoType Specifies to execute the script when the associated component is uninstalled. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.  
RollbackOnInstall YesNoType Specifies whether to execute the script on rollback if an attempt is made to install the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.  
RollbackOnReinstall YesNoType Specifies whether to execute the script on rollback if an attempt is made to reinstall the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.  
RollbackOnUninstall YesNoType Specifies whether to execute the script on rollback if an attempt is made to uninstall the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.  
Sequence Integer Specifes the order to run the SQL Scripts. It is recommended that rollback scripts be scheduled before their complementary execution script. This order is also relative across the SqlString element.  
SqlDb String required when not child of SqlDatabase  
User String    
See Also
Sql Schema