xDatabase
xDatabase copied to clipboard
xDatabase
The xDatabase module contains the xDatabase, xDatabaseLogin, xDatabaseServer, and xDBPackage resources.
Code of Conduct
This project has adopted this Code of Conduct.
Releases
For each merge to the branch master
a preview release will be
deployed to PowerShell Gallery.
Periodically a release version tag will be pushed which will deploy a
full release to PowerShell Gallery.
Contributing
Please check out common DSC Community contributing guidelines.
Change log
A full list of changes in each version can be found in the change log.
Documentation
Please se the section Resources.
Examples
You can review the Examples directory in the repository for some general use scenarios for all of the resources that are in the module.
Resources
For information on Data-Tier Applications please refer to Understanding Data-tier Applications.
- xDatabase handles creation/deletion of a database using a dacpac or SQL connection string.
- xDatabaseLogin not yet written..
- xDatabaseServer not yet written..
- xDBPackage allows extraction of a dacpac or import of a bacpac from a database.
xDatabase
- Credentials: The credential to connect to the SQL server.
- SqlServer: The SQL server.
- SqlServerVersion: The version of the SQL Server. This property can take the following values: { 2008-R2 | 2012 | 2014 | 2016 | 2017 | 2019 }
- BacPacPath: The path to the .bacpac file to be used for database restore If this is used, the DacPacPath (see below) cannot be specified.
- DacPacPath: The path to the .dacpac file to be used for database schema deploy. If this is used, the BacPacPath (see above) cannot be specified.
- DacPacApplicationName: For deploying a database using .dacpac file, an application name with which the dacpac is registered. This is needed to support database upgrade using .dacpac files. This must specified if DacPacPath is provided.
- DacPacApplicationVersion: This is an optional parameter needed for registration for database deployment using .dacpac files for dacpac registration.
- DatabaseName: The name of the database to be deployed.
xDatabaseLogin
Not yet written.
xDatabaseServer
Not yet written.
xDBPackage
- DatabaseName: The name of the database to be deployed.
- SqlServer: The SQL server.
- SqlServerVersion: The version of the SQL Server. This property can take the following values: { 2008-R2 | 2012 | 2014 | 2016 | 2017 | 2019 }
- Path: The path to the .bacpac or .dacpac file to be used to export a database to a bacpac or extract a db to a dacpac respectively.
- Type: This property can take the following values for dacpac extraction and bacpac export: { DACPAC | BACPAC }