17.2. Installing Postgres Pro Enterprise on Windows

Postgres Pro offers the following installation modes for the supported Windows systems:

Additionally, you have to set up the environment for using PL/Perl and PL/Python, if these procedural languages are required for your purposes. For details, see Section 17.2.4.

To avoid confusion, note that there are the following different users on Windows systems:

  • Postgres Pro installation is performed on behalf of an operating system user. All the database files belong to this user.

  • You must connect to the database cluster on behalf of the user created at installation time to be able to work with the database. This is not an operating system user.

  • By default, Postgres Pro service is started on behalf of NT AUTHORITY\NetworkService, which is a special Windows Service Account. You can specify another Windows user for starting Postgres Pro service in the corresponding text box of the installer, if required. The provided user must have the right to start Windows services.

The minimum hardware required to install Postgres Pro, create a database cluster and start the database server are as follows:

  • 1-GHz processor

  • 1 GB of RAM

  • 1 GB of disk space

Additional disk space is required for data or supporting components.

17.2.1. Supported Windows Versions

Postgres Pro is available for the following 64-bit Windows versions:

  • Windows 10 or higher

  • Windows Server 2012 R2 or higher

17.2.2. GUI Installation

Postgres Pro provides an installer with an interactive wizard that configures and installs Postgres Pro core components, creates the default database, and enables server autostart. The following components have their own installers that should be run separately once the core components are installed:

  • pg_probackup

To install Postgres Pro core components, run the provided installer as administrator and follow the on-screen instructions. Make sure to take into account the following installation specifics:

  • You can install all the Postgres Pro core components, or customize the installation by excluding server or developer components. Client utilities are always installed.

  • The selected data directory must be empty. Otherwise, Postgres Pro cannot create the default database. The default data directory is C:\Program Files\PostgresProEnterprise\14\data.

  • If the Allow external connections check box is selected (default), the installer modifies postgresql.conf and pg_hba.conf files to allow external connections. Otherwise, Postgres Pro server is listening for connections from the localhost only. If you decide to enable external connections when the installation is complete, you have to modify the Windows Firewall configuration to allow Postgres Pro server to accept connections.

  • Make sure to remember the username and password you set up when installing Postgres Pro as it will be required to connect to the Postgres Pro server when using password-based authentication methods.

  • By default, Postgres Pro uses icu collations. If you are upgrading an installation with the default collation provided by libc, such as PostgreSQL, make sure to choose libc collation provider in the corresponding drop-down list of the installer.

  • Postgres Pro provides a pre-configured psql that you can launch from the Start menu, so you do not have to configure the standard environment variables. However, if you would like to work with Postgres Pro from the standard command prompt without specifying full paths to the binary files, select the Set up environment variables check box.

Once the installation completes, your Postgres Pro instance is ready to use, with server autostart enabled. If you need more than one Postgres Pro instance on the same system, you have to configure them manually. For details, see Section 17.2.5.

17.2.3. Command-Line Installation

To install Postgres Pro from the command line, run the downloaded installer file passing one or more options described in Section 17.2.3.1.

17.2.3.1. Command-Line Options

Installation directory path:

/D=path

Silent install:

/S

INI file that provides the options to customize the server installation:

/init=ini_file_name

If you would like to customize the installation, you must create the INI file manually, as described in Section 17.2.3.2.

17.2.3.2. INI File Format

You can add the following installation options to the [options] section of the INI file:

  • InstallDir — path where to install server. If you specified the /D option on the command line, it will be overwritten by the InstallDir value.

  • DataDir — path where to create default database

  • Port — TCP/IP port to listen. Default: 5432.

  • SuperUser — name of the database user who will have admin rights in the database

  • Password — password of the user

  • noExtConnections = 1 — do not allow external connections

  • Coding = UNICODE — character encoding to use in the database

  • Locale — locale to use in the database. There can be several different locales for each encoding

  • vcredist = no — do not install Visual C redistributable libraries (use it only if these libraries are already installed on your system)

  • envvar = 1 — set up environment variables helpful for Postgres Pro: PGDATA, PGDATABASE, PGUSER, PGPORT, PGLOCALEDIR

  • needoptimization = 0 — disable automatic tuning of configuration parameters based on the available system resources.

  • datachecksums = 0 — disable data checksums for the cluster.

  • serviceaccount — specify a Windows user for starting Postgres Pro service. The provided user must have the right to start Windows services. By default, Postgres Pro service is started on behalf of NT AUTHORITY\NetworkService, which is a special Windows Service Account.

  • servicepassword — provide the password for the Windows user specified in the serviceaccount option.

  • serviceid — change Postgres Pro service name.

  • islibc = 1 — use libc as the provider of the default collation.

