Home Library Learn Samples Downloads Support Community Forums
This topic has not yet been rated - Rate this topic

SqlPublishTask Class

Represents an MSBuild task associated with publish 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)
C#
C++
F#
JScript
VB
Copy 
public sealed class SqlPublishTask : SqlDeploymentTask

The SqlPublishTask type exposes the following members.

  NameDescription
Public methodSqlPublishTaskInitializes a new instance of the SqlPublishTask class.
Top
  NameDescription
Public propertyAllowDropBlockingAssembliesSpecifies 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 propertyAllowIncompatiblePlatformSpecifies whether the publish action should go forward despite potentially incompatible SQL Server platforms.
Public propertyBackupDatabaseBeforeChangesSpecifies whether the database backups before deploying any changes.
Public propertyBlockOnPossibleDataLossSpecifies whether the publish episode is terminated if the publish operation might cause data loss.
Public propertyBlockWhenDriftDetectedSpecifies 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 propertyCommentOutSetVarDeclarationsSpecifies 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 propertyCompareUsingTargetCollationSpecifies whether this 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 propertyContributorArgumentsA set of name value pairs provided to customize deployment extensions. (Inherited from SqlDeploymentTask.)
Public propertyCreateNewDatabaseSpecifies whether the target database should be updated or whether it should be dropped and re-created when you publish to a database.
Public propertyDeployDatabaseInSingleUserModeSpecifies whether the database is set to Single User Mode before deploying.
Public propertyDisableAndReenableDdlTriggersSpecifies 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 propertyDoNotAlterChangeDataCaptureObjectsSpecifies whether the Change Data Capture objects are not altered.
Public propertyDoNotAlterReplicatedObjectsSpecifies whether objects that are replicated are identified during verification.
Public propertyDropConstraintsNotInSourceSpecifies 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 propertyDropDmlTriggersNotInSourceSpecifies 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 propertyDropExtendedPropertiesNotInSourceSpecifies 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 propertyDropIndexesNotInSourceSpecifies 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 propertyDropObjectsNotInSourceSpecifies 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 propertyDropPermissionsNotInSourceSpecifies 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 propertyDropRoleMembersNotInSourceSpecifies 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 propertyGenerateSmartDefaultsSpecifies 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.
Public propertyHostObject (Inherited from Task.)
Public propertyIgnoreAnsiNullsSpecifies whether to ignore or update differences in the ANSI NULLS setting when you publish to a database.
Public propertyIgnoreAuthorizerSpecifies whether to ignore or update differences in the Authorizer when you publish to a database.
Public propertyIgnoreColumnCollationSpecifies whether to ignore or update differences in column collation when you publish to a database.
Public propertyIgnoreCommentsSpecifies whether to ignore or update differences in comments order when you publish to a database.
Public propertyIgnoreCryptographicProviderFilePathSpecifies whether to ignore or update differences in the file path for a cryptographic provider when you publish to a database.
Public propertyIgnoreDdlTriggerOrderSpecifies whether to ignore or update differences in the order of Data Definition Language (DDL) triggers when you publish to a database.
Public propertyIgnoreDdlTriggerStateSpecifies whether to ignore or update differences in the enabled or disabled state of DDL triggers when you publish to a database.
Public propertyIgnoreDefaultSchemaSpecifies whether to ignore or update differences in the default schema when you publish to a database.
Public propertyIgnoreDmlTriggerOrderSpecifies whether to ignore or update differences in the order of DML triggers when you publish to a database.
Public propertyIgnoreDmlTriggerStateSpecifies whether to ignore or update differences in the enabled or disabled state of DML triggers when you publish to a database.
Public propertyIgnoreExtendedPropertiesSpecifies whether to ignore or update differences in extended properties when you publish to a database.
Public propertyIgnoreFileAndLogFilePathSpecifies whether to ignore or update differences in the paths for files and log files when you publish to a database.
Public propertyIgnoreFilegroupPlacementSpecifies whether to ignore or update differences in the placement of FILEGROUP's when you publish to a database.
Public propertyIgnoreFileSizeSpecifies whether to ignore or update differences in file sizes when you publish to a database.
Public propertyIgnoreFillFactorSpecifies whether to ignore or update differences in fill factors when you publish to a database.
Public propertyIgnoreFullTextCatalogFilePathSpecifies whether to ignore or update differences in the path to full-text index files when you publish to a database.
Public propertyIgnoreIdentitySeedSpecifies whether to ignore or update differences in the seed for an identity column when you publish to a database.
Public propertyIgnoreIncrementSpecifies whether to ignore or update differences in the increment for an identity column when you publish to a database.
Public propertyIgnoreIndexOptionsSpecifies whether to ignore or update differences in the index options when you publish to a database.
Public propertyIgnoreIndexPaddingSpecifies whether to ignore or update differences in the index padding when you publish to a database.
Public propertyIgnoreKeywordCasingSpecifies whether to ignore or update differences in the keyword casing when you publish to a database.
Public propertyIgnoreLockHintsOnIndexesSpecifies whether to ignore or update differences in the lock hints on indexes when you publish to a database.
Public propertyIgnoreLoginSidsSpecifies whether to ignore or update differences in the security identifier (SID) when you publish to a database.
Public propertyIgnoreNotForReplicationSpecifies whether to ignore or update the not-for-replication setting when you publish to a database.
Public propertyIgnoreObjectPlacementOnPartitionSchemeSpecifies whether to ignore or update an object’s placement on a partition scheme when you publish to a database.
Public propertyIgnorePartitionSchemesSpecifies whether to ignore or update differences in partition schemes and functions when you publish to a database.
Public propertyIgnorePermissionsSpecifies whether to ignore or update differences in permissions when you publish to a database.
Public propertyIgnoreQuotedIdentifiersSpecifies whether to ignore or update differences in quoted identifier settings when you publish to a database.
Public propertyIgnoreRoleMembershipSpecifies whether differences in the role membership of logins should be ignored or updated when you publish to a database.
Public propertyIgnoreRouteLifetimeSpecifies whether to ignore or update differences in the role memberships of logins when you publish to a database.
Public propertyIgnoreSemicolonBetweenStatementsSpecifies whether to ignore or update differences in semicolons between Transact-SQL statements when you publish to a database.
Public propertyIgnoreTableOptionsSpecifies whether to ignore or update differences in table options when you publish to a database.
Public propertyIgnoreUserSettingsObjectsSpecifies whether to ignore or update differences in user setting options when you publish to a database.
Public propertyIgnoreWhitespaceSpecifies whether to ignore or update differences in whitespace when you publish to a database.
Public propertyIgnoreWithNocheckOnCheckConstraintsSpecifies whether to ignore or update differences in the value of the WITH NOCHECK clause for check constraints when you publish to a database.
Public propertyIgnoreWithNocheckOnForeignKeysSpecifies whether to ignore or update differences in the value of the WITH NOCHECK clause for foreign keys when you publish to a database.
Public propertyIncludeCompositeObjectsSpecifies whether to include all composite elements as part of a single publish operation.
Public propertyIncludeTransactionalScriptsSpecifies whether to use transactional statements wherever possible when you publish to a database.
Public propertyLog (Inherited from Task.)
Public propertyNoAlterStatementsToChangeCLRTypesSpecifies that publish should always drop and re-create an assembly if there is a difference instead of issuing an ALTER ASSEMBLY statement.
Public propertyPopulateFilesOnFileGroupsSpecifies whether a new file is also created when you create a new FileGroup in the target database.
Public propertyPublish_TargetConnectionStringSpecifies a valid SQL Server or SQL Azure connection string for the target database. If this parameter appears on the command line, the connection string is used exclusively of other target parameters.
Public propertyRegisterDataTierApplicationSpecifies whether the schema is registered with the database server.
Public propertyScriptDatabaseCollationSpecifies whether to ignore or update differences in database collation when you publish to a database.
Public propertyScriptDatabaseCompatibilitySpecifies whether to ignore or update differences in database compatibility when you publish to a database.
Public propertyScriptDatabaseOptionsSpecifies whether to set or update target database properties when you publish to a database.
Public propertyScriptDeployStateChecksSpecifies 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 propertyScriptFileSizeControls whether size is specified when adding a file to a filegroup.
Public propertyScriptNewConstraintValidationSpecifies 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 propertyScriptRefreshModuleSpecifies 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 propertySqlPublishProfilePathSpecifies the file path to a DAC Publish Profile. The profile defines a collection of properties and variables to use when generating outputs.
Public propertyTargetDatabaseNameSpecifies the name of the target database.
Public propertyTreatVerificationErrorsAsWarningsSpecifies 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 propertyUnmodifiableObjectWarningsSpecifies 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 propertyVerifyCollationCompatibilitySpecifies whether collation compatibility is verified.
Public propertyVerifyDeploymentSpecifies 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 deployment. Could be a DAC deployment or ours. (Overrides DataTask.Execute().)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
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.
Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.