DSC module to install and configure PostgreSQL on Windows
Note This module is being actively developed and is not ready for production use.
This project has adopted this Code of Conduct.
- PostgreSqlInstall: Installs Postgres using the installer from EDB.
- PostgreSqlScript: Allows scripts to be executed against PostgreSql databases using psql.exe.
| Parameter | Attribute | DataType | Description | Default |
|---|---|---|---|---|
| Ensure | Key | String | "Absent" or "Present" only valid values | |
| Version | Required | String | "9", "10", "11", "12", or "13" only valid values | |
| InstallerPath | Required | String | File path to the exe installer from EDB | |
| ServiceName | Write | String | Specifies the name of the Postgres service. | |
| InstallDirectory | Write | String | Specifies the path for the install. | Postgres Default |
| ServerPort | Write | UInt16 | Specifies the port of the service. | PostgreSql Default |
| DataDirectory | Write | String | Specifies the data directory inside the prefix. | Postgres Default |
| ServiceAccount | Write | PSCredential | Specifies the account used to run the service. If builtin account is used password for credential does not matter. | Postgres Default |
| SuperAccount | Write | PSCredential | Specifies the account used as Super Admin for the Postgres Install | postgres / default |
| Features | Write | String[] | Specifies the components to be installed. | Postgres Default |
| OptionFile | Write | String | Specifies the path of an option file for the installer. See Postgres Installer help for details |
| Parameter | Attribute | DataType | Description | Default |
|---|---|---|---|---|
| DatabaseName | Key | String | Specifies the name of the PostgreSQL database. | |
| SetFilePath | Key | String | Path to the T-SQL file that will perform Set action. This script should perform whatever action desired against the target database. | |
| GetFilePath | Key | String | Path to the T-SQL file that will perform Get action. This script should provide general output of the current state of the database in relation to the Set script. Any result from executing the get script (including errors) will be returned. | |
| SetFilePath | Key | String | Path to the T-SQL file that will perform Test action. This script should test the database to ensure correct configuration, and should throw an exception when found to not be in the correct state. Any script that does not throw an error is evaluated to $true. | |
| Credential | Write | PsCredential | The credentials to authenticate with, using Postgres Authentication. | |
| PsqlLocation | Write | String | Location of the psql executable. | 'C:\Program Files\PostgreSQL\12\bin\psql.exe' Default |
| CreateDatabase | Write | Boolean | Optionally creates a database if the database specified with DatabaseName doesn't exist. | $true Default |