Export (0) Print
Expand All

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 (in Microsoft.Data.Tools.Schema.Tasks.Sql.dll)


public sealed class SqlPublishTask : SqlDeploymentTask

NameDescription
System_CAPS_pubmethodSqlPublishTask()

Initializes a new instance of the SqlPublishTask class.

NameDescription
System_CAPS_pubpropertyAdditionalDeploymentContributorArguments

This class supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyAdditionalDeploymentContributors

This class supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyAllowDropBlockingAssemblies

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.

System_CAPS_pubpropertyAllowIncompatiblePlatform

Specifies whether the publish action should go forward despite potentially incompatible SQL Server platforms.

System_CAPS_pubpropertyBackupDatabaseBeforeChanges

Specifies whether the database backups before deploying any changes.

System_CAPS_pubpropertyBlockOnPossibleDataLoss

Specifies whether the publish episode is terminated if the publish operation might cause data loss.

System_CAPS_pubpropertyBlockWhenDriftDetected

Specifies whether to block updating a database whose schema no longer matches its registration or is unregistered.

System_CAPS_pubpropertyBuildEngine

(Inherited from Task.)

System_CAPS_pubpropertyBuildEngine2

(Inherited from Task.)

System_CAPS_pubpropertyBuildEngine3

(Inherited from Task.)

System_CAPS_pubpropertyBuildEngine4

(Inherited from Task.)

System_CAPS_pubpropertyCacheTargetModel

This class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)

System_CAPS_pubpropertyCmdLineInMemoryStorage

This class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)

System_CAPS_pubpropertyCommentOutSetVarDeclarations

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.

System_CAPS_pubpropertyCompareUsingTargetCollation

Specifies 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.

System_CAPS_pubpropertyCreateNewDatabase

Specifies whether the target database should be updated or whether it should be dropped and re-created when you publish to a database.

System_CAPS_pubpropertyDeployDatabaseInSingleUserMode

Specifies whether the database is set to Single User Mode before deploying.

System_CAPS_pubpropertyDisableAndReenableDdlTriggers

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.

System_CAPS_pubpropertyDoNotAlterChangeDataCaptureObjects

Specifies whether the Change Data Capture objects are not altered.

System_CAPS_pubpropertyDoNotAlterReplicatedObjects

Specifies whether objects that are replicated are identified during verification.

System_CAPS_pubpropertyDropConstraintsNotInSource

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.

System_CAPS_pubpropertyDropDmlTriggersNotInSource

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.

System_CAPS_pubpropertyDropExtendedPropertiesNotInSource

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.

System_CAPS_pubpropertyDropIndexesNotInSource

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.

System_CAPS_pubpropertyDropObjectsNotInSource

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.

System_CAPS_pubpropertyDropPermissionsNotInSource

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.

System_CAPS_pubpropertyDropRoleMembersNotInSource

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.

System_CAPS_pubpropertyDropStatisticsNotInSource

This class supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyGenerateSmartDefaults

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.

System_CAPS_pubpropertyHostObject

(Inherited from Task.)

System_CAPS_pubpropertyIgnoreAnsiNulls

Specifies whether to ignore or update differences in the ANSI NULLS setting when you publish to a database.

System_CAPS_pubpropertyIgnoreAuthorizer

Specifies whether to ignore or update differences in the Authorizer when you publish to a database.

System_CAPS_pubpropertyIgnoreColumnCollation

Specifies whether to ignore or update differences in column collation when you publish to a database.

System_CAPS_pubpropertyIgnoreComments

Specifies whether to ignore or update differences in comments order when you publish to a database.

System_CAPS_pubpropertyIgnoreCryptographicProviderFilePath

Specifies whether to ignore or update differences in the file path for a cryptographic provider when you publish to a database.

System_CAPS_pubpropertyIgnoreDdlTriggerOrder

Specifies whether to ignore or update differences in the order of Data Definition Language (DDL) triggers when you publish to a database.

System_CAPS_pubpropertyIgnoreDdlTriggerState

Specifies whether to ignore or update differences in the enabled or disabled state of DDL triggers when you publish to a database.

System_CAPS_pubpropertyIgnoreDefaultSchema

Specifies whether to ignore or update differences in the default schema when you publish to a database.

System_CAPS_pubpropertyIgnoreDmlTriggerOrder

Specifies whether to ignore or update differences in the order of DML triggers when you publish to a database.

System_CAPS_pubpropertyIgnoreDmlTriggerState

Specifies whether to ignore or update differences in the enabled or disabled state of DML triggers when you publish to a database.

System_CAPS_pubpropertyIgnoreExtendedProperties

Specifies whether to ignore or update differences in extended properties when you publish to a database.

System_CAPS_pubpropertyIgnoreFileAndLogFilePath

Specifies whether to ignore or update differences in the paths for files and log files when you publish to a database.

System_CAPS_pubpropertyIgnoreFilegroupPlacement

Specifies whether to ignore or update differences in the placement of FILEGROUP's when you publish to a database.

System_CAPS_pubpropertyIgnoreFileSize

Specifies whether to ignore or update differences in file sizes when you publish to a database.

System_CAPS_pubpropertyIgnoreFillFactor

Specifies whether to ignore or update differences in fill factors when you publish to a database.

System_CAPS_pubpropertyIgnoreFullTextCatalogFilePath

Specifies whether to ignore or update differences in the path to full-text index files when you publish to a database.

System_CAPS_pubpropertyIgnoreIdentitySeed

Specifies whether to ignore or update differences in the seed for an identity column when you publish to a database.