17.2.4. Loading Procedural Languages

Postgres Pro distribution for Windows systems includes PL/Perl and PL/Python procedural languages.

17.2.4.1. Setting up the Environment for PL/Python

To configure the system for using PL/Python, complete the following steps:

  1. Download and install the latest available version of Python 3.8 or 2.7 for Windows. Choose the 64-bit version as Postgres Pro server has 64-bit architecture type. You can find the installers at https://www.python.org/.

  2. Create the PL/Python extension by running the following command in psql:

    CREATE EXTENSION plpythonu
    

Tip

In some cases, when you create a PL/Python function, the connection to the server is lost and the server log shows the following error message:

ImportError: module site not found

To avoid this issue, try to specify the Python installation directory in the PYTHONHOME environment variable and restart the Postgres Pro service.

17.2.4.2. Setting up the Environment for PL/Perl

To configure the system for using PL/Perl, complete the following steps:

  1. Download the MSI package of the 64-bit Strawberry Perl 5.26 from https://strawberryperl.com/releases.html and perform the installation.

  2. Restart the Postgres Pro server.

  3. Create the PL/Perl extension by running the following command in psql:

    CREATE EXTENSION plperlu
    

17.2.5. Configuring Multiple Postgres Pro Instances

To set up several Postgres Pro server instances with different data directories on Windows, do the following:

  1. Install Postgres Pro as explained in Section 17.2.2 or Section 17.2.3. The installed binary files are shared by all Postgres Pro instances, so you need to complete this step only once.

  2. Select an empty folder that your new Postgres Pro instance will use as the data directory. For example, C:\Program Files\PostgresProEnterprise\14\data2. Make sure to grant Full Control permissions for this folder to the current OS user that will own the database files and the user on behalf of which the server is running (NT AUTHORITY\NetworkService by default).

  3. Run initdb specifying the path to the new data directory and any other parameters required to initialize another server instance. For example:

    "C:\Program Files\PostgresProEnterprise\14\bin\initdb.exe" --encoding=UTF8 -U "postgres" -D "C:\Program Files\PostgresProEnterprise\14\data2"
    

    Alternatively, you can stop the running server and copy the contents of the existing data directory into the newly created folder. In this case, the new Postgres Pro instance inherits all the settings of the original instance, including authentication settings.

  4. Modify postgresql.conf settings for the new Postgres Pro instance as required. Make sure to specify different ports for your server instances to avoid conflicts.

  5. Open the command prompt as Administrator and register a new Postgres Pro service with a unique name, for example, postgrespro-data2:

    "C:\Program Files\PostgresProEnterprise\14\bin\pg_ctl.exe" register -N "postgrespro-data2" -U "NT AUTHORITY\NetworkService" -D "C:\Program Files\PostgresProEnterprise\14\data2" -w
    

    Start the registered service:

    sc start "postgrespro-data2"
    

Once the service is started, your Postgres Pro instance is ready to use. If you need any additional Postgres Pro extensions, make sure to enable them for the new instance as explained in Section 17.3.

17.2.6. Uninstalling Postgres Pro Enterprise

The procedure of uninstalling Postgres Pro Enterprise depends on the number of Postgres Pro instances set up on your system.

If you have a single Postgres Pro instance created at installation time, you only need to run the C:\Program Files\PostgresProEnterprise\14\uninstall.exe program. This program automatically stops the server and unregisters the service for this instance.

If you have created any additional Postgres Pro instances, you have to complete the following steps:

  1. Stop the server for each instance:

    "C:\Program Files\PostgresProEnterprise\14\bin\pg_ctl.exe" stop -D "C:\Program Files\PostgresProEnterprise\14\data_dir" -m fast -w
    

  2. Unregister the service for each instance:

    "C:\Program Files\PostgresProEnterprise\14\bin\pg_ctl.exe" unregister -N "postgrespro_service_name"
    

  3. Run the C:\Program Files\PostgresProEnterprise\14\uninstall.exe to uninstall Postgres Pro binary files.

17.2.7. Antivirus Considerations

It is strongly recommended to avoid using antivirus software on systems where Postgres Pro is running because it may cause additional load on your environment and result in unexpected database behavior that would lead to performance and reliability issues. If you need to use antivirus software, make sure to exclude the following directories from virus scanning as they do not contain any executable files:

  • PGDATA directory that stores main cluster data, usually located in C:\Program Files\PostgresProEnterprise\14\data unless you specified another directory in initdb options

  • Paths to created tablespaces