FILE: C:\Program Files\Microsoft SQL Server\150\DAC\bin\Microsoft.SqlServer.Dac.xml
--
Microsoft.SqlServer.Dac
Representation of the artifact that contains the definition and data of a data-tier application.
Release the resources held by this instance.
Place the contents of this package into the directory specified by .
Base directory in which to place the package contents.
If is a null reference or empty string.
If an error occurs while attempting to unpack the package.
Load a package file specified by .
Path to the package file.
instance that represents the package loaded from the specified file.
If there is a problem reading the package; or if the package contains exported data.
Load a package file specified by .
Path to the package file.
Backing storage type for package instance.
instance that represents the package loaded from the specified file.
If there is a problem reading the package; or if the package does not contain exported data.
Load a package from the specified .
Stream from which to read the package.
instance that represents the package loaded from the specified file.
If there is a problem reading the package; or if the package does not contain exported data.
Load a package from the specified .
Stream from which to read the package.
Backing storage type for package instance.
instance that represents the package loaded from the specified file.
If there is a problem reading the package; or if the package does not contain exported data.
Implement this interface to create a string access token. This access token will be used to set
the for any SqlConnection instances created when connecting to a database.
Returns an valid access token.
The access token to be used to set the AccessToken property of the SqlConnection.
Contains the results of a publish or script operation. This will contain at least one of the
or properties depending on what was requested in the
Constructs a with the specified contents
set as the to return
set as the to return
set as the to return
A Deployment Report, if one was requested.
This report is a high-level summary of actions being performed during deployment.
The DB-level deployment script, if one was requested.
This script contains all operations that must be done against the database during deployment.
The master database-level deployment script, if one was requested.
This script is only created if Azure SQL DB is the target as USE statements are not supported on that platform.
It contains all operations that must be done against the master database, for instance Create Database statements
Configures options for what will be reported when performing certain operations from ,
in particular whether a DeployReport and/or DeployScript will be generated
Configures options for what will be reported when performing certain operations from ,
in particular whether a DeployReport and/or DeployScript will be generated
Sets whether Deployment Script(s) should be generated during deploy.
If true, a script to update the database will be generated, and a script to
update Master may also be generated if the target is an Azure SQL DB and this
database has not yet been created.
Defaults to true
Sets whether a Deployment Report should be generated during deploy.
This report is a high-level summary of actions being performed during deployment.
Defaults to false
Optional path to write the DB-level deployment script, if is true.
This script contains all operations that must be done against the database during deployment.
Optional path to write the master database-level deployment script, if is true.
This script is only created if Azure SQL DB is the target as USE statements are not supported on that platform.
It contains all operations that must be done against the master database, for instance Create Database statements
Optional to configure a range of deployment options.
Nullable to allow the caller to cancel a deployment
Provides a service for discovering and configuring a to handle key vault access requests.
These requests will occur during deployment if an encrypted table is being altered. It also supports initialization of general
key vault support in an application
Internal for testing purposes only
Internal for testing purposes only.
Passes a object to the , to support scenarios
where a user changes authentication method, for instance by logging into a different Azure account
Gives the authenticator the opportunity to register with the core AlwaysEncrypted callstack. This is important
in scenarios where Interactive authentication is being used and this is the global authenticator to be used in the application
Callback function to validate the presence of AKV token for Column Master Key access
Singleton instance object for the .
Get DependencyManager
Trace object to use for tracing
Gives a way to set early failure if Azure Key Vault Provider is not setup.
When this is true, deployment fails to start if there is no Provider defined
contrary to default mode which lets the deployment go through and fails only when key is actually used.
Authentication info for client ID and Secret, which is commonly supported in command line scenarios.
This can be obtained by using the Azure SDK to log into Azure and obtain this information.
Data class to define authentication info that can be passed to a when
configuring
Constructor
Must not be null or whitespace
Must not be null
Client ID used to log in to Azure
Secret that verifies the authentication to Azure
Base class for any Azure Key Vault authentication provider. This is responsible for logging into Azure, obtaining
access keys and returning to the caller.
Notes: Only one provider is allowed per process, with the first to register being the successful provider. In order to
support and related APIs being used in multiple UI tools and the SqlPackage command line the
binding to Azure Authentication DLLs is loosely coupled to the core Dac Framework using MEF. A default provider is available
for use in SqlPackage and other command line scenarios, supporting basic credential based authentication. This can be
overridden in order to integrate with custom authentication pipelines or into your UI application by extending this method
and providing an with typeof(KeyVaultAuthenticator), a unique ID and high priority
Azure Key Vault authentication callback
Passes a object to the KeyVaultAuthenticator, to support scenarios
where a user changes authentication method, for instance by logging into a different Azure account
Gives the authenticator the opportunity to register with the core AlwaysEncrypted callstack. This is important
in scenarios where Interactive authentication is being used and this is the global authenticator to be used in the application
Called before Dac operations that may cause data movement against a table with encrypted columns will occur,
for instance deployment of a dacpac
A list of URLs representing every Key Vault referenced by column master keys, where the key is involved in a data motion
operation.
Result returned from a key vault validator. Indicates success or failure, and any
relevant error messages
Default constructor
Adds an error to the list of Validation errors
Was validation successful?
Errors that caused validation to fail, if any
This class supports the product infrastructure and is not intended to be used directly
from your code.
Indicates that a deployment property should be expanded for commandline property overriding
Default Constructor
Defines options that affect the behavior of package export from a database.
Construct a new instance of the class.
Specifies the command timeout in seconds when executing queries against SQLServer.
The command timeout in seconds.
Default is 60
Get the type of backing storage for the schema model used during extraction.
Enumeration value that specifies the type of backing storage for the schema model used during extraction.
Default value is File.
Specifies what the target engine version is expected to be.
This is used during export to define the allowed engine version to validate against
and whether the features of the database match the capabilities of that engine version.
The latest version of Azure contains support for additional capabilities. When this value is
or ,
the export operation will fail if the target database is found to contain any objects that
require a newer engine version.
The default value for this option is , which means that
validation will ensure that the export operation will only fail if the target database is
found to contain any objects that are not supported in the latest engine version.
Get or set boolean that specifies whether the supported full-text document types for Microsoft Azure SQL Database v12 should be verified.
True if the package should be verified; otherwise false.
Default value is false.
Defines options that affect the behavior of package import to a database.
Construct a new instance of the class.
Specifies additional deployment contributors which should run.
Specifies additional deployment contributor arguments.
Defines optional parameters specific to a Microsoft Azure SQL Database.
Specifies the command timeout in seconds when executing queries against SQLServer.
The command timeout in seconds.
Default is 60
Progress message associated with the overal progress import or export operation.
Data associated with an executing operation to report status updates or errors.
Return a string that represents the current object.
String that represents the current object.
Get the type of the event message.
Enumeration value that specifies the type of the event message.
Get numeric value associated with the event message.
Numeric value associated with the message.
Get string prefix associated with the source of the event message.
String prefix associated with the source of the event message.
Get friendly message for the current status of an operation.
String message for the current status of an operation.
Current progress in percent complete.
Data associated with an executing data operation to report status updates or errors related to progress.
Current progress in percent complete.
The schema name of the table whose progress is being reported.
The name of the table whose progress is being reported.
Defines options that affect the behavior of package deployment to a database.
Create a new instance of the class
with default options.
Interal mechanism to control deployment DNR ordering behavior
Create a new instance of the class
with specified options.
Create a new instance of the class
with specified options.
Initialize the expected defaults for this API.
Only defined where default values differ from the core defaults.
When new options are added to SqlDeploymentOptions or a default value changed,
all clients must determine if they must override the default.
Redundantly specifying existing defaults doesn't reduce need for this
process when adding options or changing defaults. Unit tests should
be employed to validating expectations for each deployment client
that overrides default options (e.g. power-buffer, schema-compare, this api).
When removing or renaming an option, the compiler will complain (good).
Specifies additional deployment contributors which should run - in addition
to those specified in the dacpac.
Specifies additional deployment contributor arguments in addition to those already listed
in the dacpac.
Get or set boolean that specifies whether CLR deployment will cause blocking assemblies to be dropped.
True to drop blocking assemblies during CLR deployment; otherwise, false.
Default is false.
Get or set boolean that specifies whether deployment will block due to platform compatibility.
True to block deployment to incompatible platforms; otherwise, false.
Default is false.
Get or set boolean that specifies whether a database backup will be performed before proceeding
with the actual deployment actions.
True to perform a database backup prior to deployment; otherwise, false.
Default is false.
Get or set boolean that specifies whether deployment should stop if the operation could cause data loss.
True to stop deployment if possible data loss if detected; otherwise, false.
Default is true.
Get or set boolean that specifies whether the system will check for differences between the
present state of the database and the registered state of the database and block deployment
if changes are detected. Even if this option is set to true, drift detection will only occur
on a database if it was previously deployed with the option enabled.
True to error is drift is detected; otherwise, false.
Default is true.
Specifies the command timeout in seconds when executing queries against SQLServer.
The command timeout in seconds.
Default is 60
Get or set boolean that specifies whether the declaration of SQLCMD variables are commented
out in the script header.
True to comment out these declarations; otherwise, false.
Default is false.
Get or set boolean that specifies whether the target collation will be used for identifier
comparison.
False to use the source collation; otherwise, true to use the target collation.
Default is false.
Get or set boolean that specifies whether the existing database will be dropped
and a new database created before proceeding with the actual deployment actions.
Acquires single-user mode before dropping the existing database.
True to drop and re-create the database; otherwise, false.
Default is false.
Defines optional parameters specific to a Microsoft Azure SQL Database.
Get or set boolean that specifies whether the system will acquire single-user mode on the target
database during the duration of the deployment operation.
True to acquire single-user mode during deployment; otherwise, false.
Default is false.
The database will be returned to multi-user mode after all changes are applied.
Database may remain in single-user mode if an error occurs during execution.
Get or set boolean that specifies if all DDL triggers will be disabled for the duration of the
deployment operation and then re-enabled after all changes are applied.
True to disable DDL triggers during deployment; otherwise, false.
Default is true.
Triggers may remain disabled if an error occurs during execution.
Get or set boolean that specifies whether items configured for Change Data Capture (CDC)
should be altered during deployment.
True to not alter objects configured for CDC; otherwise, false.
Default is true.
Get or set boolean that specifies whether items configured for Replication
should be altered during deployment.
True to not alter objects configured for Replication; otherwise, false.
Default is true.
Get or set a collection of object types that will not be dropped from the target when
no corresponding object exists in the source. Note that dropping and recreating objects
of the specified type may still be necessary due to dependencies from other objects.
Get or set boolean that specifies whether to drop all constraints that do not
exist in the source model.
True to drop constraints not in the source model; otherwise, false.
Default is true.
This applies to check, default, foreign key, primary key, and unique constraints.
Get or set boolean that specifies whether to drop all DML triggers that do not
exist in the source model.
True to drop DML triggers not in the source model; otherwise, false.
Default is true.
Get or set boolean that specifies whether to drop all extended properties that do
not exist in the source model.
True to drop extended properties not in the source model; otherwise, false.
Default is true.
Get or set boolean that specifies whether to drop all indexes that do not
exist in the source model.
True to drop indexes not in the source model; otherwise, false.
Default is true.
Get or set boolean that specifies whether objects that exist in the target but not source should be dropped during deployment.
True if objects that exist in the target but not source should be dropped; otherwise false.
Default is false.
Get or set boolean that specifies whether to drop all permissions that do not
exist in the source model.
True to drop permissions not in the source model; otherwise, false.
Default is false.
Get or set boolean that specifies whether to drop all role memberships that do not
exist in the source model.
True to drop role memberships not in the source model; otherwise, false.
Default is false.
Get or set boolean that specifies whether to drop all role memberships that do not
exist in the source model.
True to drop role memberships not in the source model; otherwise, false.
Default is false.
Get or set boolean that specifies whether default values should be generated to populate NULL columns that are constrained to NOT NULL values.
True if default values should be generated; otherwise false.
Default is false.
This is useful when needing to add a new NOT NULL column to an existing table with data.
Get or set boolean that specifies whether to exclude the ANSI_NULL option from
consideration when comparing the source and target model.
True to ignore differences in the ANSI_NULL option; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the AUTHORIZATION option from
consideration when comparing the source and target model.
True to ignore differences in the AUTHORIZATION option; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the collation specifier from
consideration when comparing the source and target model.
True to ignore differences in the collation specifier; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude from consideration
the order of columns in tables when comparing the source and target model.
True to ignore differences in column order; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude comments from
consideration when comparing the source and target model.
True to ignore differences in comments; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the file specification
of a cryptographic provider from consideration when comparing the source and
target model.
True to ignore differences in a cryptographic provider's file specification; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude DDL trigger order from
consideration when comparing the source and target model.
True to ignore differences in DDL trigger order; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude DDL trigger state from
consideration when comparing the source and target model.
True to ignore differences in DDL trigger state; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the DEFAULT_SCHEMA option from
consideration when comparing the source and target model.
True to ignore differences in the DEFAULT_SCHEMA options; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude DML trigger order from
consideration when comparing the source and target model.
True to ignore differences in DDL trigger order; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude DML trigger state from
consideration when comparing the source and target model.
True to ignore differences in DML trigger state; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude all extended properties from
consideration when comparing the source and target model.
True to ignore differences in extended properties; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the FILENAME option of
FILE objects from consideration when comparing the source and target model.
True to ignore differences in the FILENAME option of FILE objects; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the filegroup specifier
from consideration when comparing the source and target model.
True to ignore differences in the filegroup specifier; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the SIZE option of FILE objects
from consideration when comparing the source and target model.
True to ignore differences in the SIZE option of FILE objects; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the FILLFACTOR option
from consideration when comparing the source and target model.
True to ignore differences in the FILLFACTOR option; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the path specification of
FULLTEXT CATALOG objects from consideration when comparing the source and target model.
True to ignore differences in the path specification of FULLTEXT CATALOG objects; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the seed value of IDENTITY columns
from consideration when comparing the source and target model.
True to ignore differences in the seed value of IDENTITY columns; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the increment value of IDENTITY columns
from consideration when comparing the source and target model.
True to ignore differences in the increment value of IDENTITY columns; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude differences in index options
from consideration when comparing the source and target model.
True to ignore differences in index options; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the PAD_INDEX option
from consideration when comparing the source and target model.
True to ignore differences in the PAD_INDEX option; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude difference in the casing of keywords
from consideration when comparing the source and target model.
True to ignore differences in the casing of keywords; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the ALLOW_ROW_LOCKS and
ALLOW_PAGE_LOGKS options from consideration when comparing the source and target model.
True to ignore the ALLOW_ROW_LOCKS and ALLOW_PAGE_LOGKS options; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the SID option of the LOGIN object
from consideration when comparing the source and target model.
True to ignore the SID option of the LOGIN object; otherwise, false.
Default is true.
Get or set a collection of object types to exclude from consideration when
comparing the source and target model.
Get or set boolean that specifies whether to exclude the NOT FOR REPLICATION option
from consideration when comparing the source and target model.
True to ignore the NOT FOR REPLICATION option; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the partition scheme object
from consideration when comparing the source and target model for the following
objects: Table, Index, Unique Key, Primary Key, and Queue.
True to ignore partition schemes; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the parameter type and
boundary VALUES of a PARTITION FUNCTION from consideration when comparing the
source and target model. Also excludes FILEGROUP and partition function of a
PARTITION SCHEMA from consideration when comparing the source and target model.
True to ignore aspects of partition functions and schemes; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude all permission statements
from consideration when comparing the source and target model.
True to ignore all permission statements; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the QUOTED_IDENTIFIER option
from consideration when comparing the source and target model.
True to ignore the QUOTED_IDENTIFIER option; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude all ROLE MEMBERSHIP objects
from consideration when comparing the source and target model.
True to ignore ROLE MEMBERSHIP objects; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the LIFETIME option of ROUTE objects
from consideration when comparing the source and target model.
True to ignore the LIFETIME option of ROUTE objects; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the existence or absence of semi-colons
from consideration when comparing the source and target model.
True to ignore semi-colons; otherwise, false.
Default is true.
Get or set boolean that specifies whether the options on the target table are updated
to match the source table.
True to ignore difference in table options and not update the target table; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude user settings
from consideration when comparing the source and target model.
True to ignore differences in user settings; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude whitespace
from consideration when comparing the source and target model.
True to ignore differences whitespace; otherwise, false.
Default is true.
Get or set boolean that specifies whether to exclude the CHECK|NO CHECK option of a CHECK
constraint object from consideration when comparing the source and target model.
True to ignore the CHECK|NO CHECK option of a CHECK constraint object; otherwise, false.
Default is false.
Get or set boolean that specifies whether to exclude the CHECK|NO CHECK option of a FOREIGN KEY
constraint object from consideration when comparing the source and target model.
True to ignore the CHECK|NO CHECK option of a FOREIGN KEY constraint object; otherwise, false.
Default is false.
Get or set boolean that specifies whether to ignore blocking data motion on RLS enabled tables
True to ignore block on data motion when Row level security is enabled on a table
Default is false i.e. data motion is blocked with RLS by default.
Get or set boolean that specifies whether to include referenced, external elements that also
compose the source model and then update the target database in a single deployment operation.
True to include composite objects; otherwise, false.
Default is false.
Get or set boolean that specifies whether to use transations during the deployment operation
and commit the transaction after all changes are successfully applied.
True to use transactions during deployment; otherwise, false.
Default is false.
Get or set boolean that specifies whether to force a change to CLR assemblies by dropping and recreating them.
True if CLR assemblies should be dropped; otherwise false to allow ALTER statements to change CLR assemblies.
Default is false.
Get or set boolean that specifies whether files are supplied for filegroups defined in the deployment source.
True to specify files for filegroups; otherwise false.
Default is true.
Get or set boolean that specifies whether the database will be registered as a Data-Tier Application.
If the target database is already a registered Data-Tier Application, then the registration will be updated.
True to register the database as a Data-Tier Application; otherwise, false.
Default is false.
Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed.
Default is false.
Get or set boolean that specifies whether the target database should be altered to match the
source model's collation.
True to alter the target database's collation; otherwise, false.
Default is false.
Get or set boolean that specifies whether the target database should be altered to match the
source model's compatibility level.
True to alter the target database's compatibility level; otherwise, false.
Default is false.
Get or set boolean that specifies whether the database options in the target database should
be updated to match the source model.
True to alter the target database's options; otherwise, false.
Default is true.
Get or set boolean that specifies whether the target database should be checked to ensure that
it exists, is online and can be updated.
True to perform state checks on the target database; otherwise, false.
Default is false.
Get or set boolean that specifies whether a file size is specified when adding files to file groups.
True to specify a file size when adding files to file groups; otherwise, false.
Default is false.
Get or set boolean that specifies whether constraints are validated after all changes are applied.
True to validate check constraints; otherwise, false.
Default is true.
Constraints are always added with NOCHECK option; as a result their validation is skipped during creation.
Get or set boolean that specifies whether referencing procedures are refreshed when referenced objects are updated.
True to refresh referencing procedures; otherwise false.
Default is true.
Get or set boolean that 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.
True to treat errors as warnings; otherwise, false.
Default is false.
Get or set boolean that specifies whether warnings should be generated when differences are found
in objects that cannot be modified, for example, if the file size or file paths were different for a file.
True to generate warnings; otherwise, false.
Default is true.
Get or set boolean that specifies whether deployment will verify that the collation specified in the
source model is compatible with the collation specified in the target model.
True to continue if errors are generated during plan verification; otherwise, false.
Default is true.
Get or set boolean that specifies whether the plan verification phase is executed or not.
True to perform plan verification; otherwise, false to skip it.
Default is true.
Get dictionary of SQL command variable values, keyed by variable name.
Dictionary of SQL command variable values, keyed by variable name.
Valid values must be provided for every variable before deployment, or failures may occur during deployment.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to BACPAC should not contain either pre-deployment or post-deployment scripts..
Looks up a localized string similar to Cannot apply updates to a package loaded for read only..
Looks up a localized string similar to DropExtendedPropertiesNotInSource conflicts with the selected DoNotDropObjectType ExtendedProperties.
Looks up a localized string similar to DropPermissionsNotInSource conflicts with the selected DoNotDropObjectType Permissions.
Looks up a localized string similar to DropRoleMembersNotInSource conflicts with the selected DoNotDropObjectType RoleMembership.
Looks up a localized string similar to {0} {1}{2}: {3}.
Looks up a localized string similar to Error validating element {0}: {1}.
Looks up a localized string similar to Cannot deploy to existing database when upgrading has been disabled..
Looks up a localized string similar to Validation of the schema model for data package failed. Check the inner exception for details..
Looks up a localized string similar to Cannot create a BACPAC from a file that does not contain exported data..
Looks up a localized string similar to Cannot create a DAC package from a file that contains exported data..
Looks up a localized string similar to Could not connect to database server..
Looks up a localized string similar to Indexing for document type {0} is not supported on {1}..
Looks up a localized string similar to Unable to determine the existence of database '{0}'. You must have a user with the same password in master or database '{0}'..
Looks up a localized string similar to Could not determine SQL platform from package..
Looks up a localized string similar to Database source is not a supported version of SQL Server {0}: {1}..
Looks up a localized string similar to Table with schema "{0}" and name "{1}" was specified for data import or export, but does not exist in the database schema..
Looks up a localized string similar to An error occurred when deleting file '{0}'.
Looks up a localized string similar to Could not deploy package..
Looks up a localized string similar to Could not export schema and data from database..
Looks up a localized string similar to Argument 'ExtractAllTableData' has an invalid value:'true'. 'ExtractAllTableData' cannot be 'true' because individual user tables are also specified using the 'TableData' argument. Set 'ExtractAllTableData' to 'false' to extract data from the specified user tables..
Looks up a localized string similar to Extracting data from FileTable {0}.{1} is not supported..
Looks up a localized string similar to Could not extract package from specified database..
Looks up a localized string similar to Foreign key {0} cannot reference table {1} when used as part of a data package..
Looks up a localized string similar to One or more unsupported elements were found in the schema used as part of a data package..
Looks up a localized string similar to Could not generate deployment report..
Looks up a localized string similar to Could not generate deployment results..
Looks up a localized string similar to Could not generate deployment script..
Looks up a localized string similar to Could not generate drift report..
Looks up a localized string similar to Could not import package..
Looks up a localized string similar to The property {0} specified is not present in the resource {1}..
Looks up a localized string similar to Error loading constraint information from target database.
Looks up a localized string similar to Could not load package..
Looks up a localized string similar to Could not load package from '{0}'..
Looks up a localized string similar to Could not load data-tier application metadata from package..
Looks up a localized string similar to An error occurred reading the contents of file '{0}'.
Looks up a localized string similar to Could not load schema model from package..
Looks up a localized string similar to Could not read schema model header information from package..
Looks up a localized string similar to Could not read profile xml..
Looks up a localized string similar to Could not read profile properties: {0}.
Looks up a localized string similar to Could not load script from package..
Looks up a localized string similar to Could not register DAC information..
Looks up a localized string similar to Could not save package to file..
Looks up a localized string similar to Stream does not support reading..
Looks up a localized string similar to Stream does not support seeking..
Looks up a localized string similar to Stream does not support writing..
Looks up a localized string similar to Could not translate package..
Looks up a localized string similar to Cannot unpack to the same location twice. The file '{0}' already exists in the unpack directory.
Looks up a localized string similar to Could not unpack the package..
Looks up a localized string similar to Could not unregister DAC information..
Looks up a localized string similar to Element {0} is an unsupported CLR element that is not allowed when used as part of a data package..
Looks up a localized string similar to Element {0} is a contained user that is not supported when used as a part of a data package..
Looks up a localized string similar to The element {0} is not supported when used as part of a data package (.bacpac file)..
Looks up a localized string similar to Element {0} has an unsupported property {1} set and is not supported when used as part of a data package..
Looks up a localized string similar to Element {0} is an unsupported FILESTREAM column that is not allowed when used as part of a data package..
Looks up a localized string similar to {0} is not supported on Microsoft Azure SQL Database as it aliases the external element {1}..
Looks up a localized string similar to Element {0} is an unsupported CLR User-defined type column that is not allowed when used as part of a data package..
Looks up a localized string similar to Could not update the dac history table..
Looks up a localized string similar to Validation of the schema model for data package failed..
Looks up a localized string similar to Verification of the deployment plan failed..
Looks up a localized string similar to The row-level security policies of this database restrict some users' ability to access data in these tables: '{0}'. Please verify that the credentials you're using have sufficient privileges to access all the data in these tables..
Looks up a localized string similar to The database permissions may restrict the ability of some users' to see the actual data contained in these tables: '{0}'. Please verify that the credentials you're using have sufficient privileges to see all data unmasked..
Looks up a localized string similar to {0} is not a valid value for {1}..
Looks up a localized string similar to The model header data from the package '{0}' is invalid..
Looks up a localized string similar to Cannot proceed as Key Vault support is not present in the current application. For Key Vault support during deployment, install DacFramework.msi and run SqlPackage.exe from its install location..
Looks up a localized string similar to Packaging the model failed..
Looks up a localized string similar to The referenced package '{0}' doesn't exist..
Looks up a localized string similar to At least one of the options {0} or {1} must be enabled..
Looks up a localized string similar to Translating the model failed..
Looks up a localized string similar to The version of the supplied package, {0}, is incompatible with this version of the DAC Framework..
Looks up a localized string similar to Validating the model against target platform failed..
Data associated with an error with exception information.
Get exception associated with the event message.
Exception object associated with the message.
List of possible editions for a Microsoft Azure SQL Database
CREATE DATABASE database_name EDITION = 'web'
CREATE DATABASE database_name EDITION = 'business'
CREATE DATABASE database_name EDITION = 'basic'
CREATE DATABASE database_name EDITION = 'standard'
CREATE DATABASE database_name EDITION = 'premium'
CREATE DATABASE database_name EDITION = 'premiumRS'
CREATE DATABASE database_name
Defines optional parameters specific to a Microsoft Azure SQL Database
Default constructor
Database Edition
CREATE DATABASE database_name [ COLLATE collation_name ]
{
({edition_options} [, ...n])
}
{edition_options} ::=
{
(MAXSIZE = { 100 MB | 500 MB | 1 | 5 | 10 | 20 | 30 ... 150 ... 500 } GB
|(EDITION = {'web' | 'business' | 'basic' | 'standard' | 'premium' | 'premiumRS'})
|(SERVICE_OBJECTIVE = { 'shared' | 'basic' | 'S0' | 'S1' | 'S2' | 'S3' | 'P1' | 'P2' | 'P3' | 'P4' | 'P6' | 'P11' | 'P15' | 'PRS1' | 'PRS2' | 'PRS4' | 'PRS6' })
}
Maximum size, in GB
CREATE DATABASE database_name [ COLLATE collation_name ]
{
({edition_options} [, ...n])
}
{edition_options} ::=
{
(MAXSIZE = { 100 MB | 500 MB | 1 | 5 | 10 | 20 | 30 ... 150 ... 500 } GB
|(EDITION = {'web' | 'business' | 'basic' | 'standard' | 'premium' | 'premiumRS'})
|(SERVICE_OBJECTIVE = { 'shared' | 'basic' | 'S0' | 'S1' | 'S2' | 'S3' | 'P1' | 'P2' | 'P3' | 'P4' | 'P6' | 'P11' | 'P15' | 'PRS1' | 'PRS2' | 'PRS4' | 'PRS6' })
}
Database Performance Level
CREATE DATABASE database_name [ COLLATE collation_name ]
{
({edition_options} [, ...n])
}
{edition_options} ::=
{
(MAXSIZE = { 100 MB | 500 MB | 1 | 5 | 10 | 20 | 30 ... 150 ... 500 } GB
|(EDITION = {'web' | 'business' | 'basic' | 'standard' | 'premium' | 'premiumRS'})
|(SERVICE_OBJECTIVE = { 'shared' | 'basic' | 'S0' | 'S1' | 'S2' | 'S3' | 'P1' | 'P2' | 'P3' | 'P4' | 'P6' | 'P11' | 'P15' | 'PRS1' | 'PRS2' | 'PRS4' | 'PRS6' })
}
Defines options that affect the behavior of package extraction.
Construct a new instance of the class.
Specifies the command timeout in seconds when executing queries against SQLServer.
The command timeout in seconds.
Default is 60
Get or set boolean that specifies whether data for all user tables will be extracted.
True if data for all user tables will be extracted; otherwise false.
Default value is false.
Get or set boolean that specifies whether server-scoped elements referenced by the source should be extracted.
True if references server-scoped elements should be extracted; otherwise false.
Default value is true.
Get or set boolean that specifies the scope of objects extracted from the source.
True if only application-scoped objects should be extracted;
otherwise false to extract all object types.
Default value is true.
Get or set boolean that specifies whether extended properties should be ignored.
True if extended properties will be ignored; otherwise false.
Default value is false.
Get or set boolean that specifies whether permissions should be ignored.
True if permissions will be ignored; otherwise false.
Default value is true.
Get or set boolean that specifies whether mappings between users and logins should be extracted from the source.
True if user login mappings will be ignored; otherwise false.
Default value is false.
Get the type of backing storage for the schema model used during extraction.
Enumeration value that specifies the type of backing storage for the schema model used during extraction.
Default value is File.
Get or set boolean that specifies whether the extracted package should be verified.
True if the package should be verified; otherwise false.
Default value is false.
Usage properties include Table.RowCount, Table.IndexSize, Table.DataSize, Table.UsedPages and Table.DataPages.
When true, these properties are extracted from the database and are accessible in the model.
True if usage properties will be extracted; otherwise false.
Default value is false.
Data associated with event raised as an executing operation reports status updates or errors.
Message information associated with this event instance.
Specifies the type (or severity) of message associated with a given event.
Informational message.
Noncritical problem.
Serious, possibly fatal issue.
Specifies the state of a service operation.
Operation has not yet started.
Operation is executing.
Operation has finished execution.
Operation did not complete execution.
Operation was cancelled.
Representation of the artifact that contains the definition of a data-tier application.
Release the resources held by this instance.
Place the contents of this package into the directory specified by .
Base directory in which to place the package contents.
If is a null reference or empty string.
If an error occurs while attempting to unpack the package.
Place the contents of this package into the directory specified by .
Object used to access package content.
Base directory in which to place the package contents.
Load a package file specified by .
Path to the package file.
instance that represents the package loaded from the specified file.
If there is a problem reading the package; or if the package contains exported data.
Load a package file specified by .
Path to the package file.
Backing storage type for package instance.
instance that represents the package loaded from the specified file.
If there is a problem reading the package; or if the package contains exported data.
Load a package file specified by .
Path to the package file.
Backing storage type for package instance.
The access in which to open the package. Valid values are or .
instance that represents the package loaded from the specified file.
If there is a problem reading the package; or if the package contains exported data.
Load a package from the specified .
Stream from which to read the package.
instance that represents the package loaded from the specified .
If there is a problem reading the package; or if the package contains exported data.
Load a package from the specified .
Stream from which to read the package.
Backing storage type for package instance.
instance that represents the package loaded from the specified .
If there is a problem reading the package; or if the package contains exported data.
Load a package from the specified .
Stream from which to read the package.
Backing storage type for package instance.
The access in which to open the package. Valid values are or .
instance that represents the package loaded from the specified .
If there is a problem reading the package; or if the package contains exported data.
Write package with the supplied schema model and DAC metadata to the supplied .
to which to write the package.
Schema model to be serialized into package.
DAC metadata to be serialized into package.
Optional minimum model schema version to use when saving model.
The model version used for the serialization
Get identifier for this package.
String identifier for this package.
Get an optional summary of this package.
String summary of this package; or null reference if there is no summary.
Get version information for this package.
structure that specifies the version information for this package.
Get stream used to read and write script executed prior to deploying schema contained in this package.
instance used to read and write script contents.
Get stream used to read and write script executed after deploying schema contained in this package.
instance used to read and write script contents.
Contains settings related to a specific deployment configuration.
Construct a new instance of the class with a default set of deployment options.
Create a instance by reading serialized profile data from the specified file.
Path to file with serialized profile data.
instance initialized from the serialized file data.
Create a instance by reading serialized profile data from the specified .
Stream from which to read serialized profile data.
instance initialized from the serialized file data.
Create a instance by reading serialized profile data from the specified .
Provider that creates serializer from which to read parsed profile data.
instance initialized from the serialized file data.
Get deployment options associated with this profile.
instance that specifies deployment options.
Get or set name of database used as the target of a deployment.
String name of target database.
Get or set connection string for database server used as the target of a deployment.
String that specifies database server connection information.
Data associated with event raised as an executing operation completes individual steps of processing.
Get status of an active operation.
enumeration value that specifies the current status of an operation.
Get a friendly message associated with the current step of an operation.
String message associated with the current step of an operation.
Gets the ID of the top level task the progress event relates to.
- Extract = 1
- Publish = 2
- ImportData = 3
- ExportData = 4
- Unregister = 5
- Register = 6
- DriftReport = 7
- DeployReport = 8
- Script = 9
This message is raised when the DacFx API retried a command or connection due to a
transient error returned by the server.
The retry count when this error was encountered
The number of the error from SQL Server or 0 if a different
exception was encountered (that invoked a retry)
Specifies the type of backing storage for a schema model.
Model is back by file-based storage.
Model is stored completely in-memory.
Exception thrown for DAC service errors.
Construct a new instance of the class.
Construct a new instance of the class with the specified error message.
The message that describes the error.
Construct a new instance of the class with the specified error message
and a reference to the inner exception that is the cause of this exception.
The message that describes the error.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
Write exception information to the supplied object.
that holds the serialized object data.
that contains contextual information about the source or destination.
If is a null reference.
Get collection of additional error, warning, and informational messages associated with this exception.
Collection of additional messages associated with this exception.
Provides operations to create and consume DAC packages represented by instances.
Connection factory using the connection string supplied by caller.
Called by classes within the API to initialize any static state
Construct a new instance of the class
that operates against the database specified by the supplied connection string.
String that supplies connection information for the database connection used by this instance.
If is a null reference.
If the supplied is not valid.
Construct a new instance of the class
that operates against the database specified by the supplied connection string and authentication provider.
String that supplies connection information for the database connection used by this instance.
Provide the up-to-date access token for AAD Universal Login (smartcard, phone, etc)
If is a null reference.
If is a null reference.
If the supplied is not valid.
Construct a new instance of the class
that operates against the database specified by the supplied connection string.
String that supplies connection information for the database connection used by this instance.
SecureString that supplies password for the database connection used by this instance.
If is a null reference.
If the supplied is not valid.
Extract the schema from a database into a package.
Path to the package file to be created.
Name of the source database.
String identifier for the DAC application.
Version of the DAC application.
Optional string summary of the DAC application.
Optional enumerable used to retrieve enumerator over set of tables for which reference data should be stored.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
If the value for this parameter is a null reference, no reference data will be stored.
Optional instance used to specify options that affect the behavior of package extraction.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If is a null reference or empty string.
If a problem occurs during package extraction.
If the has a cancellation requested and the operation could be cancelled.
Extract the schema from a database into a package.
to which to write the package.
Name of the source database.
String identifier for the DAC application.
Version of the DAC application.
Optional string summary of the DAC application.
Optional enumerable used to retrieve enumerator over set of tables for which data should be exported.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
If the value for this parameter is a null reference, no data will be exported.
Optional instance used to specify options that affect the behavior of package extraction.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If is a null reference or empty string.
If a problem occurs during package extraction; or the supplied stream is not suitable for writing the package.
If the has a cancellation requested and the operation could be cancelled.
Scripts the steps for a publish operation as a deployment script, deployment report, or both.
At least one of the or
options must be set to true. This method will not publish to the database
containing schema to be deployed.
Name of the target database for deployment.
Instance of that specifies what is reported back - the deployment script,
deployment report, as well as how to configure various aspects of the deployment.
, containing the script(s) and/or report if requested by the caller
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during deployment.
If the has a cancellation requested and the operation could be cancelled.
Scripts the steps for a publish operation as a deployment script, deployment report, or both.
At least one of the or
options must be set to true. This method will not modify the target
containing schema to be deployed.
containing schema representing the target database.
Name of the target database for deployment.
Instance of that specifies what is reported back - the deployment script,
deployment report, as we all how to configure various aspects of the deployment.
, containing the script(s) and/or report if requested by the caller
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during deployment.
If the has a cancellation requested and the operation could be cancelled.
Publish the supplied package to a database. This method supports returning the script used when publishing along with
a deployment report summarizing the actions taken during Publish
containing schema to be deployed.
Name of the target database for deployment.
Instance of that specifies what is reported back - the deployment script,
deployment report, as we all how to configure various aspects of the deployment.
, containing the script(s) and/or report if requested by the caller
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during deployment.
If the has a cancellation requested and the operation could be cancelled.
Deploy the supplied package to a database.
containing schema to be deployed.
Name of the target database for deployment.
True to allow modification of existing database schema in order to match schema contained in source package;
otherwise false to block modification of existing database.
If the database does not exist this flag has no effect.
Instance of that specifies properties that affect various aspects of the deployment.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If is true and the target database exists;
or if an error occurs during deployment.
If the has a cancellation requested and the operation could be cancelled.
Create T-SQL script that can be used to deploy the schema of the supplied to a database.
containing schema to be deployed.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment script creation.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
String of T-SQL script used to create or update database schema based on the supplied .
If a problem occurs during script generation.
If the has a cancellation requested and the operation could be cancelled.
Create XML report of the steps needed to deploy the schema of the supplied to a database.
containing schema to be deployed.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment report creation.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
String of XML that details the steps of the package deployment.
If a problem occurs during report generation.
If the has a cancellation requested and the operation could be cancelled.
Creates an , handling any errors thrown during contstruction
Generate unique filename for a script
The target database name
Is this the master database script
Create XML report of the drift that has occurred since the database was last registered.
Name of the target database for deployment.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
String of XML that details the database drift, or null if the database has not been registered.
If a problem occurs during report generation.
If the has a cancellation requested and the operation could be cancelled.
Create XML report of the drift that has occurred since the database was last registered.
Name of the target database for deployment.
Specifies the type of backing storage for a schema model.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
String of XML that details the database drift, or null if the database has not been registered.
If a problem occurs during report generation.
If the has a cancellation requested and the operation could be cancelled.
Add DAC registration information for the specified target database.
Name of the database for which to add registration information.
String identifier for the DAC application.
Version of the DAC application.
Optional string summary of the DAC application.
If any of the required arguments are null or zero-length strings.
Add DAC registration information for the specified target database.
Name of the database for which to add registration information.
Specifies the type of backing storage for a schema model.
String identifier for the DAC application.
Version of the DAC application.
Optional string summary of the DAC application.
If any of the required arguments are null or zero-length strings.
Remove DAC registration information for the specified target database.
Name of the database for which to remove registration information.
If is null or a zero-length string.
Extract schema and export data from a database into a "bacpac" package.
Path of the target package file.
Name of the source database.
Optional enumerable used to retrieve enumerator over set of tables for which data should be exported.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
If the value for this parameter is a null reference, data for all tables will be exported.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data export;
or if specifies a table that does not exist in the schema contained in the supplied package.
If the has a cancellation requested and the operation could be cancelled.
Extract schema and export data from a database into a "bacpac" package.
Path of the target package file.
Name of the source database.
Specifies the type of backing storage for a schema model.
Optional enumerable used to retrieve enumerator over set of tables for which data should be exported.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
If the value for this parameter is a null reference, data for all tables will be exported.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data export;
or if specifies a table that does not exist in the schema contained in the supplied package.
If the has a cancellation requested and the operation could be cancelled.
Extract schema and export data from a database into a "bacpac" package.
Path of the target package file.
Name of the source database.
Instance of that specifies properties that affect various aspects of the export.
Optional enumerable used to retrieve enumerator over set of tables for which data should be exported.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data export;
or if specifies a table that does not exist in the schema contained in the supplied package.
If the has a cancellation requested and the operation could be cancelled.
Extract schema and export data from a database into a "bacpac" package.
to which to write the package.
Name of the source database.
Optional enumerable used to retrieve enumerator over set of tables for which data should be exported.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
If the value for this parameter is a null reference, data for all tables will be exported.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data export;
or if specifies a table that does not exist in the schema contained in the supplied package;
or the supplied stream is not suitable for writing the package.
If the has a cancellation requested and the operation could be cancelled.
Extract schema and export data from a database into a "bacpac" package.
to which to write the package.
Name of the source database.
Specifies the type of backing storage for a schema model.
Optional enumerable used to retrieve enumerator over set of tables for which data should be exported.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
If the value for this parameter is a null reference, data for all tables will be exported.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data export;
or if specifies a table that does not exist in the schema contained in the supplied package;
or the supplied stream is not suitable for writing the package.
If the has a cancellation requested and the operation could be cancelled.
Extract schema and export data from a database into a "bacpac" package.
to which to write the package.
Name of the source database.
Optional instance of that specifies properties that affect various aspects of the export.
Optional enumerable used to retrieve enumerator over set of tables for which data should be exported.
For each in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data export;
or if specifies a table that does not exist in the schema contained in the supplied package.
If the has a cancellation requested and the operation could be cancelled.
Populates ambient setting controlling
deployment/retry behavior down the stack.
Sets up a stack context to push a configured settings object to populate
the ambient settings for consumption further down the stack
Deploy schema and import table data from the supplied package to a database.
containing schema to be deployed and data to be imported.
Name of the target database for deployment.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data import.
If the has a cancellation requested and the operation could be cancelled.
Deploy schema and import table data from the supplied package to a database.
containing schema to be deployed and data to be imported.
Name of the target database for deployment.
Optional default size and edition parameters used when creating a new Azure database.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data import.
If the has a cancellation requested and the operation could be cancelled.
Deploy schema and import table data from the supplied package to a database.
containing schema to be deployed and data to be imported.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the import.
Optional that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
If the value for any of the required parameters is a null reference or an empty string.
If an error occurs during schema deployment and data import.
If the has a cancellation requested and the operation could be cancelled.
Return FileStream after handling all acceptable exceptions.
File path.
File mode.
File access.
File share.
Message for handled exception.
Catches common error cases when doing I/O operations and throws a with a predefined error message
Create T-SQL script that can be used to deploy the schema of the supplied to a database.
containing schema to be deployed.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment script creation.
String of T-SQL script used to create database schema based on the supplied .
If a problem occurs during script generation.
Create T-SQL script that can be used to deploy the schema of the supplied to a database.
to which to write the deployment script.
containing schema to be deployed.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment script creation.
If a problem occurs during script generation.
Create T-SQL script that can be used to deploy the differences between the schemas of the supplied source and target instances to a database.
containing the source schema to be compared.
containing the target schema to be compared.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment script creation.
String of T-SQL script used to create or update database schema based on the supplied .
If a problem occurs during script generation.
Create T-SQL script that can be used to deploy the differences between the schemas of the supplied source and target instances to a database.
to which to write the deployment script.
containing the source schema to be compared.
containing the target schema to be compared.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment script creation.
If a problem occurs during script generation.
Create XML report of the steps needed to deploy the differences between the schemas of the supplied source and target instances to a database.
containing the source schema to be compared.
containing the target schema to be compared.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment report creation.
String of XML that details the steps of the deployment.
If a problem occurs during report generation.
Create XML report of the steps needed to deploy the differences between the schemas of the supplied source and target instances to a database.
to which to write the deployment report.
containing the source schema to be compared.
containing the target schema to be compared.
Name of the target database for deployment.
Instance of that specifies properties that affect various aspects of the deployment report creation.
If a problem occurs during report generation.
Evaluate the connection factory and determine if supplied connection factory is valid and supported by .
Connection factory to be validated.
Validated connection factory with only supported arguments present.
If the supplied is not valid or if it specifies properties
or property values that are not supported by .
Some CLR hosts do not set the AppDomain Evidence which is required for IsolatedStorage to function properly. This
method probes if isolated storage is usable for the current user. If isolated storage is not usable, it will attempt
to fix this by setting the AppDomain Evidence using private reflection. Fixing isolated storage is a best effort
attempt. This method swallows all exceptions and lets the program proceed.
cd
Invoked as the state of an operation changes.
Invoked as an operation reports status updates or errors.
This class is meant to be a public exception class - i.e. when throwing it ensure
that the exception is meaningful to the end-developer.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to Failed to retrieve information from target database {0}.
Looks up a localized string similar to Data plan execution failed with message {0}.
Looks up a localized string similar to Failed to retrieve information from target database to correctly model the database.
Looks up a localized string similar to Excluded column [{0}].[{1}].[{2}] does not exist in the source model..
Looks up a localized string similar to Selected table [{0}].[{1}] does not have data and will not be populated..
Logically represents a database. Can be used to retrieve information about the database
such as a model and data
Adds new constraints to the specified constraint manager. Will throw a DataException if a error
occurs with the connection to the DB
Represents a "top of stack" incremental data deployment engine. This engine acts primarly as an orchestrator
between other more fine-grained data deployment components. It is meant to be a fire-and-dispose component, access to and control of
more fine grained components is left to direct manipulation of those components directly to avoid lifetime issues
Adds a table to be considered when creating the data deployment plan
Configures how tables will be selected for data deployment
Storage to use when creating models of the source/target databases
Name of the target database.
This class represents the disposable parts of the deployment plan.
Base class for different data deployment plan generation strategies
A data transfer object used to pass state between components used in plan creation
Called to populate selected data tables and columns based on
policy specified in the options
Assumption: the Options and Source model are populted before this method is called
This method adds new element to the list of schema-bound objects we're about to drop and re-create.
If the input element is not present in the list, we create a new graph node and establish
parent-child relationships. If already in the list, we just update parent-child relationship lists.
Executes a deployment plan against the specified target database
Thrown by the DeveloperInstanceManager
This class encapsulates dealing with the Serverless SQL Express technology SqlStudio uses
as a default destination for database project deployment
Returns a localdb instance named based on the specified named. The returned
name is in the format of (localdb)\namePrefix
If necessary creates and then starts the specified instance and returns a connection string to connect
to master on the specified localdb instance.
Returns a connection string to connect to the database. Will throw DeveloperInstanceException
if localdb is not installed or if an error occurs during creation of the connection string
If the specified database exists on the instance detach it from the instance.
Any connections/transactions open on the database will be closed as part of the detach.
Stops the specified instance if it is running
Tears down an instance by stopping and then deleting the specified instance.
Helper method that creates a connection string to
connect to the specified data source
Helper method that throws the well known "could not setup" exception
Helper to create a safe name prefix
Helper to check if a database exists
If not already tested, tests whether the localdb connectivity fix has been
installed. This is a QFE ontop of .net framework 4.0. It is assumed that the
instance has already been started.
Sets up the LocalDB instance. Returns named pipe if successful
Helper method to "warmup" a new database after it has been created/attached
Creates an AST that represents a create database statement to create a database
on a serverless instance
Builds an AST that will set the specified database to single user and detach it.
Creates an AST to drop a database
Helper method that executes a set of batches against provided connection
Returns true is localDb is install on the user's machine
This class encalsulates management of LocalDB instances via the native control .dll
Creates a new LocalDB instance using the specified instance name
True if the instance was created or already existed
Starts the specified instance.
The name of an instance that was already created
The named pipe that can be used to communicate with the instance
Stops the specified instance
Deletes the specified instance.
Helper method to verify that LocalDB is installed - it will throw if not installed.
Helper to return back the specified delegate to PInvoke the specified function
Helper method that looks in the registry to find the path to the control LocalDB library.
The control library's constract specifies that the control library must be backwards compatible
so we always load the latest instance of the control library and then specify the version we
are conpatible with in subsequent calls into the library. For instance, we may load LocalDB
control library 12 and then specify that we want version 11 in a CreateInstance call.
Returns true is LocalDB is installed
Encapsulates return codes from LocalDB
Wraps the safe handle to the native library
Encapsulates the delegates that define the signatures of the functions on the control library. These
delegates are used to successfully PInvoke into the .dll
Encapsulates the names of the functions on the controller .dll
Additional functions that we PInvoke to manage loading the control .dll and
find the control function addresses.
Update's the target database's data using the model's / data that has already be created. Assumption - this
method is called after the controller has been initialized and used to update the target database
Snapshots constraint state in the target database prior to the database being updated
Represents an option specifying what engine version should be set or allowed.
Currently this option is only used in operations related to Microsoft Azure SQL Database.
For instance this can be used during export to define the allowed engine version to validate against
and whether the features of the database match the capabilities of that engine version.
Similarly when defining creation options for a public TSqlModel in the extensibility APIs, this can be
used to define what the expected engine version of the model should be set to.
Use the default engine version when creating the model.
Use the latest engine version when creating the model.
This will always attempt to set the highest supported engine version as the
target, and will mean that the model will allow the latest set of T-SQL language
features to be supported
Version 11
Version 12
Provides extensions for interacting with DAC packages represented by or instances.
Returns the database collation for the package.
containing collation information.
The SQL Server collation string, or null if the collation cannot be retrieved.
If the value for any of the required parameters is a null reference.
Returns the database collation for the package.
containing collation information.
The SQL Server collation string, or null if the collation cannot be retrieved.
If the value for any of the required parameters is a null reference.
Configures a setting on the supplied DacServices instance.
The services instance to apply the setting
The name of the setting
The value of the setting or null to remove the setting
Get instance that represents the extracted database schema.
instance created from extracted database schema.
Use this property after executing this operation to retrieve the resulting model.
Callers must handle disposal of this instance, as its lifetime is not managed by this class.
Determine if the supplied schema model contains any elements that are problematic
when used with a package that contains data.
to query for elements.
Enumerable of data tables.
that can be used to indicate that the operation should be cancelled.
Use of this object does not guarantee that the operation will be cancelled.
Callback invoked when problematic elements are identified.
A instance is supplied that contains the details for the unsupported element.
For platforms that support row-level security the exported rows set may be incomplete if the user
is exporting a package under a database account that doesn't have enough privileges. Issue a warning
so users can be aware of this situation
For platforms that support data masking the exported rows set may contain some masked data if the user
is exporting a package under a database account that doesn't have enough privileges (UNMASK permission).
Issue a warning so users can be aware of this situation.
Defines object types that exist in SQL Server.
Aggregate objects
Application role objects
Assembly objects
Assembly files
Asymmetric key objects
Broker priority objects
Certificate objects
Always Encrypted column encryption key objects
Always Encrypted column master key objects
Contract objects
Database options
Database role objects
Database DDL trigger objects
Default objects
Extended property objects
External data source objects
External file format objects
External table objects
Filegroup objects
FileTable objects
Full-text catalog objects
Full-text stoplist objects
Message type objects
Partition function objects
Partition scheme objects
Permission objects
Queue objects
Remote service binding objects
Role membership objects
Rule objects
Scalar valued function objects
Search property list objects
Security policy objects
Sequence objects
Service objects
Signature objects
Stored procedure objects
Symmetric key objects
Synonym objects
Table objects
Table valued function objects
User defined data type (non-CLR) objects
User defined table type objects
User defined type (CLR) objects
User objects
View objects
Xml schema collection objects
Audit objects
Credential objects
Cryptographic provider objects
Database audit specification objects
Database encryption keys
Database scoped credential objects
Endpoint objects
Error message objects
Error notification objects
Event session objects
Linked server login objects
Linked server objects
Login objects
Master keys
Route objects
Server audit specification objects
Server role membership objects
Server role objects
Server DDL trigger objects
Construct a new instance of the class.
String describing the operation, suitable for display to user.
Delegate to invoke when the operation is executed.
The first parameter of the delegate is an opaque object that represents the operation.
A concrete example of its usage is as the sender for events fired (indirectly) by this operation
in order to correlate these events to the operation.
The second parameter is a nullable that can be used
to signal that the operation should be cancelled.
Return string representation of this instalce.
String caption for this instance.
Get boolean that indicates whether any operation associated with this context reported a cancellation.
True if an operation reported being cancelled; otherwise false.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to Validating schema model for data package.
Looks up a localized string similar to Creating deployment plan.
Looks up a localized string similar to Deploying package to database.
Looks up a localized string similar to Disabling indexes.
Looks up a localized string similar to Enabling indexes.
Looks up a localized string similar to Executing deployment plan.
Looks up a localized string similar to Exporting data from database.
Looks up a localized string similar to Generating deployment report.
Looks up a localized string similar to Generating deployment script.
Looks up a localized string similar to Generating drift report.
Looks up a localized string similar to The dac history table will not be updated..
Looks up a localized string similar to Importing package schema and data into database.
Looks up a localized string similar to Packaging model.
Looks up a localized string similar to Processing table: {0}.
Looks up a localized string similar to Registering metadata for database.
Looks up a localized string similar to Removing references from users to logins.
Looks up a localized string similar to Reporting deployment plan.
Looks up a localized string similar to Resolving references in schema model.
Looks up a localized string similar to Extracting schema from database.
Looks up a localized string similar to Translating package.
Looks up a localized string similar to Unregistering metadata for database.
Looks up a localized string similar to Validating schema model.
Looks up a localized string similar to Verifying deployment plan.
Customizes the description of an option.
Creates a description for an option.
The resource class to extract the resource string from.
The resource name to extract.
The description of the property.
This class supports the product infrastructure and is not intended to be used directly
from your code.
Defines an alias for the deployment property when used for commandline property overriding
Defines an alias for a property.
Returns the alias
Customizes the display name of an option.
Creates a display name for an option.
The resource class to extract the resource string from.
The resource name to extract.
The display name for the property.
Encapsulates the sourcing of package content,
and exposes methods to instantiate various types of objects used to read the package content.
Opens a readonly for the source
Opens a for the source, with the
package set to an updateable state
Return a stream that can be used to read the package content.
This stream must be disposed when it is no longer needed.
used to read package content.
This method is a workaround for creating instances from streams.
It should not be used to create objects that are returned from other methods in this interface.
Reports all DataSchemaErrors added to an ErrorManager through the supplied MessageHandler.
Decorator for that avoids disposal of the underlying stream.
Public class to support SQL Authentication configuration for DacFx
Checks whether "Authentication" is supported in the runtime environment
The keyword "Authentication" is not supported until .Net4.6. If user uses a version of .Net less than 4.6, DacFx should avoid using "Authentication"
true if "Authentication" is present in current .Net version
Set Authentication value from source builder to the target builder
the source connection string builder
the target connection string builder
Set Authentication using reflection
Get Authentication as string from connectionStringBuilder
Determines whether a connection string builder has a value specified for the Authentication property.
A connection string builder that might have authentication specified.
True if the authentication property is supported by the connection string builder and the authentication property is specified. False otherwise.
Sets AlwaysEncrypted setting in connection string if it is available in the .NET framework and returns the updated connection string
No-op if there is not .NET 4.6
A connection string builder that might have always encrypted setting specified.
True, to enable always encrypted setting, else False
connection string with Column Encryption Setting set to Enabled or Disabled based on enableAlwaysEncrypted
Sets public key string for friend assemblies.
No signing
--