System_CAPS_pubpropertyIgnoreIncrement

Specifies whether to ignore or update differences in the increment for an identity column when you publish to a database.

System_CAPS_pubpropertyIgnoreIndexOptions

Specifies whether to ignore or update differences in the index options when you publish to a database.

System_CAPS_pubpropertyIgnoreIndexPadding

Specifies whether to ignore or update differences in the index padding when you publish to a database.

System_CAPS_pubpropertyIgnoreKeywordCasing

Specifies whether to ignore or update differences in the keyword casing when you publish to a database.

System_CAPS_pubpropertyIgnoreLockHintsOnIndexes

Specifies whether to ignore or update differences in the lock hints on indexes when you publish to a database.

System_CAPS_pubpropertyIgnoreLoginSids

Specifies whether to ignore or update differences in the security identifier (SID) when you publish to a database.

System_CAPS_pubpropertyIgnoreNotForReplication

Specifies whether to ignore or update the not-for-replication setting when you publish to a database.

System_CAPS_pubpropertyIgnoreObjectPlacementOnPartitionScheme

Specifies whether to ignore or update an object’s placement on a partition scheme when you publish to a database.

System_CAPS_pubpropertyIgnorePartitionSchemes

Specifies whether to ignore or update differences in partition schemes and functions when you publish to a database.

System_CAPS_pubpropertyIgnorePermissions

Specifies whether to ignore or update differences in permissions when you publish to a database.

System_CAPS_pubpropertyIgnoreQuotedIdentifiers

Specifies whether to ignore or update differences in quoted identifier settings when you publish to a database.

System_CAPS_pubpropertyIgnoreRoleMembership

Specifies whether differences in the role membership of logins should be ignored or updated when you publish to a database.

System_CAPS_pubpropertyIgnoreRouteLifetime

Specifies whether to ignore or update differences in the role memberships of logins when you publish to a database.

System_CAPS_pubpropertyIgnoreSemicolonBetweenStatements

Specifies whether to ignore or update differences in semicolons between Transact-SQL statements when you publish to a database.

System_CAPS_pubpropertyIgnoreTableOptions

Specifies whether to ignore or update differences in table options when you publish to a database.

System_CAPS_pubpropertyIgnoreUserSettingsObjects

Specifies whether to ignore or update differences in user setting options when you publish to a database.

System_CAPS_pubpropertyIgnoreWhitespace

Specifies whether to ignore or update differences in whitespace when you publish to a database.

System_CAPS_pubpropertyIgnoreWithNocheckOnCheckConstraints

Specifies whether to ignore or update differences in the value of the WITH NOCHECK clause for check constraints when you publish to a database.

System_CAPS_pubpropertyIgnoreWithNocheckOnForeignKeys

Specifies whether to ignore or update differences in the value of the WITH NOCHECK clause for foreign keys when you publish to a database.

System_CAPS_pubpropertyIncludeCompositeObjects

Specifies whether to include all composite elements as part of a single publish operation.

System_CAPS_pubpropertyIncludeTransactionalScripts

Specifies whether to use transactional statements wherever possible when you publish to a database.

System_CAPS_pubpropertyLog

(Inherited from Task.)

System_CAPS_pubpropertyNoAlterStatementsToChangeCLRTypes

Specifies that publish should always drop and re-create an assembly if there is a difference instead of issuing an ALTER ASSEMBLY statement.

System_CAPS_pubpropertyPopulateFilesOnFileGroups

Specifies whether a new file is also created when you create a new FileGroup in the target database.

System_CAPS_pubpropertyPublish_TargetConnectionString

Specifies 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.

System_CAPS_pubpropertyRegisterDataTierApplication

Specifies whether the schema is registered with the database server.

System_CAPS_pubpropertyScriptDatabaseCollation

Specifies whether to ignore or update differences in database collation when you publish to a database.

System_CAPS_pubpropertyScriptDatabaseCompatibility

Specifies whether to ignore or update differences in database compatibility when you publish to a database.

System_CAPS_pubpropertyScriptDatabaseOptions

Specifies whether to set or update target database properties when you publish to a database.

System_CAPS_pubpropertyScriptDeployStateChecks

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.

System_CAPS_pubpropertyScriptFile

This class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)

System_CAPS_pubpropertyScriptFileSize

Controls whether size is specified when adding a file to a filegroup.

System_CAPS_pubpropertyScriptNewConstraintValidation

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.

System_CAPS_pubpropertyScriptRefreshModule

Specifies whether to include refresh statements at the end of the publish script.

System_CAPS_pubpropertySourceModel

This class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)

System_CAPS_pubpropertySqlPublishProfilePath

Item associated with Xml publish profile.

System_CAPS_pubpropertyTargetDatabaseName

Specifies the name of the target database.

System_CAPS_pubpropertyTreatVerificationErrorsAsWarnings

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.

System_CAPS_pubpropertyUnmodifiableObjectWarnings

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).

System_CAPS_pubpropertyUpdateDatabase

This class supports the product infrastructure and is not intended to be used directly from your code. (Inherited from SqlDeploymentTask.)

System_CAPS_pubpropertyVerifyCollationCompatibility

Specifies whether collation compatibility is verified.

System_CAPS_pubpropertyVerifyDeployment

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.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodExecute()

Executes deployment. Could be a DAC deployment or ours. (Overrides DataTask.Execute().)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICancelableTask.Cancel()

This class supports the product infrastructure and is not intended to be used directly from your code.

Cancels the active operation. (Inherited from DataTask.)

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

Return to top
Show:
© 2015 Microsoft