Export (0) Print
Expand All

SqlDeployTask Class

MSBuild task associated with deploy target in Microsoft.Data.Tools.Schema.SqlTasks.targets

Namespace:  Microsoft.Data.Tools.Schema.Tasks.Sql
Assembly:  Microsoft.Data.Tools.Schema.Tasks.Sql.10 (in Microsoft.Data.Tools.Schema.Tasks.Sql.10.dll)

public class SqlDeployTask : SqlDeploymentTask

The SqlDeployTask type exposes the following members.

  NameDescription
Public methodSqlDeployTaskInitializes a new instance of the SqlDeployTask class.
Top

  NameDescription
Public propertyAllowDropBlockingAssembliesThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether SqlClr publishing drops blocking assemblies as part of the deployment plan. By default, any blocking or referencing assemblies block an assembly update if the referencing assembly must be dropped.
Public propertyAllowIncompatiblePlatformThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish action should go forward despite potentially incompatible SQL Server platforms.
Public propertyBackupDatabaseBeforeChangesThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the task backups the database before deploying any changes.
Public propertyBlockOnPossibleDataLossThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish episode is terminated if the publish operation might cause data loss.
Public propertyBlockWhenDriftDetectedThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to block updating a database whose schema no longer matches its registration or is unregistered.
Public propertyBuildEngine (Inherited from Task.)
Public propertyBuildEngine2 (Inherited from Task.)
Public propertyBuildEngine3 (Inherited from Task.)
Public property (Inherited from Task.)
Public propertyCacheTargetModelThis class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)
Public propertyCommentOutSetVarDeclarationsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether SETVAR variable declarations are commented out in the generated publish script. You might choose to do this if you plan to use a tool such as SQLCMD.EXE to specify the values on the command line when you publish.
Public propertyCompareUsingTargetCollationThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the setting dictates how the database's collation is handled during deployment; by default the target database's collation will be updated if it does not match the collation specified by the source. When this option is set, the target database's (or server's) collation should be used
Public propertyConnectionStringThis class supports the product infrastructure and is not intended to be used directly from your code.Gets or sets a connection string.
Public propertyContributorArgumentsA set of name value pairs provided to customize deployment extensions. (Inherited from SqlDeploymentTask.)
Public propertyCreateNewDatabaseThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the target database should be updated or whether it should be dropped and re-created when you publish to a database.
Public propertyDatabaseNameThis class supports the product infrastructure and is not intended to be used directly from your code.Gets or sets the database name.
Public propertyDeployDatabaseInSingleUserModeThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the database is set to Single User Mode before deploying.
Public propertyDisableAndReenableDdlTriggersThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether Data Definition Language (DDL) triggers are disabled at the beginning of the publish process and re-enabled at the end of the publish action.
Public propertyDoNotAlterChangeDataCaptureObjectsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether Change Data Capture objects are not altered.
Public propertyDoNotAlterReplicatedObjectsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether objects that are replicated are identified during verification.
Public propertyDropConstraintsNotInSourceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish action drops constraints that do not exist in the database snapshot (.dacpac) from the target database when you publish to a database.
Public propertyDropDmlTriggersNotInSourceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish action drops Data Manipulation Language (DML) triggers that do not exist in the database snapshot (.dacpac) from the target database when you publish to a database.
Public propertyDropExtendedPropertiesNotInSourceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish action drops extended properties that do not exist in the database snapshot (.dacpac) from the target database when you publish to a database.
Public propertyDropIndexesNotInSourceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish action drops indexes that do not exist in the database snapshot (.dacpac) from the target database when you publish to a database.
Public propertyDropObjectsNotInSourceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether objects that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database.
Public propertyDropPermissionsNotInSourceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish action permissions that do not exist in the database snapshot (.dacpac) from the target database when you publish to a database.
Public propertyDropRoleMembersNotInSourceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the publish action drops role members that do not exist in the database snapshot (.dacpac) from the target database when you publish to a database.
Public propertyGenerateSmartDefaultsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether SqlPackage.exe provides a default value automatically when it updates a table that contains data with a column that does not allow null values.
Protected propertyHelpKeywordPrefix (Inherited from Task.)
Public propertyHostObject (Inherited from Task.)
Public propertyIgnoreAnsiNullsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the ANSI NULLS setting when you publish to a database.
Public propertyIgnoreAuthorizerThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the Authorizer when you publish to a database.
Public propertyIgnoreColumnCollationThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in column collation when you publish to a database.
Public propertyIgnoreCommentsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in comments order when you publish to a database.
Public propertyIgnoreCryptographicProviderFilePathThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the file path for a cryptographic provider when you publish to a database.
Public propertyIgnoreDdlTriggerOrderThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the order of Data Definition Language (DDL) triggers when you publish to a database.
Public propertyIgnoreDdlTriggerStateThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the enabled or disabled state of DDL triggers when you publish to a database.
Public propertyIgnoreDefaultSchemaThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the default schema when you publish to a database.
Public propertyIgnoreDmlTriggerOrderThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the order of DML triggers when you publish to a database.
Public propertyIgnoreDmlTriggerStateThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the enabled or disabled state of DML triggers when you publish to a database.
Public propertyIgnoreExtendedPropertiesThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in extended properties when you publish to a database.
Public propertyIgnoreFileAndLogFilePathThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the paths for files and log files when you publish to a database.
Public propertyIgnoreFilegroupPlacementThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the placement of FILEGROUP s when you publish to a database.
Public propertyIgnoreFileSizeThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in file sizes when you publish to a database.
Public propertyIgnoreFillFactorThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in fill factors when you publish to a database.
Public propertyIgnoreFullTextCatalogFilePathThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the path to full-text index files when you publish to a database.
Public propertyIgnoreIdentitySeedThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the seed for an identity column when you publish to a database.
Public propertyIgnoreIncrementThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the increment for an identity column when you publish to a database.
Public propertyIgnoreIndexOptionsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the index options when you publish to a database.
Public propertyIgnoreIndexPaddingThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the index padding when you publish to a database.
Public propertyIgnoreKeywordCasingThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the keyword casing when you publish to a database.
Public propertyIgnoreLockHintsOnIndexesThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the lock hints on indexes when you publish to a database.
Public propertyIgnoreLoginSidsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the security identifier (SID) when you publish to a database.
Public propertyIgnoreNotForReplicationThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update the not-for-replication setting when you publish to a database.
Public propertyIgnoreObjectPlacementOnPartitionSchemeThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update an object’s placement on a partition scheme when you publish to a database.
Public propertyIgnorePartitionSchemesThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in partition schemes and functions when you publish to a database.
Public propertyIgnorePermissionsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in permissions when you publish to a database.
Public propertyIgnoreQuotedIdentifiersThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in quoted identifier settings when you publish to a database.
Public propertyIgnoreRoleMembershipThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether differences in the role membership of logins should be ignored or updated when you publish to a database.
Public propertyIgnoreRouteLifetimeThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the role memberships of logins when you publish to a database.
Public propertyIgnoreSemicolonBetweenStatementsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in semicolons between Transact-SQL statements when you publish to a database.
Public propertyIgnoreTableOptionsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in table options when you publish to a database.
Public propertyIgnoreUserSettingsObjectsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in user setting options when you publish to a database.
Public propertyIgnoreWhitespaceThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in whitespace when you publish to a database.
Public propertyIgnoreWithNocheckOnCheckConstraintsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the value of the WITH NOCHECK clause for check constraints when you publish to a database.
Public propertyIgnoreWithNocheckOnForeignKeysThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in the value of the WITH NOCHECK clause for foreign keys when you publish to a database.
Public propertyIncludeCompositeObjectsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to include all composite elements as part of a single publish operation.
Public propertyIncludeTransactionalScriptsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to use transactional statements wherever possible when you publish to a database.
Protected propertyIsCanceledReturns true if the task was canceled. This class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from DataTask.)
Public propertyLog (Inherited from Task.)
Public propertyNoAlterStatementsToChangeCLRTypesThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies that publish should always drop and re-create an assembly if there is a difference instead of issuing an ALTER ASSEMBLY statement.
Public propertyPopulateFilesOnFileGroupsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether a new file is also created when you create a new FileGroup in the target database.
Public propertyRegisterDataTierApplicationThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether the schema is registered with the database server.
Public propertyScriptDatabaseCollationThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in database collation when you publish to a database.
Public propertyScriptDatabaseCompatibilityThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to ignore or update differences in database compatibility when you publish to a database.
Public propertyScriptDatabaseOptionsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to set or update target database properties when you publish to a database.
Public propertyScriptDeployStateChecksThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to generate statements in the publish script to verify that the database and server names match the names specified in the database project.
Public propertyScriptFileThis class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)
Public propertyScriptFileSizeThis class supports the product infrastructure and is not intended to be used directly from your code.Controls whether size is specified when adding a file to a filegroup.
Public propertyScriptNewConstraintValidationThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to verify all constraints as one set at the end of publishing, avoiding data errors caused by a check or foreign key constraint in the middle of the publish action. If this option is False , constraints are published without checking the corresponding data.
Public propertyScriptRefreshModuleThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to include refresh statements at the end of the publish script.
Public propertySourceModelThis class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)
Public propertySqlCommandVariableOverridesThis class supports the product infrastructure and is not intended to be used directly from your code.Gets or sets an array of command variable override tasks.
Public propertyTargetDatabaseNameThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies the name of the target database.
Protected propertyTaskResources (Inherited from Task.)
Public propertyTreatVerificationErrorsAsWarningsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to treat errors that occur during publish verification as warnings. The check is performed against the generated deployment plan before the plan is executed against the target database. Plan verification detects problems, such as the loss of target-only objects (for example, indexes), that must be dropped to make a change. Verification also detects situations where dependencies (such as tables or views) exist because of a reference to a composite project, but do not exist in the target database. You might choose to treat verification errors as warnings to get a complete list of issues instead of allowing the publish action to stop when the first error occurs.
Public propertyUnmodifiableObjectWarningsThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to generate warnings when differences are found in objects that cannot be modified (for example, if the file size or file paths are different for a file).
Public propertyUpdateDatabaseThis class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)
Public propertyVerifyCollationCompatibilityThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether collation compatibility is verified.
Public propertyVerifyDeploymentThis class supports the product infrastructure and is not intended to be used directly from your code.Specifies whether to perform checks before publishing that stop the publish action if issues are present that might block successful publishing. For example, your publish action might stop if you get errors during publishing because foreign keys on the target database do not exist in the database project.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodExecute Executes design-time deployment. (Overrides DataTask.Execute().)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Protected eventCanceledThis class supports the product infrastructure and is not intended to be used directly from your code.Raised when the event is canceled. (Inherited from DataTask.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICancelableTask.CancelThis class supports the product infrastructure and is not intended to be used directly from your code.Cancels the active operation. (Inherited from DataTask.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft