Installation command line options v16

When invoking the EDB Postgres Advanced Server installer, you can optionally include the following parameters for an EDB Postgres Advanced Server installation on the command line or in a configuration file.

--create_samples { yes | no }

Specifies whether to create the sample tables and procedures for the database dialect specified with the --databasemode parameter. The default is yes.

--databasemode { oracle | postgresql }

Specifies a database dialect. The default is oracle.

--datadir data_directory

Specifies a location for the cluster's data directory. data_directory is the name of the directory. Include the complete path to the desired directory.

--debuglevel { 0 | 1 | 2 | 3 | 4 }

Sets the level of detail written to the debug_log file (see --debugtrace). Higher values produce more detail in a longer trace file. The default is 2.

--debugtrace debug_log

Helps with troubleshooting installation problems. debug_log is the name of the file that contains troubleshooting details.

--disable-components component_list

Specifies a list of EDB Postgres Advanced Server components to exclude from the installation. By default, component_list contains '' (the empty string). component_list is a comma-separated list containing one or more of the following components:

  • dbserver EDB Postgres Advanced Server.

  • pgadmin4 The EDB Postgres pgAdmin 4 provides a powerful graphical interface for database management and monitoring.

--enable_acledit { 1 | 0 }

The --enable_acledit 1 option grants permission to the user specified by the --serviceaccount option to access the EDB Postgres Advanced Server binaries and data directory. By default, this option is disabled if --enable_acledit 0 is specified or if the --enable_acledit option is completely omitted.

Note

Specifying this option is valid only when installing on Windows. Specify the --enable_acledit 1 option when a discretionary access control list (DACL) needs to be set for allowing access to objects on which to install EDB Postgres Advanced Server. For information on a DACL, see DACLs and ACEs in the Microsoft documentation.

To perform future operations, such as upgrading EDB Postgres Advanced Server, the service account user specified by the --serviceaccount option must have access to the data directory. The --enable_acledit 1 option provides access to the data directory by the service account user.

--enable-components component_list

Although this option is listed when you run the installer with the --help option, the --enable-components parameter has no effect on the components installed. All components are installed regardless of this setting. To install only specific selected components, use the --disable-components parameter to list the components you don't want to install.

--extract-only { yes | no }

Include the --extract-only parameter to extract the EDB Postgres Advanced Server binaries without performing a complete installation. Superuser privileges aren't required for the --extract-only option. The default value is no.

--help

Displays a list of the optional parameters.

--installer-language { en | ja | zh_CN | zh_TW | ko }

Specifies an installation language for EDB Postgres Advanced Server.

  • en specifies English. This is the default.

  • ja specifies Japanese

  • zh_CN specifies Chinese Simplified.

  • zh_TW specifies Traditional Chinese.

  • ko specifies Korean.

--install_runtimes { yes | no }

Specifies whether to install the Microsoft Visual C++ runtime libraries. The default is yes.

--locale locale

Specifies the locale for the EDB Postgres Advanced Server cluster. By default, the installer uses the locale detected by initdb.

--mode { unattended }

Specifies to perform an installation that requires no user input during the installation process.

--optionfile config_file

Specifies the name of a file that contains the installation configuration parameters. config_file must specify the complete path to the configuration parameter file.

--prefix installation_dir/as16

Specifies an installation directory for EDB Postgres Advanced Server. The installer appends a version-specific subdirectory (that is, as16) to the specified directory. The default installation directory is:

C:\Program Files\edb\as16

--serverport port_number

Specifies a listener port number for EDB Postgres Advanced Server.

If you're installing EDB Postgres Advanced Server in unattended mode and don't specify a value using the --serverport parameter, the installer uses port 5444 or the first available port after port 5444 as the default listener port.

--server_utilization {33 | 66 | 100}

Specifies a value for the edb_dynatune configuration parameter. The edb_dynatune configuration parameter determines how EDB Postgres Advanced Server allocates system resources.

  • A value of 33 is appropriate for a system used for development. A low value dedicates the least amount of the host machine’s resources to the database server.
  • A value of 66 is appropriate for an application server with a fixed number of applications. A midrange value dedicates a moderate amount of system resources to the database server. This is the default value.
  • A value of 100 is appropriate for a host machine that's dedicated to running EDB Postgres Advanced Server. A high value dedicates most of the system resources to the database server.

When the installation is complete, you can adjust the value of edb_dynatune by editing the postgresql.conf file, located in the data directory of your EDB Postgres Advanced Server installation. After editing the postgresql.conf file, you must restart the server for the changes to take effect.

--serviceaccount user_account_name

Specifies the name of the user account that owns the server process.

  • If --databasemode is set to oracle (the default), the default value of --serviceaccount is enterprisedb.
  • If --databasemode is postgresql, the default value of --serviceaccount is postgres.

For security reasons, the --serviceaccount parameter must specify the name of an account that doesn't hold administrator privileges.

If you specify both the --serviceaccount option and the --enable_acledit 1 option when invoking the installer, the database service and pgAgent uses the same service account. They therefore have the permissions required to access the EDB Postgres Advanced Server binaries and data directory.

Note

If you don't include the --serviceaccount option when invoking the installer, the NetworkService account owns the database service, and the pgAgent service is owned by either enterprisedb or postgres, depending on the installation mode.

--servicename service_name

Specifies the name of the EDB Postgres Advanced Server service. The default is edb-as-16.

--servicepassword user_password

Specifies the OS system password. If unspecified, the value of --servicepassword defaults to the value of --superpassword.

--superaccount super_user_name

Specifies the user name of the database superuser.

  • If --databasemode is set to oracle (the default), the default value of --superaccount is enterprisedb.
  • If --databasemode is set to postgresql, the default value of --superaccount is postgres.

--superpassword superuser_password

Specifies the database superuser password. If you're installing in non-interactive mode, --superpassword defaults to enterprisedb.

--unattendedmodeui { none | minimal | minimalWithDialogs }

Specifies installer behavior during an unattended installation.

Include --unattendedmodeui none if you don't want to display progress bars during the EDB Postgres Advanced Server installation.

Include --unattendedmodeui minimal to display progress bars during the installation process. This is the default behavior.

Include --unattendedmodeui minimalWithDialogs to display progress bars and report any errors encountered during the installation process in additional dialog boxes.

--version

Retrieves version information about the installer.

--workload_profile {oltp | mixed | reporting}

Specifies an initial value for the edb_dynatune_profile configuration parameter. edb_dynatune_profile controls aspects of performance-tuning based on the type of work that the server performs.

  • Specify oltp if the EDB Postgres Advanced Server installation is used to support heavy online transaction processing workloads. This is the default value.
  • Specify mixed if EDB Postgres Advanced Server provides a mix of transaction processing and data reporting.
  • Specify reporting if EDB Postgres Advanced Server is used for heavy data reporting.

After the installation is complete, you can adjust the value of edb_dynatune_profile by editing the postgresql.conf file, located in the data directory of your EDB Postgres Advanced Server installation. After editing the postgresql.conf file, you must restart the server for the changes to take effect.

For more information about edb_dynatune and other performance-related topics, see Managing performance.